Add scalar typehints/return types on final/internal/private code

Robin Chalas · Robin Chalas · commit 226b38d109a4 · 2017-08-31T22:46:21.000+02:00
diff --git a/Node/AbstractNode.php b/Node/AbstractNode.php
@@ -31,7 +31,7 @@ abstract class AbstractNode implements NodeInterface
     /**
      * @return string
      */
-    public function getNodeName()
+    public function getNodeName(): string
     {
         if (null === $this->nodeName) {
             $this->nodeName = preg_replace('~.*\\\\([^\\\\]+)Node$~', '$1', get_called_class());
diff --git a/Node/AttributeNode.php b/Node/AttributeNode.php
@@ -107,15 +107,15 @@ public function getValue()
     /**
      * {@inheritdoc}
      */
-    public function getSpecificity()
+    public function getSpecificity(): Specificity
     {
         return $this->selector->getSpecificity()->plus(new Specificity(0, 1, 0));
     }
 
     /**
      * {@inheritdoc}
      */
-    public function __toString()
+    public function __toString(): string
     {
         $attribute = $this->namespace ? $this->namespace.'|'.$this->attribute : $this->attribute;
 
diff --git a/Node/ClassNode.php b/Node/ClassNode.php
@@ -62,15 +62,15 @@ public function getName()
     /**
      * {@inheritdoc}
      */
-    public function getSpecificity()
+    public function getSpecificity(): Specificity
     {
         return $this->selector->getSpecificity()->plus(new Specificity(0, 1, 0));
     }
 
     /**
      * {@inheritdoc}
      */
-    public function __toString()
+    public function __toString(): string
     {
         return sprintf('%s[%s.%s]', $this->getNodeName(), $this->selector, $this->name);
     }
diff --git a/Node/CombinedSelectorNode.php b/Node/CombinedSelectorNode.php
@@ -77,15 +77,15 @@ public function getSubSelector()
     /**
      * {@inheritdoc}
      */
-    public function getSpecificity()
+    public function getSpecificity(): Specificity
     {
         return $this->selector->getSpecificity()->plus($this->subSelector->getSpecificity());
     }
 
     /**
      * {@inheritdoc}
      */
-    public function __toString()
+    public function __toString(): string
     {
         $combinator = ' ' === $this->combinator ? '<followed>' : $this->combinator;
 
diff --git a/Node/ElementNode.php b/Node/ElementNode.php
@@ -62,15 +62,15 @@ public function getElement()
     /**
      * {@inheritdoc}
      */
-    public function getSpecificity()
+    public function getSpecificity(): Specificity
     {
         return new Specificity(0, 0, $this->element ? 1 : 0);
     }
 
     /**
      * {@inheritdoc}
      */
-    public function __toString()
+    public function __toString(): string
     {
         $element = $this->element ?: '*';
 
diff --git a/Node/FunctionNode.php b/Node/FunctionNode.php
@@ -79,15 +79,15 @@ public function getArguments()
     /**
      * {@inheritdoc}
      */
-    public function getSpecificity()
+    public function getSpecificity(): Specificity
     {
         return $this->selector->getSpecificity()->plus(new Specificity(0, 1, 0));
     }
 
     /**
      * {@inheritdoc}
      */
-    public function __toString()
+    public function __toString(): string
     {
         $arguments = implode(', ', array_map(function (Token $token) {
             return "'".$token->getValue()."'";
diff --git a/Node/HashNode.php b/Node/HashNode.php
@@ -62,15 +62,15 @@ public function getId()
     /**
      * {@inheritdoc}
      */
-    public function getSpecificity()
+    public function getSpecificity(): Specificity
     {
         return $this->selector->getSpecificity()->plus(new Specificity(1, 0, 0));
     }
 
     /**
      * {@inheritdoc}
      */
-    public function __toString()
+    public function __toString(): string
     {
         return sprintf('%s[%s#%s]', $this->getNodeName(), $this->selector, $this->id);
     }
diff --git a/Node/NegationNode.php b/Node/NegationNode.php
@@ -62,15 +62,15 @@ public function getSubSelector()
     /**
      * {@inheritdoc}
      */
-    public function getSpecificity()
+    public function getSpecificity(): Specificity
     {
         return $this->selector->getSpecificity()->plus($this->subSelector->getSpecificity());
     }
 
     /**
      * {@inheritdoc}
      */
-    public function __toString()
+    public function __toString(): string
     {
         return sprintf('%s[%s:not(%s)]', $this->getNodeName(), $this->selector, $this->subSelector);
     }
diff --git a/Node/NodeInterface.php b/Node/NodeInterface.php
@@ -23,24 +23,9 @@
  */
 interface NodeInterface
 {
-    /**
-     * Returns node's name.
-     *
-     * @return string
-     */
-    public function getNodeName();
+    public function getNodeName(): string;
 
-    /**
-     * Returns node's specificity.
-     *
-     * @return Specificity
-     */
-    public function getSpecificity();
+    public function getSpecificity(): Specificity;
 
-    /**
-     * Returns node's string representation.
-     *
-     * @return string
-     */
-    public function __toString();
+    public function __toString(): string;
 }
diff --git a/Node/PseudoNode.php b/Node/PseudoNode.php
@@ -62,15 +62,15 @@ public function getIdentifier()
     /**
      * {@inheritdoc}
      */
-    public function getSpecificity()
+    public function getSpecificity(): Specificity
     {
         return $this->selector->getSpecificity()->plus(new Specificity(0, 1, 0));
     }
 
     /**
      * {@inheritdoc}
      */
-    public function __toString()
+    public function __toString(): string
     {
         return sprintf('%s[%s:%s]', $this->getNodeName(), $this->selector, $this->identifier);
     }
diff --git a/Node/SelectorNode.php b/Node/SelectorNode.php
@@ -62,15 +62,15 @@ public function getPseudoElement()
     /**
      * {@inheritdoc}
      */
-    public function getSpecificity()
+    public function getSpecificity(): Specificity
     {
         return $this->tree->getSpecificity()->plus(new Specificity(0, 0, $this->pseudoElement ? 1 : 0));
     }
 
     /**
      * {@inheritdoc}
      */
-    public function __toString()
+    public function __toString(): string
     {
         return sprintf('%s[%s%s]', $this->getNodeName(), $this->tree, $this->pseudoElement ? '::'.$this->pseudoElement : '');
     }
diff --git a/Node/Specificity.php b/Node/Specificity.php
@@ -44,36 +44,19 @@ class Specificity
      */
     private $c;
 
-    /**
-     * Constructor.
-     *
-     * @param int $a
-     * @param int $b
-     * @param int $c
-     */
-    public function __construct($a, $b, $c)
+    public function __construct(int $a, int $b, int $c)
     {
         $this->a = $a;
         $this->b = $b;
         $this->c = $c;
     }
 
-    /**
-     * @param Specificity $specificity
-     *
-     * @return self
-     */
-    public function plus(Specificity $specificity)
+    public function plus(Specificity $specificity): Specificity
     {
         return new self($this->a + $specificity->a, $this->b + $specificity->b, $this->c + $specificity->c);
     }
 
-    /**
-     * Returns global specificity value.
-     *
-     * @return int
-     */
-    public function getValue()
+    public function getValue(): int
     {
         return $this->a * self::A_FACTOR + $this->b * self::B_FACTOR + $this->c * self::C_FACTOR;
     }
diff --git a/Parser/Handler/CommentHandler.php b/Parser/Handler/CommentHandler.php
@@ -29,7 +29,7 @@ class CommentHandler implements HandlerInterface
     /**
      * {@inheritdoc}
      */
-    public function handle(Reader $reader, TokenStream $stream)
+    public function handle(Reader $reader, TokenStream $stream): bool
     {
         if ('/*' !== $reader->getSubstring(2)) {
             return false;
diff --git a/Parser/Handler/HandlerInterface.php b/Parser/Handler/HandlerInterface.php
@@ -32,5 +32,5 @@ interface HandlerInterface
      *
      * @return bool
      */
-    public function handle(Reader $reader, TokenStream $stream);
+    public function handle(Reader $reader, TokenStream $stream): bool;
 }
diff --git a/Parser/Handler/HashHandler.php b/Parser/Handler/HashHandler.php
@@ -52,7 +52,7 @@ public function __construct(TokenizerPatterns $patterns, TokenizerEscaping $esca
     /**
      * {@inheritdoc}
      */
-    public function handle(Reader $reader, TokenStream $stream)
+    public function handle(Reader $reader, TokenStream $stream): bool
     {
         $match = $reader->findPattern($this->patterns->getHashPattern());
 
diff --git a/Parser/Handler/IdentifierHandler.php b/Parser/Handler/IdentifierHandler.php
@@ -52,7 +52,7 @@ public function __construct(TokenizerPatterns $patterns, TokenizerEscaping $esca
     /**
      * {@inheritdoc}
      */
-    public function handle(Reader $reader, TokenStream $stream)
+    public function handle(Reader $reader, TokenStream $stream): bool
     {
         $match = $reader->findPattern($this->patterns->getIdentifierPattern());
 
diff --git a/Parser/Handler/NumberHandler.php b/Parser/Handler/NumberHandler.php
@@ -44,7 +44,7 @@ public function __construct(TokenizerPatterns $patterns)
     /**
      * {@inheritdoc}
      */
-    public function handle(Reader $reader, TokenStream $stream)
+    public function handle(Reader $reader, TokenStream $stream): bool
     {
         $match = $reader->findPattern($this->patterns->getNumberPattern());
 
diff --git a/Parser/Handler/StringHandler.php b/Parser/Handler/StringHandler.php
@@ -54,7 +54,7 @@ public function __construct(TokenizerPatterns $patterns, TokenizerEscaping $esca
     /**
      * {@inheritdoc}
      */
-    public function handle(Reader $reader, TokenStream $stream)
+    public function handle(Reader $reader, TokenStream $stream): bool
     {
         $quote = $reader->getSubstring(1);
 
diff --git a/Parser/Handler/WhitespaceHandler.php b/Parser/Handler/WhitespaceHandler.php
@@ -30,7 +30,7 @@ class WhitespaceHandler implements HandlerInterface
     /**
      * {@inheritdoc}
      */
-    public function handle(Reader $reader, TokenStream $stream)
+    public function handle(Reader $reader, TokenStream $stream): bool
     {
         $match = $reader->findPattern('~^[ \t\r\n\f]+~');
 
diff --git a/Parser/Parser.php b/Parser/Parser.php
@@ -45,7 +45,7 @@ public function __construct(Tokenizer $tokenizer = null)
     /**
      * {@inheritdoc}
      */
-    public function parse($source)
+    public function parse(string $source): array
     {
         $reader = new Reader($source);
         $stream = $this->tokenizer->tokenize($reader);
@@ -102,14 +102,7 @@ public static function parseSeries(array $tokens)
         );
     }
 
-    /**
-     * Parses selector nodes.
-     *
-     * @param TokenStream $stream
-     *
-     * @return array
-     */
-    private function parseSelectorList(TokenStream $stream)
+    private function parseSelectorList(TokenStream $stream): array
     {
         $stream->skipWhitespace();
         $selectors = array();
@@ -128,16 +121,7 @@ private function parseSelectorList(TokenStream $stream)
         return $selectors;
     }
 
-    /**
-     * Parses next selector or combined node.
-     *
-     * @param TokenStream $stream
-     *
-     * @return Node\SelectorNode
-     *
-     * @throws SyntaxErrorException
-     */
-    private function parserSelectorNode(TokenStream $stream)
+    private function parserSelectorNode(TokenStream $stream): Node\SelectorNode
     {
         list($result, $pseudoElement) = $this->parseSimpleSelector($stream);
 
@@ -291,14 +275,7 @@ private function parseSimpleSelector(TokenStream $stream, $insideNegation = fals
         return array($result, $pseudoElement);
     }
 
-    /**
-     * Parses next element node.
-     *
-     * @param TokenStream $stream
-     *
-     * @return Node\ElementNode
-     */
-    private function parseElementNode(TokenStream $stream)
+    private function parseElementNode(TokenStream $stream): Node\ElementNode
     {
         $peek = $stream->getPeek();
 
@@ -324,17 +301,7 @@ private function parseElementNode(TokenStream $stream)
         return new Node\ElementNode($namespace, $element);
     }
 
-    /**
-     * Parses next attribute node.
-     *
-     * @param Node\NodeInterface $selector
-     * @param TokenStream        $stream
-     *
-     * @return Node\AttributeNode
-     *
-     * @throws SyntaxErrorException
-     */
-    private function parseAttributeNode(Node\NodeInterface $selector, TokenStream $stream)
+    private function parseAttributeNode(Node\NodeInterface $selector, TokenStream $stream): Node\AttributeNode
     {
         $stream->skipWhitespace();
         $attribute = $stream->getNextIdentifierOrStar();
diff --git a/Parser/ParserInterface.php b/Parser/ParserInterface.php
@@ -32,5 +32,5 @@ interface ParserInterface
      *
      * @return SelectorNode[]
      */
-    public function parse($source);
+    public function parse(string $source): array;
 }
diff --git a/Parser/Shortcut/ClassParser.php b/Parser/Shortcut/ClassParser.php
@@ -31,7 +31,7 @@ class ClassParser implements ParserInterface
     /**
      * {@inheritdoc}
      */
-    public function parse($source)
+    public function parse(string $source): array
     {
         // Matches an optional namespace, optional element, and required class
         // $source = 'test|input.ab6bd_field';
diff --git a/Parser/Shortcut/ElementParser.php b/Parser/Shortcut/ElementParser.php
diff --git a/Parser/Shortcut/EmptyStringParser.php b/Parser/Shortcut/EmptyStringParser.php
diff --git a/Parser/Shortcut/HashParser.php b/Parser/Shortcut/HashParser.php
diff --git a/Parser/Token.php b/Parser/Token.php
diff --git a/Parser/Tokenizer/TokenizerEscaping.php b/Parser/Tokenizer/TokenizerEscaping.php
diff --git a/XPath/Extension/CombinationExtension.php b/XPath/Extension/CombinationExtension.php
diff --git a/XPath/Translator.php b/XPath/Translator.php
diff --git a/XPath/TranslatorInterface.php b/XPath/TranslatorInterface.php
diff --git a/XPath/XPathExpr.php b/XPath/XPathExpr.php

Original file line number	Diff line number	Diff line change
`@@ -31,7 +31,7 @@ abstract class AbstractNode implements NodeInterface`
`31`	`31`	`/**`
`32`	`32`	`* @return string`
`33`	`33`	`*/`
`34`		`- public function getNodeName()`
	`34`	`+ public function getNodeName(): string`
`35`	`35`	`{`
`36`	`36`	`if (null === $this->nodeName) {`
`37`	`37`	`$this->nodeName = preg_replace('~.*\\\\([^\\\\]+)Node$~', '$1', get_called_class());`
Original file line number	Diff line number	Diff line change
`@@ -107,15 +107,15 @@ public function getValue()`
`107`	`107`	`/**`
`108`	`108`	`* {@inheritdoc}`
`109`	`109`	`*/`
`110`		`- public function getSpecificity()`
	`110`	`+ public function getSpecificity(): Specificity`
`111`	`111`	`{`
`112`	`112`	`return $this->selector->getSpecificity()->plus(new Specificity(0, 1, 0));`
`113`	`113`	`}`
`114`	`114`
`115`	`115`	`/**`
`116`	`116`	`* {@inheritdoc}`
`117`	`117`	`*/`
`118`		`- public function __toString()`
	`118`	`+ public function __toString(): string`
`119`	`119`	`{`
`120`	`120`	`$attribute = $this->namespace ? $this->namespace.'\|'.$this->attribute : $this->attribute;`
`121`	`121`
Original file line number	Diff line number	Diff line change
`@@ -62,15 +62,15 @@ public function getName()`
`62`	`62`	`/**`
`63`	`63`	`* {@inheritdoc}`
`64`	`64`	`*/`
`65`		`- public function getSpecificity()`
	`65`	`+ public function getSpecificity(): Specificity`
`66`	`66`	`{`
`67`	`67`	`return $this->selector->getSpecificity()->plus(new Specificity(0, 1, 0));`
`68`	`68`	`}`
`69`	`69`
`70`	`70`	`/**`
`71`	`71`	`* {@inheritdoc}`
`72`	`72`	`*/`
`73`		`- public function __toString()`
	`73`	`+ public function __toString(): string`
`74`	`74`	`{`
`75`	`75`	`return sprintf('%s[%s.%s]', $this->getNodeName(), $this->selector, $this->name);`
`76`	`76`	`}`
Original file line number	Diff line number	Diff line change
`@@ -77,15 +77,15 @@ public function getSubSelector()`
`77`	`77`	`/**`
`78`	`78`	`* {@inheritdoc}`
`79`	`79`	`*/`
`80`		`- public function getSpecificity()`
	`80`	`+ public function getSpecificity(): Specificity`
`81`	`81`	`{`
`82`	`82`	`return $this->selector->getSpecificity()->plus($this->subSelector->getSpecificity());`
`83`	`83`	`}`
`84`	`84`
`85`	`85`	`/**`
`86`	`86`	`* {@inheritdoc}`
`87`	`87`	`*/`
`88`		`- public function __toString()`
	`88`	`+ public function __toString(): string`
`89`	`89`	`{`
`90`	`90`	`$combinator = ' ' === $this->combinator ? '<followed>' : $this->combinator;`
`91`	`91`
Original file line number	Diff line number	Diff line change
`@@ -79,15 +79,15 @@ public function getArguments()`
`79`	`79`	`/**`
`80`	`80`	`* {@inheritdoc}`
`81`	`81`	`*/`
`82`		`- public function getSpecificity()`
	`82`	`+ public function getSpecificity(): Specificity`
`83`	`83`	`{`
`84`	`84`	`return $this->selector->getSpecificity()->plus(new Specificity(0, 1, 0));`
`85`	`85`	`}`
`86`	`86`
`87`	`87`	`/**`
`88`	`88`	`* {@inheritdoc}`
`89`	`89`	`*/`
`90`		`- public function __toString()`
	`90`	`+ public function __toString(): string`
`91`	`91`	`{`
`92`	`92`	`$arguments = implode(', ', array_map(function (Token $token) {`
`93`	`93`	`return "'".$token->getValue()."'";`