phpDocumentor\GraphViz\Edge

Complexity

Total Complexity

15

Size/Duplication

Total Lines	162
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Test Coverage

Coverage

100%

Importance

Changes

0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	14	3
A	isDirected()	0	4	1
A	create()	0	4	1
A	directed()	0	4	1
A	undirected()	0	4	1
A	getFrom()	0	4	1
A	getTo()	0	4	1
A	__call()	0	14	3
A	__toString()	0	22	3

<?php

declare(strict_types=1);

/**
 * phpDocumentor
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 *
 * @link      http://phpdoc.org
 */

namespace phpDocumentor\GraphViz;

use phpDocumentor\GraphViz\Contract\AttributesAwareInterface;
use phpDocumentor\GraphViz\Contract\GraphAwareInterface;
use function addslashes;
use function implode;
use function strtolower;
use function substr;

/**
 * Class representing an edge (arrow, line).
 *
 * @link      http://phpdoc.org
 */
class Edge implements AttributesAwareInterface
{
    use AttributesAware;

    /** @var Node Node from where to link */
    private $from;

    /** @var Node Node where to to link */
    private $to;

    /** @var int The direction */
    private $directed;

  /**
   * Creates a new Edge / Link between the given nodes.
   *
   * @param Node $from Starting node to create an Edge from.
   * @param Node $to Destination node where to create and
   *  edge to.
   * @param int $direction
   *   0 means undirected, greater than 0 means from FROM to TO, smaller than 0
   *   means from TO to FROM.
   */
    public function __construct(Node $from, Node $to, int $direction = 1)
    {
        if ($direction >= 0) {
            $this->from = $from;
            $this->to = $to;
        }

        if ($direction < 0) {
            $this->from = $to;
            $this->to = $from;
        }

        $this->directed = ($direction ** 2) > 0;

The property $directed was declared of type integer, but $direction ** 2 > 0 is of type boolean. Maybe add a type cast?

    }

  /**
   * @return bool
   */
    public function isDirected(): bool
    {
        return $this->directed;
    }

  /**
   * Factory method used to assist with fluent interface handling.
   *
   * See the examples for more details.
   *
   * @param Node $from Starting node to create an Edge from.
   * @param Node $to Destination node where to create and
   *   edge to.
   * @param int $direction
   *   0 means undirected, greater than 0 means from FROM to TO, smaller than 0
   *   means from TO to FROM.
   *
   * @return \phpDocumentor\GraphViz\Edge
   */
    public static function create(Node $from, Node $to, int $direction = 1) : self
    {
        return new self($from, $to, $direction);
    }

  /**
   * @param \phpDocumentor\GraphViz\Node $from
   * @param \phpDocumentor\GraphViz\Node $to
   *
   * @return \phpDocumentor\GraphViz\Edge
   */
    public static function directed(Node $from, Node $to) : self
    {
        return new self($from, $to, 1);
    }

  /**
   * @param \phpDocumentor\GraphViz\Node $from
   * @param \phpDocumentor\GraphViz\Node $to
   *
   * @return \phpDocumentor\GraphViz\Edge
   */
    public static function undirected(Node $from, Node $to) : self
    {
        return new self($from, $to, 0);
    }

    /**
     * Returns the source Node for this Edge.
     */
    public function getFrom() : Node
    {
        return $this->from;
    }

    /**
     * Returns the destination Node for this Edge.
     */
    public function getTo() : Node
    {
        return $this->to;
    }

    /**
     * Magic method to provide a getter/setter to add attributes on the edge.
     *
     * Using this method we make sure that we support any attribute without too
     * much hassle. If the name for this method does not start with get or set
     * we return null.
     *
     * Set methods return this graph (fluent interface) whilst get methods
     * return the attribute value.
     *
     * @param string  $name      name of the invoked method, expect it to be
     *       setX or getX.
     * @param mixed[] $arguments Arguments for the setter, only 1 is expected: value
     *
     * @return Attribute|Edge|null
     *
     * @throws AttributeNotFound
     */
    public function __call(string $name, array $arguments)
    {
        $key = strtolower(substr($name, 3));

        if (stripos($name, 'set') === 0) {
            return $this->setAttribute($key, (string) $arguments[0]);
        }

        if (stripos($name, 'get') === 0) {
            return $this->getAttribute($key);
        }

        return null;
    }

    /**
     * Returns the edge definition as is requested by GraphViz.
     */
    public function __toString() : string
    {
        $attributes = [];
        foreach ($this->attributes as $value) {
            $attributes[] = (string) $value;
        }

        $attributes = implode("\n", $attributes);

        $from_name = addslashes($this->getFrom()->getName());
        $to_name   = addslashes($this->getTo()->getName());

        $direction = $this->isDirected() ?
          '->' :
          '--';

        return <<<DOT
"${from_name}" ${direction} "${to_name}" [
${attributes}
]
DOT;
    }
}