Updated documentation

Author: paquettg

README.md

@@ -57,6 +57,36 @@ This example loads the html from big.html, a real page found online, and gets al
 
 Alternativly, you can always use the load() method to load the file. It will attempt to find the file using file_exists and, if succesfull, will call loadFromFile() for you. The same applies to a URL and loadFromUrl() method.
 
+Example With Url
+----------------
+
+Loading a url is very similar to the way you would load the html from a file. 
+
+```php
+use PHPHtmlParser\Dom;
+
+$dom = new Dom;
+$dom->loadFromUrl('http://google.com');
+$html = $dom->outerHtml;
+
+// or
+$dom->load('http://google.com');
+$html = $dom->outerHtml; // same result as the first example
+```
+
+What makes the loadFromUrl method note worthy is the PHPHtmlParser\CurlInterface parameter, an optional second parameter. By default, we use the PHPHtmlParser\Curl class to get the contents of the url. On the other hand, though, you can inject your own implementation of CurlInterface and we will attempt to load the url using what ever tool/settings you want, up to you.
+
+```php
+use PHPHtmlParser\Dom;
+use App\Services\Connector;
+
+$dom = new Dom;
+$dom->loadFromUrl('http://google.com', new Connector);
+$html = $dom->outerHtml;
+```
+
+As long as the Connector object implements the PHPHtmlParser\CurlInterface interface properly it will use that object to get the content of the url instead of the default PHPHtmlParser\Curl class.
+
 Static Facade
 ------------
 

src/PHPHtmlParser/Dom.php

@@ -122,7 +122,8 @@ public function loadFromFile($file)
 	}
 
 	/**
-	 * Uses guzzle to load the html from the given url.
+	 * Use a curl interface implementation to attempt to load
+	 * the content from a url.
 	 *
 	 * @param string $url
 	 * @param CurlInterface $curl

src/PHPHtmlParser/StaticDom.php

@@ -5,6 +5,15 @@ final class StaticDom {
 
 	private static $dom = null;
 
+	/**
+	 * Attempts to call the given method on the most recent created dom
+	 * from bellow.
+	 *
+	 * @param string $method
+	 * @param array $arguments
+	 * @throws Exception
+	 * @return mixed
+	 */
 	public static function __callStatic($method, $arguments)
 	{
 		if (self::$dom instanceof Dom)
@@ -17,6 +26,14 @@ public static function __callStatic($method, $arguments)
 		}
 	}
 
+	/**
+	 * Call this to mount the static facade. The facade allows you to use
+	 * this object as a $className.
+	 *
+	 * @param string $className
+	 * @param Dom $dom
+	 * @return bool
+	 */
 	public static function mount($className = 'Dom', Dom $dom = null)
 	{
 		if (class_exists($className))
@@ -31,23 +48,52 @@ class_alias(__CLASS__, $className);
 		return true;
 	}
 
+	/**
+	 * Creates a new dom object and calls load() on the
+	 * new object.
+	 *
+	 * @param string $str
+	 * @chainable
+	 */
 	public static function load($str)
 	{
 		$dom       = new Dom;
 		self::$dom = $dom;
 		return $dom->load($str);
 	}
 
+	/**
+	 * Creates a new dom object and calls loadFromFile() on the
+	 * new object.
+
+	 * @param string $file
+	 * @chainable
+	 */
 	public static function loadFromFile($file)
 	{
-		$dom = new Dom;
+		$dom       = new Dom;
+		self::$dom = $dom;
 		return $dom->loadFromFile($file);
 	}
 
-	public static function loadFromUrl($url)
+	/**
+	 * Creates a new dom object and calls loadFromUrl() on the
+	 * new object.
+	 *
+	 * @param string $url
+	 * @param CurlInterface $curl
+	 * @chainable
+	 */
+	public static function loadFromUrl($url, CurlInterface $curl = null)
 	{
 		$dom       = new Dom;
 		self::$dom = $dom;
-		return $dom->loadFromUrl($url);
+		if (is_null($curl))
+		{
+			// use the default curl interface
+			$curl = new Curl;
+		}
+
+		return $dom->loadFromUrl($url, $curl);
 	}
 }