Fixed bug in htmldoc::key() where the wrong return type was specified.

Fixed issues in documentation.
Added more tests to findHtmldocTest::testCanTraverseElements() to test traversing as an array.

Author: hexydec

composer.lock

@@ -13,11 +13,13 @@ if ($doc->load($html)) {
 
 <table>
 	<thead>
-		<th>Parameter</th>
-		<th>Type</th>
-		<th>Options</th>
-		<th>Description</th>
-		<th>Default</th>
+		<tr>
+			<th>Parameter</th>
+			<th>Type</th>
+			<th>Options</th>
+			<th>Description</th>
+			<th>Default</th>
+		</tr>
 	</thead>
 	<tbody>
 		<tr>

docs/api/html.md

@@ -14,6 +14,14 @@ $doc->load($html, $charset = null);
 | `$html`	| String	| The HTML to be parsed into the object			|
 | `$charset`| String	| The charset of the document, or `null` to auto-detect |
 
+## Auto-detecting the Charset
+
+If `$charset` is set to null, the program will attempt to auto-detect the charset by looking for:
+
+`<meta http-equiv="Content-Type" content="text/html; charset=xxx" />`
+
+Where the charset will be extracted from, otherwise the charset will be detected using `mb_detect_encoding`.
+
 ## Returns
 
 A boolean indicating whether the HTML was parsed successfully.

docs/api/load.md

@@ -17,11 +17,13 @@ An optional array contains a list of configuration parameters to configure the m
 
 <table>
 	<thead>
-		<th>Parameter</th>
-		<th>Type</th>
-		<th>Options</th>
-		<th>Description</th>
-		<th>Default</th>
+		<tr>
+			<th>Parameter</th>
+			<th>Type</th>
+			<th>Options</th>
+			<th>Description</th>
+			<th>Default</th>
+		</tr>
 	</thead>
 	<tbody>
 		<tr>

docs/api/minify.md

@@ -5,14 +5,14 @@ This document describes how to configure and use the HTMLdoc object.
 | Method							| Description 								|
 |-----------------------------------|-------------------------------------------|
 | [__construct()](construct.md)		| Constructs an HTMLdoc object 				|
-| [open()](open.md)					| Open an HTML file from a URL or stream 	|
-| [load()](load.md)					| Load HTML from a strings					|
+| [open()](open.md)					| Open an HTML document from a URL or stream 	|
+| [load()](load.md)					| Load HTML from a string					|
 | [find()](find.md)					| Find elements within the documents		|
 | [eq()](eq.md)						| Filter elements to the selected index		|
 | [first()](first.md)				| Filter elements by the first element		|
 | [last()](last.md)					| Filter elements by the last element		|
 | [attr()](attr.md)					| Retrieve the value of an attribute		|
 | [text()](text.md)					| Extract text from an HTMLdoc		 		|
 | [minify()](minify.md)				| Minify the HTMLdoc						|
-| [html()](html.md)					| Render the document as HTMLdoc	 		|
+| [html()](html.md)					| Render the document as HTML		 		|
 | [save()](save.md)					| Save as a file or output as a string 		|

docs/api/readme.md

@@ -134,7 +134,7 @@ public function current() {
 	 *
 	 * @return scalar The current pointer position
 	 */
-	public function key() : scalar {
+	public function key() : int {
 		return $this->pointer;
 	}
 

src/htmldoc.php

@@ -60,6 +60,17 @@ public function testCanTraverseElements() {
 			$this->assertEquals(3, count($doc->find('body > *')->get()));
 			$this->assertEquals('<div class="last">Last</div>', $doc->find('body > *')->get(2)->html());
 			$this->assertEquals('<div class="last">Last</div>', $doc->find('body > *')->get(-1)->html());
+
+			$cls = ['first', 'find', 'last'];
+			$divs = $doc->find('body > *');
+			$this->assertTrue(isset($divs[0]), true);
+			$this->assertEquals($cls[0], $divs[0]->attr('class'));
+			foreach ($divs AS $key => $item) {
+				$this->assertEquals($cls[$key], $item->attr('class'));
+			}
+
+			unset($divs[2]);
+			$this->assertEquals(isset($divs[2]), false);
 		}
 	}