Skip to content

Commit

Permalink
Docs update
Browse files Browse the repository at this point in the history
  • Loading branch information
ivopetkov committed Jan 4, 2021
1 parent e14df5e commit 444a482
Show file tree
Hide file tree
Showing 9 changed files with 69 additions and 15 deletions.
12 changes: 6 additions & 6 deletions docs/markdown/ivopetkov.html5domdocument.class.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,14 +15,14 @@ IvoPetkov\HTML5DOMDocument extends DOMDocument {

/* Methods */
public __construct ( [ string $version [, string $encoding ]] )
public DOMElement createInsertTarget ( string $name )
public HTML5DOMElement createInsertTarget ( string $name )
public void insertHTML ( string $source [, string $target = 'beforeBodyEnd' ] )
public void insertHTMLMulti ( array $sources )
public bool loadHTML ( string $source [, int $options = 0 ] )
public void loadHTMLFile ( string $filename [, int $options = 0 ] )
public void modify ( [ int $modifications = 0 ] )
public DOMElement|null querySelector ( string $selector )
public DOMNodeList querySelectorAll ( string $selector )
public HTML5DOMElement|null querySelector ( string $selector )
public HTML5DOMNodeList querySelectorAll ( string $selector )
public string saveHTML ( [ DOMNode $node ] )
public int saveHTMLFile ( string $filename )

Expand Down Expand Up @@ -65,7 +65,7 @@ IvoPetkov\HTML5DOMDocument extends DOMDocument {

      Creates a new HTML5DOMDocument object.

##### public [DOMElement](http://php.net/manual/en/class.domelement.php) [createInsertTarget](ivopetkov.html5domdocument.createinserttarget.method.md) ( string $name )
##### public HTML5DOMElement [createInsertTarget](ivopetkov.html5domdocument.createinserttarget.method.md) ( string $name )

      Creates an element that will be replaced by the new body in insertHTML.

Expand All @@ -89,11 +89,11 @@ IvoPetkov\HTML5DOMDocument extends DOMDocument {

      Applies the modifications specified to the DOM document.

##### public [DOMElement](http://php.net/manual/en/class.domelement.php)|null [querySelector](ivopetkov.html5domdocument.queryselector.method.md) ( string $selector )
##### public HTML5DOMElement|null [querySelector](ivopetkov.html5domdocument.queryselector.method.md) ( string $selector )

      Returns the first document element matching the selector.

##### public [DOMNodeList](http://php.net/manual/en/class.domnodelist.php) [querySelectorAll](ivopetkov.html5domdocument.queryselectorall.method.md) ( string $selector )
##### public HTML5DOMNodeList [querySelectorAll](ivopetkov.html5domdocument.queryselectorall.method.md) ( string $selector )

      Returns a list of document elements matching the selector.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Creates an element that will be replaced by the new body in insertHTML.

```php
public DOMElement createInsertTarget ( string $name )
public HTML5DOMElement createInsertTarget ( string $name )
```

## Parameters
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Returns the first document element matching the selector.

```php
public DOMElement|null querySelector ( string $selector )
public HTML5DOMElement|null querySelector ( string $selector )
```

## Parameters
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Returns a list of document elements matching the selector.

```php
public DOMNodeList querySelectorAll ( string $selector )
public HTML5DOMNodeList querySelectorAll ( string $selector )
```

## Parameters
Expand Down
18 changes: 14 additions & 4 deletions docs/markdown/ivopetkov.html5domelement.class.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,10 @@ IvoPetkov\HTML5DOMElement extends DOMElement {
/* Methods */
public string getAttribute ( string $name )
public array getAttributes ( void )
public DOMElement|null querySelector ( string $selector )
public DOMNodeList querySelectorAll ( string $selector )
public string getNodeValue ( void )
public string getTextContent ( void )
public HTML5DOMElement|null querySelector ( string $selector )
public HTML5DOMNodeList querySelectorAll ( string $selector )

}
```
Expand Down Expand Up @@ -47,11 +49,19 @@ IvoPetkov\HTML5DOMElement extends DOMElement {

      Returns an array containing all attributes.

##### public [DOMElement](http://php.net/manual/en/class.domelement.php)|null [querySelector](ivopetkov.html5domelement.queryselector.method.md) ( string $selector )
##### public string [getNodeValue](ivopetkov.html5domelement.getnodevalue.method.md) ( void )

      Returns the updated nodeValue Property

##### public string [getTextContent](ivopetkov.html5domelement.gettextcontent.method.md) ( void )

      Returns the updated $textContent Property

##### public HTML5DOMElement|null [querySelector](ivopetkov.html5domelement.queryselector.method.md) ( string $selector )

      Returns the first child element matching the selector.

##### public [DOMNodeList](http://php.net/manual/en/class.domnodelist.php) [querySelectorAll](ivopetkov.html5domelement.queryselectorall.method.md) ( string $selector )
##### public HTML5DOMNodeList [querySelectorAll](ivopetkov.html5domelement.queryselectorall.method.md) ( string $selector )

      Returns a list of children elements matching the selector.

Expand Down
22 changes: 22 additions & 0 deletions docs/markdown/ivopetkov.html5domelement.getnodevalue.method.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# IvoPetkov\HTML5DOMElement::getNodeValue

Returns the updated nodeValue Property

```php
public string getNodeValue ( void )
```

## Returns

      The updated $nodeValue

## Details

Class: [IvoPetkov\HTML5DOMElement](ivopetkov.html5domelement.class.md)

Location: ~/src/HTML5DOMElement.php

---

[back to index](index.md)

22 changes: 22 additions & 0 deletions docs/markdown/ivopetkov.html5domelement.gettextcontent.method.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# IvoPetkov\HTML5DOMElement::getTextContent

Returns the updated $textContent Property

```php
public string getTextContent ( void )
```

## Returns

      The updated $textContent

## Details

Class: [IvoPetkov\HTML5DOMElement](ivopetkov.html5domelement.class.md)

Location: ~/src/HTML5DOMElement.php

---

[back to index](index.md)

Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Returns the first child element matching the selector.

```php
public DOMElement|null querySelector ( string $selector )
public HTML5DOMElement|null querySelector ( string $selector )
```

## Parameters
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Returns a list of children elements matching the selector.

```php
public DOMNodeList querySelectorAll ( string $selector )
public HTML5DOMNodeList querySelectorAll ( string $selector )
```

## Parameters
Expand Down

0 comments on commit 444a482

Please # to comment.