Merge pull request #820 from stof/fix_phpdoc

Fix some wrong types in phpdoc

Author: stof

src/Driver/DriverInterface.php

@@ -153,7 +153,7 @@ public function setBasicAuth($user, $password);
     /**
      * Switches to specific browser window.
      *
-     * @param string $name window name (null for switching back to main window)
+     * @param string|null $name window name (null for switching back to main window)
      *
      * @throws UnsupportedDriverActionException When operation not supported by the driver
      * @throws DriverException                  When the operation cannot be done
@@ -163,7 +163,7 @@ public function switchToWindow($name = null);
     /**
      * Switches to specific iFrame.
      *
-     * @param string $name iframe name (null for switching back)
+     * @param string|null $name iframe name (null for switching back)
      *
      * @throws UnsupportedDriverActionException When operation not supported by the driver
      * @throws DriverException                  When the operation cannot be done
@@ -184,7 +184,7 @@ public function setRequestHeader($name, $value);
     /**
      * Returns last response headers.
      *
-     * @return array
+     * @return array<string, string|string[]>
      *
      * @throws UnsupportedDriverActionException When operation not supported by the driver
      * @throws DriverException                  When the operation cannot be done
@@ -194,8 +194,10 @@ public function getResponseHeaders();
     /**
      * Sets cookie.
      *
-     * @param string $name
-     * @param string $value
+     * Passing null as value will delete the cookie.
+     *
+     * @param string      $name
+     * @param string|null $value
      *
      * @throws UnsupportedDriverActionException When operation not supported by the driver
      * @throws DriverException                  When the operation cannot be done
@@ -248,7 +250,7 @@ public function getScreenshot();
     /**
      * Return the names of all open windows.
      *
-     * @return array array of all open windows
+     * @return string[] array of all open windows
      *
      * @throws UnsupportedDriverActionException When operation not supported by the driver
      * @throws DriverException                  When the operation cannot be done
@@ -278,7 +280,7 @@ public function getWindowName();
     public function find($xpath);
 
     /**
-     * Returns element's tag name by it's XPath query.
+     * Returns element's tag name by its XPath query.
      *
      * @param string $xpath
      *
@@ -290,7 +292,7 @@ public function find($xpath);
     public function getTagName($xpath);
 
     /**
-     * Returns element's text by it's XPath query.
+     * Returns element's text by its XPath query.
      *
      * @param string $xpath
      *
@@ -302,7 +304,7 @@ public function getTagName($xpath);
     public function getText($xpath);
 
     /**
-     * Returns element's inner html by it's XPath query.
+     * Returns element's inner html by its XPath query.
      *
      * @param string $xpath
      *
@@ -314,7 +316,7 @@ public function getText($xpath);
     public function getHtml($xpath);
 
     /**
-     * Returns element's outer html by it's XPath query.
+     * Returns element's outer html by its XPath query.
      *
      * @param string $xpath
      *
@@ -326,7 +328,7 @@ public function getHtml($xpath);
     public function getOuterHtml($xpath);
 
     /**
-     * Returns element's attribute by it's XPath query.
+     * Returns element's attribute by its XPath query.
      *
      * @param string $xpath
      * @param string $name
@@ -339,7 +341,7 @@ public function getOuterHtml($xpath);
     public function getAttribute($xpath, $name);
 
     /**
-     * Returns element's value by it's XPath query.
+     * Returns element's value by its XPath query.
      *
      * @param string $xpath
      *
@@ -353,7 +355,7 @@ public function getAttribute($xpath, $name);
     public function getValue($xpath);
 
     /**
-     * Sets element's value by it's XPath query.
+     * Sets element's value by its XPath query.
      *
      * @param string            $xpath
      * @param string|bool|array $value
@@ -366,7 +368,7 @@ public function getValue($xpath);
     public function setValue($xpath, $value);
 
     /**
-     * Checks checkbox by it's XPath query.
+     * Checks checkbox by its XPath query.
      *
      * @param string $xpath
      *
@@ -378,7 +380,7 @@ public function setValue($xpath, $value);
     public function check($xpath);
 
     /**
-     * Unchecks checkbox by it's XPath query.
+     * Unchecks checkbox by its XPath query.
      *
      * @param string $xpath
      *
@@ -390,7 +392,7 @@ public function check($xpath);
     public function uncheck($xpath);
 
     /**
-     * Checks whether checkbox or radio button located by it's XPath query is checked.
+     * Checks whether checkbox or radio button located by its XPath query is checked.
      *
      * @param string $xpath
      *
@@ -404,7 +406,7 @@ public function uncheck($xpath);
     public function isChecked($xpath);
 
     /**
-     * Selects option from select field or value in radio group located by it's XPath query.
+     * Selects option from select field or value in radio group located by its XPath query.
      *
      * @param string  $xpath
      * @param string  $value
@@ -418,7 +420,7 @@ public function isChecked($xpath);
     public function selectOption($xpath, $value, $multiple = false);
 
     /**
-     * Checks whether select option, located by it's XPath query, is selected.
+     * Checks whether select option, located by its XPath query, is selected.
      *
      * @param string $xpath
      *
@@ -432,7 +434,7 @@ public function selectOption($xpath, $value, $multiple = false);
     public function isSelected($xpath);
 
     /**
-     * Clicks button or link located by it's XPath query.
+     * Clicks button or link located by its XPath query.
      *
      * @param string $xpath
      *
@@ -442,7 +444,7 @@ public function isSelected($xpath);
     public function click($xpath);
 
     /**
-     * Double-clicks button or link located by it's XPath query.
+     * Double-clicks button or link located by its XPath query.
      *
      * @param string $xpath
      *
@@ -452,7 +454,7 @@ public function click($xpath);
     public function doubleClick($xpath);
 
     /**
-     * Right-clicks button or link located by it's XPath query.
+     * Right-clicks button or link located by its XPath query.
      *
      * @param string $xpath
      *
@@ -462,7 +464,7 @@ public function doubleClick($xpath);
     public function rightClick($xpath);
 
     /**
-     * Attaches file path to file field located by it's XPath query.
+     * Attaches file path to file field located by its XPath query.
      *
      * @param string $xpath
      * @param string $path
@@ -475,7 +477,7 @@ public function rightClick($xpath);
     public function attachFile($xpath, $path);
 
     /**
-     * Checks whether element visible located by it's XPath query.
+     * Checks whether element visible located by its XPath query.
      *
      * @param string $xpath
      *
@@ -531,9 +533,9 @@ public function keyPress($xpath, $char, $modifier = null);
     /**
      * Pressed down specific keyboard key.
      *
-     * @param string     $xpath
-     * @param string|int $char     could be either char ('b') or char-code (98)
-     * @param string     $modifier keyboard modifier (could be 'ctrl', 'alt', 'shift' or 'meta')
+     * @param string      $xpath
+     * @param string|int  $char     could be either char ('b') or char-code (98)
+     * @param string|null $modifier keyboard modifier (could be 'ctrl', 'alt', 'shift' or 'meta')
      *
      * @throws UnsupportedDriverActionException When operation not supported by the driver
      * @throws DriverException                  When the operation cannot be done
@@ -543,9 +545,9 @@ public function keyDown($xpath, $char, $modifier = null);
     /**
      * Pressed up specific keyboard key.
      *
-     * @param string     $xpath
-     * @param string|int $char     could be either char ('b') or char-code (98)
-     * @param string     $modifier keyboard modifier (could be 'ctrl', 'alt', 'shift' or 'meta')
+     * @param string      $xpath
+     * @param string|int  $char     could be either char ('b') or char-code (98)
+     * @param string|null $modifier keyboard modifier (could be 'ctrl', 'alt', 'shift' or 'meta')
      *
      * @throws UnsupportedDriverActionException When operation not supported by the driver
      * @throws DriverException                  When the operation cannot be done

src/Element/NodeElement.php

@@ -106,7 +106,7 @@ public function setValue($value)
     }
 
     /**
-     * Checks whether element has attribute with specified name.
+     * Checks whether element has an attribute with specified name.
      *
      * @param string $name
      *
@@ -308,8 +308,8 @@ public function blur()
     /**
      * Presses specific keyboard key.
      *
-     * @param string|int $char     could be either char ('b') or char-code (98)
-     * @param string     $modifier keyboard modifier (could be 'ctrl', 'alt', 'shift' or 'meta')
+     * @param string|int  $char     could be either char ('b') or char-code (98)
+     * @param string|null $modifier keyboard modifier (could be 'ctrl', 'alt', 'shift' or 'meta')
      */
     public function keyPress($char, $modifier = null)
     {
@@ -319,8 +319,8 @@ public function keyPress($char, $modifier = null)
     /**
      * Pressed down specific keyboard key.
      *
-     * @param string|int $char     could be either char ('b') or char-code (98)
-     * @param string     $modifier keyboard modifier (could be 'ctrl', 'alt', 'shift' or 'meta')
+     * @param string|int  $char     could be either char ('b') or char-code (98)
+     * @param string|null $modifier keyboard modifier (could be 'ctrl', 'alt', 'shift' or 'meta')
      */
     public function keyDown($char, $modifier = null)
     {
@@ -330,8 +330,8 @@ public function keyDown($char, $modifier = null)
     /**
      * Pressed up specific keyboard key.
      *
-     * @param string|int $char     could be either char ('b') or char-code (98)
-     * @param string     $modifier keyboard modifier (could be 'ctrl', 'alt', 'shift' or 'meta')
+     * @param string|int  $char     could be either char ('b') or char-code (98)
+     * @param string|null $modifier keyboard modifier (could be 'ctrl', 'alt', 'shift' or 'meta')
      */
     public function keyUp($char, $modifier = null)
     {

src/Exception/ElementHtmlException.php

@@ -34,7 +34,7 @@ class ElementHtmlException extends ExpectationException
      * @param string                  $message   optional message
      * @param DriverInterface|Session $driver    driver instance
      * @param Element                 $element   element
-     * @param \Exception              $exception expectation exception
+     * @param \Exception|null         $exception expectation exception
      */
     public function __construct($message, $driver, Element $element, \Exception $exception = null)
     {

src/Exception/ElementNotFoundException.php

@@ -24,9 +24,9 @@ class ElementNotFoundException extends ExpectationException
      * Initializes exception.
      *
      * @param DriverInterface|Session $driver   driver instance
-     * @param string                  $type     element type
-     * @param string                  $selector element selector type
-     * @param string                  $locator  element locator
+     * @param string|null             $type     element type
+     * @param string|null             $selector element selector type
+     * @param string|null             $locator  element locator
      */
     public function __construct($driver, $type = null, $selector = null, $locator = null)
     {

src/Exception/UnsupportedDriverActionException.php

@@ -24,7 +24,7 @@ class UnsupportedDriverActionException extends DriverException
      *
      * @param string          $template what is unsupported?
      * @param DriverInterface $driver   driver instance
-     * @param \Exception      $previous previous exception
+     * @param \Exception|null $previous previous exception
      */
     public function __construct($template, DriverInterface $driver, \Exception $previous = null)
     {

src/Mink.php

@@ -11,12 +11,15 @@
 namespace Behat\Mink;
 
 /**
- * Mink sessions manager.
+ * Mink session manager.
  *
  * @author Konstantin Kudryashov <ever.zet@gmail.com>
  */
 class Mink
 {
+    /**
+     * @var null|string
+     */
     private $defaultSessionName;
 
     /**
@@ -102,7 +105,7 @@ public function getDefaultSessionName()
     /**
      * Returns registered session by it's name or default one.
      *
-     * @param string $name session name
+     * @param string|null $name session name
      *
      * @return Session
      *
@@ -116,7 +119,7 @@ public function getSession($name = null)
     /**
      * Checks whether a named session (or the default session) has already been started.
      *
-     * @param string $name session name - if null then the default session will be checked
+     * @param string|null $name session name - if null then the default session will be checked
      *
      * @return bool whether the session has been started
      *
@@ -132,7 +135,7 @@ public function isSessionStarted($name = null)
     /**
      * Returns session asserter.
      *
-     * @param Session|string $session session object or name
+     * @param Session|string|null $session session object or name
      *
      * @return WebAssert
      */
@@ -184,7 +187,7 @@ public function stopSessions()
     /**
      * Returns the named or default session without starting it.
      *
-     * @param string $name session name
+     * @param string|null $name session name
      *
      * @return Session
      *

src/Selector/Xpath/Manipulator.php

@@ -125,5 +125,4 @@ private function splitUnionParts($xpath)
 
         return array($xpath); // The XPath expression is invalid
     }
-
 }