Replace more docblocks by type-hints

Author: nicolas-grekas

AbstractUriElement.php

@@ -36,11 +36,11 @@ abstract class AbstractUriElement
     /**
      * @param \DOMElement $node       A \DOMElement instance
      * @param string      $currentUri The URI of the page where the link is embedded (or the base href)
-     * @param string      $method     The method to use for the link (get by default)
+     * @param string      $method     The method to use for the link (GET by default)
      *
      * @throws \InvalidArgumentException if the node is not a link
      */
-    public function __construct(\DOMElement $node, $currentUri, $method = 'GET')
+    public function __construct(\DOMElement $node, string $currentUri, ?string $method = 'GET')
     {
         if (!in_array(strtolower(substr($currentUri, 0, 4)), array('http', 'file'))) {
             throw new \InvalidArgumentException(sprintf('Current URI must be an absolute URL ("%s").', $currentUri));
@@ -168,24 +168,16 @@ abstract protected function setNode(\DOMElement $node);
 
     /**
      * Removes the query string and the anchor from the given uri.
-     *
-     * @param string $uri The uri to clean
-     *
-     * @return string
      */
-    private function cleanupUri($uri)
+    private function cleanupUri(string $uri): string
     {
         return $this->cleanupQuery($this->cleanupAnchor($uri));
     }
 
     /**
      * Remove the query string from the uri.
-     *
-     * @param string $uri
-     *
-     * @return string
      */
-    private function cleanupQuery($uri)
+    private function cleanupQuery(string $uri): string
     {
         if (false !== $pos = strpos($uri, '?')) {
             return substr($uri, 0, $pos);
@@ -196,12 +188,8 @@ private function cleanupQuery($uri)
 
     /**
      * Remove the anchor from the uri.
-     *
-     * @param string $uri
-     *
-     * @return string
      */
-    private function cleanupAnchor($uri)
+    private function cleanupAnchor(string $uri): string
     {
         if (false !== $pos = strpos($uri, '#')) {
             return substr($uri, 0, $pos);

Crawler.php

@@ -59,7 +59,7 @@ class Crawler implements \Countable, \IteratorAggregate
      * @param string $uri      The current URI
      * @param string $baseHref The base href value
      */
-    public function __construct($node = null, $uri = null, $baseHref = null)
+    public function __construct($node = null, string $uri = null, string $baseHref = null)
     {
         $this->uri = $uri;
         $this->baseHref = $baseHref ?: $uri;
@@ -958,12 +958,8 @@ private function filterRelativeXPath($xpath)
      *
      * The returned XPath will match elements matching the XPath inside the current crawler
      * when running in the context of a node of the crawler.
-     *
-     * @param string $xpath
-     *
-     * @return string
      */
-    private function relativize($xpath)
+    private function relativize(string $xpath): string
     {
         $expressions = array();
 
@@ -1095,14 +1091,9 @@ protected function sibling($node, $siblingDir = 'nextSibling')
     }
 
     /**
-     * @param \DOMDocument $document
-     * @param array        $prefixes
-     *
-     * @return \DOMXPath
-     *
      * @throws \InvalidArgumentException
      */
-    private function createDOMXPath(\DOMDocument $document, array $prefixes = array())
+    private function createDOMXPath(\DOMDocument $document, array $prefixes = array()): \DOMXPath
     {
         $domxpath = new \DOMXPath($document);
 
@@ -1117,14 +1108,9 @@ private function createDOMXPath(\DOMDocument $document, array $prefixes = array(
     }
 
     /**
-     * @param \DOMXPath $domxpath
-     * @param string    $prefix
-     *
-     * @return string
-     *
      * @throws \InvalidArgumentException
      */
-    private function discoverNamespace(\DOMXPath $domxpath, $prefix)
+    private function discoverNamespace(\DOMXPath $domxpath, string $prefix): string
     {
         if (isset($this->namespaces[$prefix])) {
             return $this->namespaces[$prefix];
@@ -1138,12 +1124,7 @@ private function discoverNamespace(\DOMXPath $domxpath, $prefix)
         }
     }
 
-    /**
-     * @param string $xpath
-     *
-     * @return array
-     */
-    private function findNamespacePrefixes($xpath)
+    private function findNamespacePrefixes(string $xpath): array
     {
         if (preg_match_all('/(?P<prefix>[a-z_][a-z_0-9\-\.]*+):[^"\/:]/i', $xpath, $matches)) {
             return array_unique($matches['prefix']);

Field/ChoiceFormField.php

@@ -254,12 +254,8 @@ protected function initialize()
 
     /**
      * Returns option value with associated disabled flag.
-     *
-     * @param \DOMElement $node
-     *
-     * @return array
      */
-    private function buildOptionValue(\DOMElement $node)
+    private function buildOptionValue(\DOMElement $node): array
     {
         $option = array();
 

Form.php

@@ -44,7 +44,7 @@ class Form extends Link implements \ArrayAccess
      *
      * @throws \LogicException if the node is not a button inside a form tag
      */
-    public function __construct(\DOMElement $node, $currentUri, $method = null, $baseHref = null)
+    public function __construct(\DOMElement $node, string $currentUri, string $method = null, string $baseHref = null)
     {
         parent::__construct($node, $currentUri, $method);
         $this->baseHref = $baseHref;

Image.php

@@ -16,7 +16,7 @@
  */
 class Image extends AbstractUriElement
 {
-    public function __construct(\DOMElement $node, $currentUri)
+    public function __construct(\DOMElement $node, string $currentUri)
     {
         parent::__construct($node, $currentUri, 'GET');
     }