CompositionCollection::addComposition() - Code Metrics - tonicospinelli/class-generation - Measure and Improve Code Quality continuously with Scrutinizer

CompositionCollection::addComposition() A
last analyzed 2016-01-09 01:36 UTC

↳ Parent: CompositionCollection

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes	1
Bugs	0	Features	0

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

<?php

/*
 * This file is part of the ClassGeneration package.
 *
 * (c) Antonio Spinelli <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace ClassGeneration;

use ClassGeneration\Collection\ArrayCollection;
use ClassGeneration\Composition\MethodCollection as CompositionMethodCollection;
use ClassGeneration\Composition\MethodInterface as CompositionMethodInterface;
use ClassGeneration\Element\Tabbable;

/**
 * Property Collection ClassGeneration
 * @author Antonio Spinelli <[email protected]>
 */
class CompositionCollection extends ArrayCollection implements Tabbable
{
    /**
     * Tabulation Identity.
     * @var int
     */
    protected $tabulation;

    /**
     * @var CompositionMethodCollection
     */
    protected $methods;

    /**
     * Initializes a new ArrayCollection.
     *
     * @param array $elements
     */
    public function __construct(array $elements = array())
    {
        $this->setTabulation(4);
        $this->elements = $elements;
        $this->methods = new CompositionMethodCollection();
    }

    /**
     * {@inheritdoc}
     */
    public function getTabulation()
    {
        return $this->tabulation;
    }

    /**
     * {@inheritdoc}
     */
    public function getTabulationFormatted()
    {
        return str_repeat(' ', $this->getTabulation());
    }

    /**
     * @inheritdoc
     */
    public function setTabulation($tabulation)
    {
        $this->tabulation = (int)$tabulation;

        return $this;
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

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

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
    }

    /**
     * Adds a new Composition at CompositionCollection.
     *
     * @param string $composition
     *
     * @return bool
     */
    public function add($composition)
    {
        if(!$this->contains($composition)){

            parent::add($composition);
        }
        return true;
    }

    /**
     * @param CompositionMethodInterface $method
     * @return bool
     */
    public function addMethod(CompositionMethodInterface $method)
    {
        $this->addComposition($method->getTraitName());
        return $this->getMethods()->add($method);
    }

    /**
     * @return CompositionMethodCollection
     */
    public function getMethods()
    {
        return $this->methods;
    }

    /**
     * @param CompositionMethodCollection $methods
     * @return CompositionCollection
     */
    public function setMethods(CompositionMethodCollection $methods)
    {
        $this->methods = $methods;
        return $this;
    }

    /**
     * @param string $composition
     * @return bool
     */
    public function addComposition($composition)
    {
        return $this->add($composition);
    }

    /**
     * Parse the Composition Collection to string.
     * @return string
     */
    public function toString()
    {
        if ($this->isEmpty()) {
            return '';
        }

        $traitNames = $this->toArray();
        $tabulationFormatted = $this->getTabulationFormatted();

        $compositionMethods = ';' . PHP_EOL;
        if (!$this->getMethods()->isEmpty()) {
            $compositionMethods = ' ' . $this->getMethods()->toString();
        }

        return $tabulationFormatted . 'use ' . implode(', ', $traitNames) . $compositionMethods;
    }
}


1		<?php
2
3		/*
4		* This file is part of the ClassGeneration package.
5		*
6		* (c) Antonio Spinelli <[email protected]>
7		*
8		* For the full copyright and license information, please view the LICENSE
9		* file that was distributed with this source code.
10		*/
11
12		namespace ClassGeneration;
13
14		use ClassGeneration\Collection\ArrayCollection;
15		use ClassGeneration\Composition\MethodCollection as CompositionMethodCollection;
16		use ClassGeneration\Composition\MethodInterface as CompositionMethodInterface;
17		use ClassGeneration\Element\Tabbable;
18
19		/**
20		* Property Collection ClassGeneration
21		* @author Antonio Spinelli <[email protected]>
22		*/
23		class CompositionCollection extends ArrayCollection implements Tabbable
24		{
25		/**
26		* Tabulation Identity.
27		* @var int
28		*/
29		protected $tabulation;
30
31		/**
32		* @var CompositionMethodCollection
33		*/
34		protected $methods;
35
36		/**
37		* Initializes a new ArrayCollection.
38		*
39		* @param array $elements
40		*/
41	42	public function __construct(array $elements = array())
42		{
43	42	$this->setTabulation(4);
44	42	$this->elements = $elements;
45	42	$this->methods = new CompositionMethodCollection();
46	42	}
47
48		/**
49		* {@inheritdoc}
50		*/
51	6	public function getTabulation()
52		{
53	6	return $this->tabulation;
54		}
55
56		/**
57		* {@inheritdoc}
58		*/
59	6	public function getTabulationFormatted()
60		{
61	6	return str_repeat(' ', $this->getTabulation());
62		}
63
64		/**
65		* @inheritdoc
66		*/
67	42	public function setTabulation($tabulation)
68		{
69	42	$this->tabulation = (int)$tabulation;
70
71	42	return $this;
		0 ignored issues – show Bug Best Practice introduced 2016-01-09 01:28 UTC by Report Bug Copy Issue Report The return type of `return $this;` (`ClassGeneration\CompositionCollection`) is incompatible with the return type declared by the interface `ClassGeneration\Element\Tabbable::setTabulation` of type `ClassGeneration\Element\ElementAbstract`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: class Author { private $name; public function __construct($name) { $this->name = $name; } public function getName() { return $this->name; } } abstract class Post { public function getAuthor() { return 'Johannes'; } } class BlogPost extends Post { public function getAuthor() { return new Author('Johannes'); } } class ForumPost extends Post { /* ... */ } function my_function(Post $post) { echo strtoupper($post->getAuthor()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history...
72		}
73
74		/**
75		* Adds a new Composition at CompositionCollection.
76		*
77		* @param string $composition
78		*
79		* @return bool
80		*/
81	8	public function add($composition)
82		{
83	8	if(!$this->contains($composition)){
		0 ignored issues – show Coding Style introduced 2016-01-09 01:28 UTC by Report Bug Copy Issue Report Expected 1 space after IF keyword; 0 found Loading history...
84	8	parent::add($composition);
85	8	}
86	8	return true;
87		}
88
89		/**
90		* @param CompositionMethodInterface $method
91		* @return bool
92		*/
93	5	public function addMethod(CompositionMethodInterface $method)
94		{
95	5	$this->addComposition($method->getTraitName());
96	5	return $this->getMethods()->add($method);
97		}
98
99		/**
100		* @return CompositionMethodCollection
101		*/
102	7	public function getMethods()
103		{
104	7	return $this->methods;
105		}
106
107		/**
108		* @param CompositionMethodCollection $methods
109		* @return CompositionCollection
110		*/
111	1	public function setMethods(CompositionMethodCollection $methods)
112		{
113	1	$this->methods = $methods;
114	1	return $this;
115		}
116
117		/**
118		* @param string $composition
119		* @return bool
120		*/
121	6	public function addComposition($composition)
122		{
123	6	return $this->add($composition);
124		}
125
126		/**
127		* Parse the Composition Collection to string.
128		* @return string
129		*/
130	13	public function toString()
131		{
132	13	if ($this->isEmpty()) {
133	7	return '';
134		}
135
136	6	$traitNames = $this->toArray();
137	6	$tabulationFormatted = $this->getTabulationFormatted();
138
139	6	$compositionMethods = ';' . PHP_EOL;
140	6	if (!$this->getMethods()->isEmpty()) {
141	4	$compositionMethods = ' ' . $this->getMethods()->toString();
142	4	}
143
144	6	return $tabulationFormatted . 'use ' . implode(', ', $traitNames) . $compositionMethods;
145		}
146		}
147

tonicospinelli / class-generation

CompositionCollection::addComposition() A last analyzed 2016-01-09 01:36 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

CompositionCollection::addComposition() A
last analyzed 2016-01-09 01:36 UTC