Merge pull request #20 from ashnazg/strict

add strict typing

Author: ashnazg

src/phpDocumentor/GraphViz/Attribute.php

@@ -1,4 +1,6 @@
 <?php
+declare(strict_types=1);
+
 /**
  * phpDocumentor
  *
@@ -34,7 +36,7 @@ class Attribute
      * @param string $key   Id for the new attribute.
      * @param string $value Value for this attribute,
      */
-    public function __construct($key, $value)
+    public function __construct(string $key, string $value)
     {
         $this->key = $key;
         $this->value = $value;
@@ -44,21 +46,17 @@ public function __construct($key, $value)
      * Sets the key for this attribute.
      *
      * @param string $key The new name of this attribute.
-     *
-     * @return \phpDocumentor\GraphViz\Attribute
      */
-    public function setKey($key)
+    public function setKey(string $key): self
     {
         $this->key = $key;
         return $this;
     }
 
     /**
      * Returns the name for this attribute.
-     *
-     * @return string
      */
-    public function getKey()
+    public function getKey(): string
     {
         return $this->key;
     }
@@ -67,31 +65,25 @@ public function getKey()
      * Sets the value for this attribute.
      *
      * @param string $value The new value.
-     *
-     * @return \phpDocumentor\GraphViz\Attribute
      */
-    public function setValue($value)
+    public function setValue(string $value): self
     {
         $this->value = $value;
         return $this;
     }
 
     /**
      * Returns the value for this attribute.
-     *
-     * @return string
      */
-    public function getValue()
+    public function getValue(): string
     {
         return $this->value;
     }
 
     /**
      * Returns the attribute definition as is requested by GraphViz.
-     *
-     * @return string
      */
-    public function __toString()
+    public function __toString(): string
     {
         $key = $this->getKey();
         if ($key === 'url') {
@@ -110,10 +102,8 @@ public function __toString()
 
     /**
      * Returns whether the value contains HTML.
-     *
-     * @return bool
      */
-    public function isValueInHtml()
+    public function isValueInHtml(): bool
     {
         $value = $this->getValue();
 
@@ -122,10 +112,8 @@ public function isValueInHtml()
 
     /**
      * Checks whether the value contains any any special characters needing escaping.
-     *
-     * @return bool
      */
-    public function isValueContainingSpecials()
+    public function isValueContainingSpecials(): bool
     {
         return strstr($this->getValue(), '\\') !== false;
     }
@@ -134,9 +122,8 @@ public function isValueContainingSpecials()
      * Encode special characters so the escape sequences aren't removed
      *
      * @see http://www.graphviz.org/doc/info/attrs.html#k:escString
-     * @return string
      */
-    protected function encodeSpecials()
+    protected function encodeSpecials(): string
     {
         $value = $this->getValue();
         $regex = '(\'|"|\\x00|\\\\(?![\\\\NGETHLnlr]))';

src/phpDocumentor/GraphViz/Edge.php

@@ -1,4 +1,6 @@
 <?php
+declare(strict_types=1);
+
 /**
  * phpDocumentor
  *
@@ -22,20 +24,20 @@
  */
 class Edge
 {
-    /** @var \phpDocumentor\GraphViz\Node Node from where to link */
+    /** @var Node Node from where to link */
     protected $from = null;
 
-    /** @var \phpDocumentor\GraphViz\Node Node where to to link */
+    /** @var Node Node where to to link */
     protected $to = null;
 
-    /** @var \phpDocumentor\GraphViz\Attribute[] List of attributes for this edge */
+    /** @var Attribute[] List of attributes for this edge */
     protected $attributes = [];
 
     /**
      * Creates a new Edge / Link between the given nodes.
      *
-     * @param \phpDocumentor\GraphViz\Node $from Starting node to create an Edge from.
-     * @param \phpDocumentor\GraphViz\Node $to   Destination node where to create and
+     * @param Node $from Starting node to create an Edge from.
+     * @param Node $to   Destination node where to create and
      *  edge to.
      */
     public function __construct(Node $from, Node $to)
@@ -49,33 +51,27 @@ public function __construct(Node $from, Node $to)
      *
      * See the examples for more details.
      *
-     * @param \phpDocumentor\GraphViz\Node $from Starting node to create an Edge from.
-     * @param \phpDocumentor\GraphViz\Node $to   Destination node where to create and
-     *  edge to.
-     *
-     * @return \phpDocumentor\GraphViz\Edge
+     * @param Node $from Starting node to create an Edge from.
+     * @param Node $to Destination node where to create and
+     * edge to.
      */
-    public static function create(Node $from, Node $to)
+    public static function create(Node $from, Node $to): self
     {
         return new self($from, $to);
     }
 
     /**
      * Returns the source Node for this Edge.
-     *
-     * @return \phpDocumentor\GraphViz\Node
      */
-    public function getFrom()
+    public function getFrom(): Node
     {
         return $this->from;
     }
 
     /**
      * Returns the destination Node for this Edge.
-     *
-     * @return \phpDocumentor\GraphViz\Node
      */
-    public function getTo()
+    public function getTo(): Node
     {
         return $this->to;
     }
@@ -94,13 +90,13 @@ public function getTo()
      *  setX or getX.
      * @param mixed[] $arguments Arguments for the setter, only 1 is expected: value
      *
-     * @return \phpDocumentor\GraphViz\Attribute|\phpDocumentor\GraphViz\Edge|null
+     * @return Attribute|Edge|null
      */
-    public function __call($name, $arguments)
+    public function __call(string $name, array $arguments)
     {
         $key = strtolower(substr($name, 3));
         if (strtolower(substr($name, 0, 3)) === 'set') {
-            $this->attributes[$key] = new Attribute($key, $arguments[0]);
+            $this->attributes[$key] = new Attribute($key, (string) $arguments[0]);
 
             return $this;
         }
@@ -114,10 +110,8 @@ public function __call($name, $arguments)
 
     /**
      * Returns the edge definition as is requested by GraphViz.
-     *
-     * @return string
      */
-    public function __toString()
+    public function __toString(): string
     {
         $attributes = [];
         foreach ($this->attributes as $value) {