Skip to content

Commit 3eccd3c

Browse files
ivopetkovivopetkov
committed
Update docs.
1 parent cbbe2d5 commit 3eccd3c

8 files changed

+256
-118
lines changed

‎docs/markdown/ivopetkov.html5domdocument.__construct.method.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
Creates a new HTML5DOMDocument object.
44

55
```php
6-
public __construct ( [ string $version [, string $encoding ]] )
6+
public __construct ( [ string $version = '1.0' [, string $encoding = '' ]] )
77
```
88

99
## Parameters

‎docs/markdown/ivopetkov.html5domdocument.class.md‎

Lines changed: 137 additions & 54 deletions
Large diffs are not rendered by default.

‎docs/markdown/ivopetkov.html5domdocument.loadhtmlfile.method.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
Load HTML from a file.
44

55
```php
6-
public void loadHTMLFile ( string $filename [, int $options = 0 ] )
6+
public bool loadHTMLFile ( string $filename [, int $options = 0 ] )
77
```
88

99
## Parameters

‎docs/markdown/ivopetkov.html5domdocument.modify.method.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ public void modify ( [ int $modifications = 0 ] )
1616
- HTML5DOMDocument::FIX_MULTIPLE_HEADS - merges multiple head elements.
1717
- HTML5DOMDocument::FIX_MULTIPLE_BODIES - merges multiple body elements.
1818
- HTML5DOMDocument::OPTIMIZE_HEAD - moves charset metatag and title elements first.
19+
- HTML5DOMDocument::FIX_DUPLICATE_STYLES - removes all but first styles with duplicate content.
1920

2021
## Details
2122

‎docs/markdown/ivopetkov.html5domdocument.savehtmlfile.method.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
Dumps the internal document into a file using HTML formatting.
44

55
```php
6-
public int saveHTMLFile ( string $filename )
6+
public int|false saveHTMLFile ( string $filename )
77
```
88

99
## Parameters

‎docs/markdown/ivopetkov.html5domelement.class.md‎

Lines changed: 100 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
Represents a live (can be manipulated) representation of an element in a HTML5 document.
44

55
```php
6-
IvoPetkov\HTML5DOMElement extends DOMElement {
6+
IvoPetkov\HTML5DOMElement extends DOMElement implements DOMParentNode, DOMChildNode, Stringable {
77

88
/* Properties */
99
public IvoPetkov\HTML5DOMTokenList $classList
@@ -25,6 +25,14 @@ IvoPetkov\HTML5DOMElement extends DOMElement {
2525

2626
##### [DOMElement](http://php.net/manual/en/class.domelement.php)
2727

28+
## Implements
29+
30+
##### [DOMParentNode](http://php.net/manual/en/class.domparentnode.php)
31+
32+
##### [DOMChildNode](http://php.net/manual/en/class.domchildnode.php)
33+
34+
##### [Stringable](http://php.net/manual/en/class.stringable.php)
35+
2836
## Properties
2937

3038
##### public [IvoPetkov\HTML5DOMTokenList](ivopetkov.html5domtokenlist.class.md) $classList
@@ -39,6 +47,56 @@ IvoPetkov\HTML5DOMElement extends DOMElement {
3947

4048
      The HTML code for the element including the code inside.
4149

50+
### Inherited from [DOMElement](http://php.net/manual/en/class.domelement.php)
51+
52+
##### public $childElementCount
53+
54+
##### public $firstElementChild
55+
56+
##### public $lastElementChild
57+
58+
##### public $nextElementSibling
59+
60+
##### public $previousElementSibling
61+
62+
##### public $schemaTypeInfo
63+
64+
##### public $tagName
65+
66+
### Inherited from [DOMNode](http://php.net/manual/en/class.domnode.php)
67+
68+
##### public $attributes
69+
70+
##### public $baseURI
71+
72+
##### public $childNodes
73+
74+
##### public $firstChild
75+
76+
##### public $lastChild
77+
78+
##### public $localName
79+
80+
##### public $namespaceURI
81+
82+
##### public $nextSibling
83+
84+
##### public $nodeName
85+
86+
##### public $nodeType
87+
88+
##### public $nodeValue
89+
90+
##### public $ownerDocument
91+
92+
##### public $parentNode
93+
94+
##### public $prefix
95+
96+
##### public $previousSibling
97+
98+
##### public $textContent
99+
42100
## Methods
43101

44102
##### public string [getAttribute](ivopetkov.html5domelement.getattribute.method.md) ( string $name )
@@ -67,87 +125,89 @@ IvoPetkov\HTML5DOMElement extends DOMElement {
67125

68126
### Inherited from [DOMElement](http://php.net/manual/en/class.domelement.php)
69127

70-
##### public [__construct](http://php.net/manual/en/domelement.construct.php) ( $name [, $value [, $uri ]] )
128+
##### public [__construct](http://php.net/manual/en/domelement.construct.php) ( string $qualifiedName [, string|null $value [, string $namespace = '' ]] )
71129

72-
##### public void [getAttributeNS](http://php.net/manual/en/domelement.getattributens.php) ( $namespaceURI , $localName )
130+
##### public void [after](http://php.net/manual/en/domelement.after.php) ( [ $nodes ] )
73131

74-
##### public void [getAttributeNode](http://php.net/manual/en/domelement.getattributenode.php) ( $name )
132+
##### public void [append](http://php.net/manual/en/domelement.append.php) ( [ $nodes ] )
75133

76-
##### public void [getAttributeNodeNS](http://php.net/manual/en/domelement.getattributenodens.php) ( $namespaceURI , $localName )
134+
##### public void [before](http://php.net/manual/en/domelement.before.php) ( [ $nodes ] )
77135

78-
##### public void [getElementsByTagName](http://php.net/manual/en/domelement.getelementsbytagname.php) ( $name )
136+
##### public void [getAttributeNS](http://php.net/manual/en/domelement.getattributens.php) ( string|null $namespace , string $localName )
79137

80-
##### public void [getElementsByTagNameNS](http://php.net/manual/en/domelement.getelementsbytagnamens.php) ( $namespaceURI , $localName )
138+
##### public void [getAttributeNode](http://php.net/manual/en/domelement.getattributenode.php) ( string $qualifiedName )
81139

82-
##### public void [hasAttribute](http://php.net/manual/en/domelement.hasattribute.php) ( $name )
140+
##### public void [getAttributeNodeNS](http://php.net/manual/en/domelement.getattributenodens.php) ( string|null $namespace , string $localName )
83141

84-
##### public void [hasAttributeNS](http://php.net/manual/en/domelement.hasattributens.php) ( $namespaceURI , $localName )
142+
##### public void [getElementsByTagName](http://php.net/manual/en/domelement.getelementsbytagname.php) ( string $qualifiedName )
85143

86-
##### public void [removeAttribute](http://php.net/manual/en/domelement.removeattribute.php) ( $name )
144+
##### public void [getElementsByTagNameNS](http://php.net/manual/en/domelement.getelementsbytagnamens.php) ( string|null $namespace , string $localName )
87145

88-
##### public void [removeAttributeNS](http://php.net/manual/en/domelement.removeattributens.php) ( $namespaceURI , $localName )
146+
##### public void [hasAttribute](http://php.net/manual/en/domelement.hasattribute.php) ( string $qualifiedName )
89147

90-
##### public void [removeAttributeNode](http://php.net/manual/en/domelement.removeattributenode.php) ( [DOMAttr](http://php.net/manual/en/class.domattr.php) $oldAttr )
148+
##### public void [hasAttributeNS](http://php.net/manual/en/domelement.hasattributens.php) ( string|null $namespace , string $localName )
91149

92-
##### public void [setAttribute](http://php.net/manual/en/domelement.setattribute.php) ( $name , $value )
150+
##### public void [prepend](http://php.net/manual/en/domelement.prepend.php) ( [ $nodes ] )
93151

94-
##### public void [setAttributeNS](http://php.net/manual/en/domelement.setattributens.php) ( $namespaceURI , $qualifiedName , $value )
152+
##### public void [remove](http://php.net/manual/en/domelement.remove.php) ( void )
95153

96-
##### public void [setAttributeNode](http://php.net/manual/en/domelement.setattributenode.php) ( [DOMAttr](http://php.net/manual/en/class.domattr.php) $newAttr )
154+
##### public void [removeAttribute](http://php.net/manual/en/domelement.removeattribute.php) ( string $qualifiedName )
97155

98-
##### public void [setAttributeNodeNS](http://php.net/manual/en/domelement.setattributenodens.php) ( [DOMAttr](http://php.net/manual/en/class.domattr.php) $newAttr )
156+
##### public void [removeAttributeNS](http://php.net/manual/en/domelement.removeattributens.php) ( string|null $namespace , string $localName )
99157

100-
##### public void [setIdAttribute](http://php.net/manual/en/domelement.setidattribute.php) ( $name , $isId )
158+
##### public void [removeAttributeNode](http://php.net/manual/en/domelement.removeattributenode.php) ( [DOMAttr](http://php.net/manual/en/class.domattr.php) $attr )
101159

102-
##### public void [setIdAttributeNS](http://php.net/manual/en/domelement.setidattributens.php) ( $namespaceURI , $localName , $isId )
160+
##### public void [replaceWith](http://php.net/manual/en/domelement.replacewith.php) ( [ $nodes ] )
103161

104-
##### public void [setIdAttributeNode](http://php.net/manual/en/domelement.setidattributenode.php) ( [DOMAttr](http://php.net/manual/en/class.domattr.php) $attr , $isId )
162+
##### public void [setAttribute](http://php.net/manual/en/domelement.setattribute.php) ( string $qualifiedName , string $value )
105163

106-
### Inherited from [DOMNode](http://php.net/manual/en/class.domnode.php)
164+
##### public void [setAttributeNS](http://php.net/manual/en/domelement.setattributens.php) ( string|null $namespace , string $qualifiedName , string $value )
165+
166+
##### public void [setAttributeNode](http://php.net/manual/en/domelement.setattributenode.php) ( [DOMAttr](http://php.net/manual/en/class.domattr.php) $attr )
167+
168+
##### public void [setAttributeNodeNS](http://php.net/manual/en/domelement.setattributenodens.php) ( [DOMAttr](http://php.net/manual/en/class.domattr.php) $attr )
169+
170+
##### public void [setIdAttribute](http://php.net/manual/en/domelement.setidattribute.php) ( string $qualifiedName , bool $isId )
107171

108-
##### public void [C14N](http://php.net/manual/en/domnode.c14n.php) ( [ $exclusive [, $with_comments [, array $xpath [, array $ns_prefixes ]]]] )
172+
##### public void [setIdAttributeNS](http://php.net/manual/en/domelement.setidattributens.php) ( string $namespace , string $qualifiedName , bool $isId )
109173

110-
##### public void [C14NFile](http://php.net/manual/en/domnode.c14nfile.php) ( $uri [, $exclusive [, $with_comments [, array $xpath [, array $ns_prefixes ]]]] )
174+
##### public void [setIdAttributeNode](http://php.net/manual/en/domelement.setidattributenode.php) ( [DOMAttr](http://php.net/manual/en/class.domattr.php) $attr , bool $isId )
111175

112-
##### public void [appendChild](http://php.net/manual/en/domnode.appendchild.php) ( [DOMNode](http://php.net/manual/en/class.domnode.php) $newChild )
176+
### Inherited from [DOMNode](http://php.net/manual/en/class.domnode.php)
177+
178+
##### public void [C14N](http://php.net/manual/en/domnode.c14n.php) ( [ bool $exclusive = false [, bool $withComments = false [, array|null $xpath [, array|null $nsPrefixes ]]]] )
113179

114-
##### public void [cloneNode](http://php.net/manual/en/domnode.clonenode.php) ( $deep )
180+
##### public void [C14NFile](http://php.net/manual/en/domnode.c14nfile.php) ( string $uri [, bool $exclusive = false [, bool $withComments = false [, array|null $xpath [, array|null $nsPrefixes ]]]] )
115181

116-
##### public void [compareDocumentPosition](http://php.net/manual/en/domnode.comparedocumentposition.php) ( [DOMNode](http://php.net/manual/en/class.domnode.php) $other )
182+
##### public void [appendChild](http://php.net/manual/en/domnode.appendchild.php) ( [DOMNode](http://php.net/manual/en/class.domnode.php) $node )
117183

118-
##### public void [getFeature](http://php.net/manual/en/domnode.getfeature.php) ( $feature , $version )
184+
##### public void [cloneNode](http://php.net/manual/en/domnode.clonenode.php) ( [ bool $deep = false ] )
119185

120186
##### public void [getLineNo](http://php.net/manual/en/domnode.getlineno.php) ( void )
121187

122188
##### public void [getNodePath](http://php.net/manual/en/domnode.getnodepath.php) ( void )
123189

124-
##### public void [getUserData](http://php.net/manual/en/domnode.getuserdata.php) ( $key )
125-
126190
##### public void [hasAttributes](http://php.net/manual/en/domnode.hasattributes.php) ( void )
127191

128192
##### public void [hasChildNodes](http://php.net/manual/en/domnode.haschildnodes.php) ( void )
129193

130-
##### public void [insertBefore](http://php.net/manual/en/domnode.insertbefore.php) ( [DOMNode](http://php.net/manual/en/class.domnode.php) $newChild [, [DOMNode](http://php.net/manual/en/class.domnode.php) $refChild ] )
194+
##### public void [insertBefore](http://php.net/manual/en/domnode.insertbefore.php) ( [DOMNode](http://php.net/manual/en/class.domnode.php) $node [, [DOMNode](http://php.net/manual/en/class.domnode.php)|null $child ] )
131195

132-
##### public void [isDefaultNamespace](http://php.net/manual/en/domnode.isdefaultnamespace.php) ( $namespaceURI )
196+
##### public void [isDefaultNamespace](http://php.net/manual/en/domnode.isdefaultnamespace.php) ( string $namespace )
133197

134-
##### public void [isEqualNode](http://php.net/manual/en/domnode.isequalnode.php) ( [DOMNode](http://php.net/manual/en/class.domnode.php) $arg )
198+
##### public void [isSameNode](http://php.net/manual/en/domnode.issamenode.php) ( [DOMNode](http://php.net/manual/en/class.domnode.php) $otherNode )
135199

136-
##### public void [isSameNode](http://php.net/manual/en/domnode.issamenode.php) ( [DOMNode](http://php.net/manual/en/class.domnode.php) $other )
200+
##### public void [isSupported](http://php.net/manual/en/domnode.issupported.php) ( string $feature , string $version )
137201

138-
##### public void [isSupported](http://php.net/manual/en/domnode.issupported.php) ( $feature , $version )
202+
##### public void [lookupNamespaceURI](http://php.net/manual/en/domnode.lookupnamespaceuri.php) ( string|null $prefix )
139203

140-
##### public void [lookupNamespaceUri](http://php.net/manual/en/domnode.lookupnamespaceuri.php) ( $prefix )
141-
142-
##### public void [lookupPrefix](http://php.net/manual/en/domnode.lookupprefix.php) ( $namespaceURI )
204+
##### public void [lookupPrefix](http://php.net/manual/en/domnode.lookupprefix.php) ( string $namespace )
143205

144206
##### public void [normalize](http://php.net/manual/en/domnode.normalize.php) ( void )
145207

146-
##### public void [removeChild](http://php.net/manual/en/domnode.removechild.php) ( [DOMNode](http://php.net/manual/en/class.domnode.php) $oldChild )
147-
148-
##### public void [replaceChild](http://php.net/manual/en/domnode.replacechild.php) ( [DOMNode](http://php.net/manual/en/class.domnode.php) $newChild , [DOMNode](http://php.net/manual/en/class.domnode.php) $oldChild )
208+
##### public void [removeChild](http://php.net/manual/en/domnode.removechild.php) ( [DOMNode](http://php.net/manual/en/class.domnode.php) $child )
149209

150-
##### public void [setUserData](http://php.net/manual/en/domnode.setuserdata.php) ( $key , $data , $handler )
210+
##### public void [replaceChild](http://php.net/manual/en/domnode.replacechild.php) ( [DOMNode](http://php.net/manual/en/class.domnode.php) $node , [DOMNode](http://php.net/manual/en/class.domnode.php) $child )
151211

152212
## Details
153213

‎docs/markdown/ivopetkov.html5domnodelist.class.md‎

Lines changed: 10 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,6 @@ Represents a list of DOM nodes.
55
```php
66
IvoPetkov\HTML5DOMNodeList extends ArrayObject implements Countable, Serializable, ArrayAccess, Traversable, IteratorAggregate {
77

8-
/* Constants */
9-
const int ARRAY_AS_PROPS
10-
const int STD_PROP_LIST
11-
128
/* Properties */
139
public readonly int $length
1410

@@ -34,12 +30,6 @@ IvoPetkov\HTML5DOMNodeList extends ArrayObject implements Countable, Serializabl
3430

3531
##### [IteratorAggregate](http://php.net/manual/en/class.iteratoraggregate.php)
3632

37-
## Constants
38-
39-
##### const int ARRAY_AS_PROPS
40-
41-
##### const int STD_PROP_LIST
42-
4333
## Properties
4434

4535
##### public readonly int $length
@@ -54,15 +44,15 @@ IvoPetkov\HTML5DOMNodeList extends ArrayObject implements Countable, Serializabl
5444

5545
### Inherited from [ArrayObject](http://php.net/manual/en/class.arrayobject.php)
5646

57-
##### public [__construct](http://php.net/manual/en/arrayobject.construct.php) ( [ $array [, $ar_flags [, $iterator_class ]]] )
47+
##### public [__construct](http://php.net/manual/en/arrayobject.construct.php) ( [ object|array $array = [] [, int $flags = 0 [, string $iteratorClass = 'ArrayIterator' ]]] )
5848

59-
##### public void [append](http://php.net/manual/en/arrayobject.append.php) ( $value )
49+
##### public void [append](http://php.net/manual/en/arrayobject.append.php) ( mixed $value )
6050

61-
##### public void [asort](http://php.net/manual/en/arrayobject.asort.php) ( void )
51+
##### public void [asort](http://php.net/manual/en/arrayobject.asort.php) ( [ int $flags = 0 ] )
6252

6353
##### public void [count](http://php.net/manual/en/arrayobject.count.php) ( void )
6454

65-
##### public void [exchangeArray](http://php.net/manual/en/arrayobject.exchangearray.php) ( $array )
55+
##### public void [exchangeArray](http://php.net/manual/en/arrayobject.exchangearray.php) ( object|array $array )
6656

6757
##### public void [getArrayCopy](http://php.net/manual/en/arrayobject.getarraycopy.php) ( void )
6858

@@ -72,23 +62,23 @@ IvoPetkov\HTML5DOMNodeList extends ArrayObject implements Countable, Serializabl
7262

7363
##### public void [getIteratorClass](http://php.net/manual/en/arrayobject.getiteratorclass.php) ( void )
7464

75-
##### public void [ksort](http://php.net/manual/en/arrayobject.ksort.php) ( void )
65+
##### public void [ksort](http://php.net/manual/en/arrayobject.ksort.php) ( [ int $flags = 0 ] )
7666

7767
##### public void [natcasesort](http://php.net/manual/en/arrayobject.natcasesort.php) ( void )
7868

7969
##### public void [natsort](http://php.net/manual/en/arrayobject.natsort.php) ( void )
8070

8171
##### public void [serialize](http://php.net/manual/en/arrayobject.serialize.php) ( void )
8272

83-
##### public void [setFlags](http://php.net/manual/en/arrayobject.setflags.php) ( $flags )
73+
##### public void [setFlags](http://php.net/manual/en/arrayobject.setflags.php) ( int $flags )
8474

85-
##### public void [setIteratorClass](http://php.net/manual/en/arrayobject.setiteratorclass.php) ( $iteratorClass )
75+
##### public void [setIteratorClass](http://php.net/manual/en/arrayobject.setiteratorclass.php) ( string $iteratorClass )
8676

87-
##### public void [uasort](http://php.net/manual/en/arrayobject.uasort.php) ( $cmp_function )
77+
##### public void [uasort](http://php.net/manual/en/arrayobject.uasort.php) ( callable $callback )
8878

89-
##### public void [uksort](http://php.net/manual/en/arrayobject.uksort.php) ( $cmp_function )
79+
##### public void [uksort](http://php.net/manual/en/arrayobject.uksort.php) ( callable $callback )
9080

91-
##### public void [unserialize](http://php.net/manual/en/arrayobject.unserialize.php) ( $serialized )
81+
##### public void [unserialize](http://php.net/manual/en/arrayobject.unserialize.php) ( string $data )
9282

9383
## Details
9484

‎docs/markdown/ivopetkov.html5domtokenlist.class.md‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
Represents a set of space-separated tokens of an element attribute.
44

55
```php
6-
IvoPetkov\HTML5DOMTokenList {
6+
IvoPetkov\HTML5DOMTokenList implements Stringable {
77

88
/* Properties */
99
public readonly int $length
@@ -22,6 +22,10 @@ IvoPetkov\HTML5DOMTokenList {
2222
}
2323
```
2424

25+
## Implements
26+
27+
##### [Stringable](http://php.net/manual/en/class.stringable.php)
28+
2529
## Properties
2630

2731
##### public readonly int $length

0 commit comments

Comments
 (0)