Naneau\FileGen\Node

Complexity

Total Complexity

8

Size/Duplication

Total Lines	100
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Importance

Changes

0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	getName()	0	4	1
A	setName()	0	6	1
A	getFullName()	0	10	2
A	getParent()	0	4	1
A	setParent()	0	6	1
A	hasParent()	0	4	1

<?php
namespace Naneau\FileGen;

/**
 * A node to be created
 */
class Node
{
    /**
     * Name of the node
     *
     * @var string
     **/
    private $name;

    /**
     * Parent node
     *
     * @var Node
     **/
    private $parent;

    /**
     * Constructor
     *
     * @param  string $name
     * @return void

Adding a @return annotation to constructors is generally not recommended as a constructor does not have a meaningful return value.

     **/
    public function __construct($name)
    {
        $this->setName($name);
    }

    /**
     * Get the name of the node
     *
     * @return string
     */
    public function getName()
    {
        return $this->name;
    }

    /**
     * Set the name of the node
     *
     * @param  string $name
     * @return Node
     */
    public function setName($name)
    {
        $this->name = $name;

        return $this;
    }

    /**
     * Get the name including that of the parent's
     *
     * @param  string $separator
     * @return string
     **/
    public function getFullName($separator = DIRECTORY_SEPARATOR)
    {
        if ($this->hasParent()) {
            return $this->getParent()->getFullName($separator)
                . $separator
                . $this->getName();
        }

        return $this->getName();
    }

    /**
     * Get the parent node
     *
     * @return Node
     */
    public function getParent()
    {
        return $this->parent;
    }

    /**
     * Set the parent node
     *
     * @param  Node $parent
     * @return Node
     */
    public function setParent(Node $parent)
    {
        $this->parent = $parent;

        return $this;
    }

    /**
     * Does this node have a parent?
     *
     * @return bool
     **/
    public function hasParent()
    {
        return !empty($this->parent);
    }
}