Node::getName() - Code Metrics - Inspection of "Add Category support to entities." - cross-solution/YAWIK - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — develop (#323)

by Mathias

created 2016-12-23 18:07 UTC

Node::getName() A

↳ Parent: Node

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	4
rs	10
c	0
b	0
f	0
cc	1
eloc	2
nc	1
nop	0

<?php
/**
 * YAWIK
 *
 * @filesource
 * @license MIT
 * @copyright  2013 - 2016 Cross Solution <http://cross-solution.de>
 */
  
/** */
namespace Core\Entity\Tree;

use Core\Entity\Collection\ArrayCollection;
use Core\Entity\EntityTrait;
use Core\Entity\IdentifiableEntityTrait;
use Doctrine\Common\Collections\Collection;
use \Doctrine\ODM\MongoDB\Mapping\Annotations as ODM;

/**
 * base class for trees.
 *
 * @ODM\MappedSuperclass
 * @author Mathias Gelhausen <[email protected]>
 * @since 0.29
 */
class Node implements NodeInterface
{
    use EntityTrait, IdentifiableEntityTrait;

    /**
     * Name of this item.
     *
     * @ODM\Field(type="string")
     * @var string
     */
    protected $name;

    /**
     * Value of this item.
     *
     * Used in select form elements.
     *
     * @ODM\Field(type="string")
     * @var string
     */
    protected $value;

    /**
     * Order priority.
     *
     * @ODM\Field(type="int")
     * @var int
     */
    protected $priority = 0;

    /**
     * Child nodes.
     *
     * @ODM\ReferenceMany(discriminatorField="_entity", storeAs="dbRef", strategy="set", sort={"priority"="asc"}, cascade="all", orphanRemoval="true")
     * @var Collection
     */
    protected $children;

    /**
     * Parent node.
     *
     * @ODM\ReferenceOne(discriminatorField="_entity", storeAs="dbRef", nullable="true")
     * @var
     */
    protected $parent;

    /**
     * Creates a new Tree item.
     *
     * @param null|string $name
     * @param null|string $value
     * @param int  $priority
     */
    public function __construct($name = null, $value = null, $priority = 0)
    {
        if (null !== $name) {
            $this->setName($name);
            $this->setValue($value);
            $this->setPriority($priority);
        }
    }

    /**
     * Set the name.
     *
     * @param string $name
     *
     * @return self
     * @throws \InvalidArgumentException if $name is empty.
     */
    public function setName($name)
    {
        if (!$name) {
            throw new \InvalidArgumentException('Name must not be empty.');
        }

        $this->name = (string) $name;

        return $this;
    }

    public function getName()
    {
        return $this->name;
    }

    /**
     * Set the value.
     *
     * Used in form selects.
     *
     * @param string $value
     *
     * @return self
     * @throws \InvalidArgumentException if $value AND {@link name} are empty.
     */
    public function setValue($value)
    {
        if (!$value) {
            if (!$this->getName()) {
                throw new \InvalidArgumentException('Value must not be empty.');
            }
            $value = strtolower(str_replace(' ', '-', $this->getName()));
        }

        $this->value = (string) $value;

        return $this;
    }

    public function getValue()
    {
        if (!$this->value) {
            $this->setValue(null);
        }

        return $this->value;
    }

    public function setPriority($priority)
    {
        $this->priority = (int) $priority;

        return $this;
    }

    public function getPriority()
    {
        return $this->priority;
    }

    public function setChildren(Collection $children)
    {
        $this->children = $children;

        /* @var NodeInterface $child */
        foreach ($children as $child) {
            $child->setParent($this);
        }

        return $this;
    }

    public function getChildren()
    {
        if (!$this->children) {
            $this->setChildren(new ArrayCollection());
        }

        return $this->children;
    }

    public function hasChildren()
    {
        return (bool) $this->getChildren()->count();
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
    }

    public function addChild(NodeInterface $child)
    {
        $this->getChildren()->add($child);
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
        $child->setParent($this);

        return $this;
    }

    public function removeChild(NodeInterface $child)
    {
        $this->getChildren()->removeElement($child);
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}

        return $this;
    }

    public function clearChildren()
    {
        $this->getChildren()->clear();
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}

        return $this;
    }

    public function setParent(NodeInterface $parent)
    {
        $this->parent = $parent;

        return $this;
    }

    public function getParent()
    {
        return $this->parent;
    }
}

Pull Request — develop (#323)

Node::getName() A

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

Available Fixes

Available Fixes

1			<?php
2			/**
3			* YAWIK
4			*
5			* @filesource
6			* @license MIT
7			* @copyright 2013 - 2016 Cross Solution <http://cross-solution.de>
8			*/
9
10			/** */
11			namespace Core\Entity\Tree;
12
13			use Core\Entity\Collection\ArrayCollection;
14			use Core\Entity\EntityTrait;
15			use Core\Entity\IdentifiableEntityTrait;
16			use Doctrine\Common\Collections\Collection;
17			use \Doctrine\ODM\MongoDB\Mapping\Annotations as ODM;
18
19			/**
20			* base class for trees.
21			*
22			* @ODM\MappedSuperclass
23			* @author Mathias Gelhausen <[email protected]>
24			* @since 0.29
25			*/
26			class Node implements NodeInterface
27			{
28			use EntityTrait, IdentifiableEntityTrait;
29
30			/**
31			* Name of this item.
32			*
33			* @ODM\Field(type="string")
34			* @var string
35			*/
36			protected $name;
37
38			/**
39			* Value of this item.
40			*

cross-solution / YAWIK

Pull Request — develop (#323)

Node::getName() A

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like