Magic methods' comments

Author: LuisRBarreras

src/Nearsoft/SeleniumClient/By.php

@@ -27,29 +27,29 @@ public function getSelectorValue() { return $this->_selectorValue; }
 	/**
 	 * Locate by element's css class name
 	 * @param String $selectorValue
-	 * @return \SeleniumClient\By
+	 * @return Nearsoft\SeleniumClient\By
 	 */
 	public static function className($selectorValue) { return new By("class name", $selectorValue); }
 
 	/**
 	 * Locate by element's css selector path
 	 * @param String $selectorValue
-	 * @return \SeleniumClient\By
+	 * @return Nearsoft\SeleniumClient\By
 	 */
 	public static function cssSelector($selectorValue) { return new By("css selector", $selectorValue); }
 
 	/**
 	 * Locate by element's id
 	 * @param String $selectorValue
-	 * @return \SeleniumClient\By
+	 * @return Nearsoft\SeleniumClient\By
 	 */
 	public static function id($selectorValue) { return new By("id", $selectorValue); }
 
 	/**
 	 * Locate by JavaScript selector
 	 * @param string $selectorValue
      * @param string $selectorDefinition
-	 * @return \SeleniumClient\By
+	 * @return Nearsoft\SeleniumClient\By
 	 */
     public static function jsSelector($selectorValue, $selectorDefinition = '$')
     {
@@ -59,35 +59,35 @@ public static function jsSelector($selectorValue, $selectorDefinition = '$')
 	/**
 	 * Locate by element's name
 	 * @param String $selectorValue
-	 * @return \SeleniumClient\By
+	 * @return Nearsoft\SeleniumClient\By
 	 */
 	public static function name($selectorValue) { return new By("name", $selectorValue); }
 
 	/**
 	 * Locate by element's link text
 	 * @param String $selectorValue
-	 * @return \SeleniumClient\By
+	 * @return Nearsoft\SeleniumClient\By
 	 */
 	public static function linkText($selectorValue) { return new By("link text", $selectorValue); }
 
 	/**
 	 * Locate by part of element's link text
 	 * @param String $selectorValue
-	 * @return \SeleniumClient\By
+	 * @return Nearsoft\SeleniumClient\By
 	 */
 	public static function partialLinkText($selectorValue) { return new By("partial link text", $selectorValue); }
 
 	/**
 	 * Locate by element's tag name
 	 * @param String $selectorValue
-	 * @return \SeleniumClient\By
+	 * @return Nearsoft\SeleniumClient\By
 	 */
 	public static function tagName($selectorValue) { return new By("tag name", $selectorValue); }
 
 	/**
 	 * Locate by element's xPath
 	 * @param String $selectorValue
-	 * @return \SeleniumClient\By
+	 * @return Nearsoft\SeleniumClient\By
 	 */
 	public static function xPath($selectorValue) { return new By("xpath", $selectorValue); }
 

src/Nearsoft/SeleniumClient/Options.php

@@ -28,7 +28,7 @@ public function __construct(WebDriver $driver)
 
 	/**
 	 * Gets Timeouts object
-	 * @return SeleniumClient\Timeouts
+	 * @return Nearsoft\SeleniumClient\Timeouts
 	 */
 	public function timeouts()
 	{
@@ -41,7 +41,7 @@ public function timeouts()
 
 	/**
 	 * Gets Window object
-	 * @return SeleniumClient\Window
+	 * @return Nearsoft\SeleniumClient\Window
 	 */
 	public function window()
 	{
@@ -97,7 +97,7 @@ public function getCookieNamed($cookieName)
 
 	/**
 	 * Remove a cookie
-	 * @param SeleniumClient\Cookie $cookie
+	 * @param Nearsoft\SeleniumClient\Cookie $cookie
 	 */
 	public function deleteCookie(Cookie $cookie)
 	{

src/Nearsoft/SeleniumClient/TargetLocator.php

@@ -27,7 +27,7 @@ public function __construct(WebDriver $driver)
 	/**
 	 * Change to the Window by passing in the name
 	 * @param String $identifier either window name or window handle
-	 * @return \SeleniumClient\WebDriver The current webdriver
+	 * @return Nearsoft\SeleniumClient\WebDriver The current webdriver
 	 */
 	public function window($identifier)
 	{
@@ -40,7 +40,7 @@ public function window($identifier)
 	/**
 	 * Focus on specified frame
 	 * @param Mixed $identifier. Null will get default frame. String will get by frame name. Integer will get frame by index. WebElement will get by web element relation.
-	 * @return \SeleniumClient\WebDriver The current webdriver
+	 * @return Nearsoft\SeleniumClient\WebDriver The current webdriver
 	 */
 	public function frame($identifier)
 	{
@@ -72,7 +72,7 @@ public function activeElement()
 
 	/**
 	 *  Switches to the currently active modal dialog for this particular driver instance.
-	 * @return \SeleniumClient\Alert
+	 * @return Nearsoft\SeleniumClient\Alert
 	 */
 	public function alert()
 	{

src/Nearsoft/SeleniumClient/WebDriver.php

@@ -20,6 +20,45 @@
 use Nearsoft\SeleniumClient\Http\HttpClient;
 use Nearsoft\SeleniumClient\Http\HttpFactory;
 
+
+/**
+ * Class WebDriver
+ * @package Nearsoft\SeleniumClient
+ *
+ * @method Nearsoft\SeleniumClient\Navigation navigationBack()
+ * @method Nearsoft\SeleniumClient\Navigation navigationForward()
+ * @method Nearsoft\SeleniumClient\Navigation navigationRefresh()
+ * @method Nearsoft\SeleniumClient\Navigation navigationTo($url)
+ *
+ * @method Nearsoft\SeleniumClient\Window windowMaximize()
+ * @method Nearsoft\SeleniumClient\Window windowGetSize()
+ * @method Nearsoft\SeleniumClient\Window windowGetPosition()
+ * @method Nearsoft\SeleniumClient\Window windowSetSize($width, $height)
+ * @method Nearsoft\SeleniumClient\Window windowSetPosition($x, $y)
+ *
+ * @method Nearsoft\SeleniumClient\TargetLocator switchToWindow($identifier)
+ * @method Nearsoft\SeleniumClient\TargetLocator switchToFrame($identifier)
+ *
+ * @method Nearsoft\SeleniumClient\WebElement findElementByCssSelector($selectorValue)
+ * @method Nearsoft\SeleniumClient\WebElement findElementById($selectorValue)
+ * @method Nearsoft\SeleniumClient\WebElement findElementByJsSelector($selectorValue, $selectorDefinition='$')
+ * @method Nearsoft\SeleniumClient\WebElement findElementByLinkText($selectorValue)
+ * @method Nearsoft\SeleniumClient\WebElement findElementByName($selectorValue)
+ * @method Nearsoft\SeleniumClient\WebElement findElementByPartialLinkText($selectorValue)
+ * @method Nearsoft\SeleniumClient\WebElement findElementByTagName($selectorValue)
+ * @method Nearsoft\SeleniumClient\WebElement findElementByXPath($selectorValue)
+ *
+ * @method Nearsoft\SeleniumClient\WebElement[] findElementsByCssSelector($selectorValue)
+ * @method Nearsoft\SeleniumClient\WebElement[] findElementsById($selectorValue)
+ * @method Nearsoft\SeleniumClient\WebElement[] findElementsByJsSelector($selectorValue, $selectorDefinition='$')
+ * @method Nearsoft\SeleniumClient\WebElement[] findElementsByLinkText($selectorValue)
+ * @method Nearsoft\SeleniumClient\WebElement[] findElementsByName($selectorValue)
+ * @method Nearsoft\SeleniumClient\WebElement[] findElementsByPartialLinkText($selectorValue)
+ * @method Nearsoft\SeleniumClient\WebElement[] findElementsByTagName($selectorValue)
+ * @method Nearsoft\SeleniumClient\WebElement[] findElementsByXPath($selectorValue)
+ */
+
+
 class WebDriver
 {
 	private $_hubUrl               = null;
@@ -172,7 +211,7 @@ private function callFindElement($name, array $args)
         switch ( $call ) {
             case 'findElement':
             case 'findElements':
-                if ( method_exists( '\\SeleniumClient\\By', $by ) ) {
+                if ( method_exists( 'Nearsoft\\SeleniumClient\\By', $by ) ) {
                     $valid = true;
                 }
         }
@@ -181,7 +220,7 @@ private function callFindElement($name, array $args)
             throw new \Exception( 'Invalid magic call: '.$name );
         }
 
-        $method = new \ReflectionMethod( '\\SeleniumClient\\By', $by );
+        $method = new \ReflectionMethod( 'Nearsoft\\SeleniumClient\\By', $by );
         $byArgs = array_splice( $args, 0, $method->getNumberOfParameters() );
         array_unshift( $args, $method->invokeArgs( null, $byArgs ) );
         $element = call_user_func_array( array( $this, $call ), $args );
@@ -254,7 +293,7 @@ public function getHubUrl() { return $this->_hubUrl; }
 
     /**
      * Get Navigation object
-     * @return Selenium\Navigation
+     * @return Nearsoft\Selenium\Navigation
      */
     public function navigate()
     {
@@ -288,7 +327,7 @@ public function getScreenShotsDirectory() { return $this->_screenshotsDirectory;
 
 	/**
 	 * Gets Options object
-	 * @return SeleniumClient\Options
+	 * @return Nearsoft\SeleniumClient\Options
 	 */
 	public function manage()
 	{
@@ -298,7 +337,7 @@ public function manage()
 
 	/**
 	 * Creates new target locator to be handled
-	 * @return \SeleniumClient\TargetLocator
+	 * @return Nearsoft\SeleniumClient\TargetLocator
 	 */
 	public function switchTo()
 	{
@@ -463,7 +502,7 @@ public function screenshot($overrideScreenshotsDirectory = null)
      * @param bool $polling
      * @param int  $elementId
      * @throws Http\SeleniumNoSuchElementException
-     * @return \SeleniumClient\WebElement
+     * @return Nearsoft\SeleniumClient\WebElement
      */
 	public function findElement(By $locator, $polling = false, $elementId = -1)
 	{
@@ -494,7 +533,7 @@ public function findElement(By $locator, $polling = false, $elementId = -1)
      * @param bool $polling
      * @param int  $elementId
      * @throws Exceptions\InvalidSelector
-     * @return \SeleniumClient\WebElement[]
+     * @return Nearsoft\SeleniumClient\WebElement[]
      */
     public function findElements(By $locator, $polling = false, $elementId = -1)
     {
@@ -557,7 +596,7 @@ public function findElements(By $locator, $polling = false, $elementId = -1)
 	 * Stops the process until an element is found
 	 * @param By $locator
 	 * @param Integer $timeOutSeconds
-	 * @return \SeleniumClient\WebElement
+	 * @return Nearsoft\SeleniumClient\WebElement
 	 */
 	public function waitForElementUntilIsPresent(By $locator, $timeOutSeconds = 5)
 	{

src/Nearsoft/SeleniumClient/WebDriverWait.php

@@ -37,7 +37,7 @@ public function getSeconds()
 	 * @param String $method
 	 * @param Array $args
 	 * @throws \Exception
-	 * @throws SeleniumClient\Exceptions\WebDriverWaitTimeout
+	 * @throws Nearsoft\SeleniumClient\Exceptions\WebDriverWaitTimeout
 	 * @return mixed
 	 */
 	public function until($seleniumObject, $method, array $args)

src/Nearsoft/SeleniumClient/WebElement.php

@@ -307,7 +307,7 @@ public function getLocationOnScreenOnceScrolledIntoView()
 	 * Find element within current element
 	 * @param By $locator
 	 * @param Boolean $polling
-	 * @return \SeleniumClient\WebElement
+	 * @return Nearsoft\SeleniumClient\WebElement
 	 */
 	public function findElement(By $locator, $polling = false) 
 	{
@@ -318,7 +318,7 @@ public function findElement(By $locator, $polling = false)
 	 * Find elements within current element
 	 * @param By $locator
 	 * @param Boolean $polling
-	 * @return \SeleniumClient\WebElement[]
+	 * @return Nearsoft\SeleniumClient\WebElement[]
 	 */
 	public function findElements(By $locator, $polling = false) 
 	{
@@ -341,7 +341,7 @@ public function waitForElementUntilIsPresent(By $locator, $timeOutSeconds = 5)
 	/**
 	 * Wait for current element to be displayed
 	 * @param Integer $timeOutSeconds
-	 * @return \SeleniumClient\WebElement
+	 * @return Nearsoft\SeleniumClient\WebElement
 	 */
 	public function waitForElementUntilIsDisplayed($timeOutSeconds = 5)
 	{
@@ -353,7 +353,7 @@ public function waitForElementUntilIsDisplayed($timeOutSeconds = 5)
 	/**
 	 * Wait for current element to be enabled
 	 * @param Integer $timeOutSeconds
-	 * @return \SeleniumClient\WebElement
+	 * @return Nearsoft\SeleniumClient\WebElement
 	 */
 	public function waitForElementUntilIsEnabled($timeOutSeconds = 5)
 	{
@@ -366,8 +366,8 @@ public function waitForElementUntilIsEnabled($timeOutSeconds = 5)
 	 * Wait until current element's text has changed
 	 * @param String $targetText
 	 * @param Integer $timeOutSeconds
-	 * @throws SeleniumClient\Exceptions\WebDriverWaitTimeout
-	 * @return \SeleniumClient\WebElement
+	 * @throws Nearsoft\SeleniumClient\Exceptions\WebDriverWaitTimeout
+	 * @return Nearsoft\SeleniumClient\WebElement
 	 */
 	public function waitForElementUntilTextIsChanged($targetText, $timeOutSeconds = 5)
 	{
@@ -393,8 +393,8 @@ public function waitForElementUntilTextIsChanged($targetText, $timeOutSeconds =
 	 * @param By $locator
 	 * @param String $targetText
 	 * @param Integer $timeOutSeconds
-	 * @throws SeleniumClient\Exceptions\WebDriverWaitTimeout
-	 * @return \SeleniumClient\WebElement
+	 * @throws Nearsoft\SeleniumClient\Exceptions\WebDriverWaitTimeout
+	 * @return Nearsoft\SeleniumClient\WebElement
 	 */
 	public function waitForElementUntilIsPresentWithSpecificText(By $locator, $targetText, $timeOutSeconds = 5)
 	{