A class to treat an HTML document as a PHP object
PHP version 5
__call(string $element, array $arguments) : \SimpleHTML
The magic method that is called when an element that doesn't have its own method is added. Creates and adds objects to the node tree based on supplied arguments.
| string | $element | Element name |
| array | $arguments | Element attributes |
Newly created node
__toString() : string
Converts the object into a valid XHTML 1.0 Strict document with indenting.
If user agent does not accept application/xhtml+xml, the XML prolog is removed. If an html fragment (i.e. <html> is not root), DOCTYPE and XML prolog are not added.
XHTML document
a(mixed $inner, string $href) : \SimpleHTML
Create an <a> element
If a single string argument is given, it is the href attribute instead. If an argument is an array, they are attributes.
| mixed | $inner | Link contents |
| string | $href | Destination |
Newly created <a> element
addChild(mixed $node, string $contents) : \SimpleHTML
Overloaded SimpleXMLElement function to allow adding an existing object
NOTE: A copy of $node is added, not the original
| mixed | $node | Node to be added |
| string | $contents | Value of node |
Newly created node
aimg(string $href, string $src, string $alt, string $title) : \SimpleHTML
Create an <img> inside an <a>
| string | $href | Link destination |
| string | $src | Image source |
| string | $alt | Alternate text |
| string | $title | Title text |
Newly created <a> element
appendText(string $text) : \SimpleHTML
Appends text to the contents of an element
| string | $text | Text to append |
Updated node
checkbox(string $name, string $value, string $id, boolean $checked, array $extra) : \SimpleHTML
Create a checkbox
| string | $name | Name value |
| string | $value | Default value |
| string | $id | Id value |
| boolean | $checked | Checked |
| array | $extra | Extra attributes |
Newly created <input> element
css(mixed $href, string $title) : \SimpleHTML
Create a <link> element for a CSS file
If the first argument is an array, a <link> is created for each one If not provided, the currently running script name is used
| mixed | $href | CSS file(s) to link |
| string | $title | Title of link |
Last created <link> element
file(string $name, string $value, string $id, array $extra) : \SimpleHTML
Create a file upload input
| string | $name | Name value |
| string | $value | Default value |
| string | $id | Id value |
| array | $extra | Extra attributes |
Newly created <input> element
form(string $method, string $action, array $extra) : \SimpleHTML
Create a <form> element
| string | $method | Form submission method |
| string | $action | Form submission destination |
| array | $extra | Extra attributes |
Newly created <>> element
hidden(string $name, string $value, string $id, array $extra) : \SimpleHTML
Create a hidden input
| string | $name | Name value |
| string | $value | Default value |
| string | $id | Id value |
| array | $extra | Extra attributes |
Newly created <input> element
img(string $src, string $alt, string $title) : \SimpleHTML
Create an <img> element
If the first argument is an array, they are attributes.
| string | $src | Image source |
| string | $alt | Alternate text |
| string | $title | Title text |
Newly created <img> element
input(string $name, string $value, string $id, string $type, array $extra) : \SimpleHTML
Create an <input> element
If the first argument is an array, they are attributes.
| string | $name | Name value |
| string | $value | Default value |
| string | $id | Id value |
| string | $type | Input type |
| array | $extra | Extra attributes |
Newly created <input> element
js(mixed $src) : \SimpleHTML
Create a <script> element for a Javascript file
If the first argument is an array, a <script> is created for each one If not provided, the currently running script name is used
| mixed | $src | Javascript file(s) to link |
Last created <script> element
label(string $contents, string $for) : \SimpleHTML
Create a <label> element
If an argument is an array, they are attributes.
| string | $contents | Label contents |
| string | $for | For value |
Newly created <label> element
password(string $name, string $value, string $id, array $extra) : \SimpleHTML
Create a password input
| string | $name | Name value |
| string | $value | Default value |
| string | $id | Id value |
| array | $extra | Extra attributes |
Newly created <input> element
radio(string $name, string $value, string $id, boolean $checked, array $extra) : \SimpleHTML
Create a radio input
| string | $name | Name value |
| string | $value | Default value |
| string | $id | Id value |
| boolean | $checked | Checked |
| array | $extra | Extra attributes |
Newly created <input> element
reset(string $name, string $value, string $id, array $extra) : \SimpleHTML
Create a reset input
| string | $name | Name value |
| string | $value | Default value |
| string | $id | Id value |
| array | $extra | Extra attributes |
Newly created <input> element
selectize(array $options, array $selected, array $name, string $id, array $extra) : \SimpleHTML
Turn an array into a <select> element
Each row of the array will correspond to an <option> element. If an array element is also an array, the first two elements are used as the contents and value. Otherwise it is used as the both.
| array | $options | Select options |
| array | $selected | Option to default as selected |
| array | $name | Name attribute |
| string | $id | Id attribute |
| array | $extra | Extra attributes |
Newly created <select> element
submit(string $name, string $value, string $id, array $extra) : \SimpleHTML
Create a submit input
| string | $name | Name value |
| string | $value | Default value |
| string | $id | Id value |
| array | $extra | Extra attributes |
Newly created <input> element
tableize(array $body, array $head, array $foot, string $caption) : \SimpleHTML
Turn an array into a <table> element
Each row of the array will correspond to a <tr> element. Each array element will correspond to a <td> element. If the array element is an array, the first two elements are used as the contents and attributes. Otherwise it is used as the contents
| array | $body | Table contents |
| array | $head | Header row |
| array | $foot | Footer data |
| string | $caption | Table caption |
Newly created <table> element
text(string $name, string $value, string $id, array $extra) : \SimpleHTML
Create a text input
| string | $name | Name value |
| string | $value | Default value |
| string | $id | Id value |
| array | $extra | Extra attributes |
Newly created <input> element
factory(string $element, mixed $a, mixed $b) : \SimpleHTML
This is the function that turns out the SimpleHTML object
The first attribute is used as the element. The second and third attributes are used as contents or attributes of the new element depending on type. As SimpleXML is UTF8 only, non UTF8 characters will be removed or replaced as best as possible.
| string | $element | Base node |
| mixed | $a | Contents |
| mixed | $b | Attributes |
Newly created node