Component::setComponents() - Code Metrics - Inspection of "Introduce Component::setComponents method (#124)" - markuspoerschke/iCal - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 7dc19a...8d6915 )

by Markus

created 2019-01-11 15:53 UTC

Component::setComponents() A

↳ Parent: Component

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	3
CRAP Score	1

Importance

Changes

Metric	Value
dl	0
loc	6
ccs	3
cts	3
cp	1
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	1
crap	1

<?php

/*
 * This file is part of the eluceo/iCal package.
 *
 * (c) Markus Poerschke <[email protected]>
 *
 * This source file is subject to the MIT license that is bundled
 * with this source code in the file LICENSE.
 */

namespace Eluceo\iCal;

use Eluceo\iCal\Util\ComponentUtil;

/**
 * Abstract Calender Component.
 */
abstract class Component
{
    /**
     * Array of Components.
     *
     * @var Component[]
     */
    protected $components = [];

    /**
     * The order in which the components will be rendered during build.
     *
     * Not defined components will be appended at the end.
     *
     * @var array
     */
    private $componentsBuildOrder = ['VTIMEZONE', 'DAYLIGHT', 'STANDARD'];

    /**
     * The type of the concrete Component.
     *
     * @abstract
     *
     * @return string
     */
    abstract public function getType();

    /**
     * Building the PropertyBag.
     *
     * @abstract
     *
     * @return PropertyBag
     */
    abstract public function buildPropertyBag();

    /**
     * Adds a Component.
     *
     * If $key is given, the component at $key will be replaced else the component will be append.
     *
     * @param Component $component The Component that will be added
     * @param null      $key       The key of the Component
     */
    public function addComponent(self $component, $key = null)
    {
        if (null == $key) {
            $this->components[] = $component;
        } else {
            $this->components[$key] = $component;
        }
    }

    /**
     * Set all Components.
     *
     * @param Component[] $components The array of Component that will be set
     * @param null        $key        The key of the Component
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     */
    public function setComponents(array $components)
    {
        $this->components = $components;

        return $this;
    }

    /**
     * Renders an array containing the lines of the iCal file.
     *
     * @return array
     */
    public function build()
    {
        $lines = [];

        $lines[] = sprintf('BEGIN:%s', $this->getType());

        /** @var $property Property */
        foreach ($this->buildPropertyBag() as $property) {
            foreach ($property->toLines() as $l) {
                $lines[] = $l;
            }
        }

        $this->buildComponents($lines);

        $lines[] = sprintf('END:%s', $this->getType());

        $ret = [];

        foreach ($lines as $line) {
            foreach (ComponentUtil::fold($line) as $l) {
                $ret[] = $l;
            }
        }

        return $ret;
    }

    /**
     * Renders the output.
     *
     * @return string
     */
    public function render()
    {
        return implode("\r\n", $this->build());
    }

    /**
     * Renders the output when treating the class as a string.
     *
     * @return string
     */
    public function __toString()
    {
        return $this->render();
    }

    /**
     * @param $lines
     *
     * @return array
     */
    private function buildComponents(array &$lines)
    {
        $componentsByType = [];

        /** @var $component Component */
        foreach ($this->components as $component) {
            $type = $component->getType();
            if (!isset($componentsByType[$type])) {
                $componentsByType[$type] = [];
            }
            $componentsByType[$type][] = $component;
        }

        // render ordered components
        foreach ($this->componentsBuildOrder as $type) {
            if (!isset($componentsByType[$type])) {
                continue;
            }
            foreach ($componentsByType[$type] as $component) {
                $this->addComponentLines($lines, $component);
            }
            unset($componentsByType[$type]);
        }

        // render all other
        foreach ($componentsByType as $components) {
            foreach ($components as $component) {
                $this->addComponentLines($lines, $component);
            }
        }
    }

    /**
     * @param array     $lines
     * @param Component $component
     */
    private function addComponentLines(array &$lines, self $component)
    {
        foreach ($component->build() as $l) {
            $lines[] = $l;
        }
    }
}


1		<?php
2
3		/*
4		* This file is part of the eluceo/iCal package.
5		*
6		* (c) Markus Poerschke <[email protected]>
7		*
8		* This source file is subject to the MIT license that is bundled
9		* with this source code in the file LICENSE.
10		*/
11
12		namespace Eluceo\iCal;
13
14		use Eluceo\iCal\Util\ComponentUtil;
15
16		/**
17		* Abstract Calender Component.
18		*/
19		abstract class Component
20		{
21		/**
22		* Array of Components.
23		*
24		* @var Component[]
25		*/
26		protected $components = [];
27
28		/**
29		* The order in which the components will be rendered during build.
30		*
31		* Not defined components will be appended at the end.
32		*
33		* @var array
34		*/
35		private $componentsBuildOrder = ['VTIMEZONE', 'DAYLIGHT', 'STANDARD'];
36
37		/**
38		* The type of the concrete Component.
39		*
40		* @abstract
41		*
42		* @return string
43		*/
44		abstract public function getType();
45
46		/**
47		* Building the PropertyBag.
48		*
49		* @abstract
50		*
51		* @return PropertyBag
52		*/
53		abstract public function buildPropertyBag();
54
55		/**
56		* Adds a Component.
57		*
58		* If $key is given, the component at $key will be replaced else the component will be append.
59		*
60		* @param Component $component The Component that will be added
61		* @param null $key The key of the Component
62		*/
63	9	public function addComponent(self $component, $key = null)
64		{
65	9	if (null == $key) {
66	8	$this->components[] = $component;
67		} else {
68	1	$this->components[$key] = $component;
69		}
70	9	}
71
72		/**
73		* Set all Components.
74		*
75		* @param Component[] $components The array of Component that will be set
76		* @param null $key The key of the Component
		0 ignored issues – show Bug introduced 2018-12-17 22:35 UTC by Report Bug Copy Issue Report There is no parameter named `$key`. Was it maybe removed? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. Consider the following example. The parameter `$italy` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $island * @param array $italy */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was removed, but the annotation was not. Loading history...
77		*/
78	1	public function setComponents(array $components)
79		{
80	1	$this->components = $components;
81
82	1	return $this;
83		}
84
85		/**
86		* Renders an array containing the lines of the iCal file.
87		*
88		* @return array
89		*/
90	18	public function build()
91		{
92	18	$lines = [];
93
94	18	$lines[] = sprintf('BEGIN:%s', $this->getType());
95
96		/** @var $property Property */
97	18	foreach ($this->buildPropertyBag() as $property) {
98	18	foreach ($property->toLines() as $l) {
99	18	$lines[] = $l;
100		}
101		}
102
103	18	$this->buildComponents($lines);
104
105	18	$lines[] = sprintf('END:%s', $this->getType());
106
107	18	$ret = [];
108
109	18	foreach ($lines as $line) {
110	18	foreach (ComponentUtil::fold($line) as $l) {
111	18	$ret[] = $l;
112		}
113		}
114
115	18	return $ret;
116		}
117
118		/**
119		* Renders the output.
120		*
121		* @return string
122		*/
123	18	public function render()
124		{
125	18	return implode("\r\n", $this->build());
126		}
127
128		/**
129		* Renders the output when treating the class as a string.
130		*
131		* @return string
132		*/
133	1	public function __toString()
134		{
135	1	return $this->render();
136		}
137
138		/**
139		* @param $lines
140		*
141		* @return array
142		*/
143	18	private function buildComponents(array &$lines)
144		{
145	18	$componentsByType = [];
146
147		/** @var $component Component */
148	18	foreach ($this->components as $component) {
149	9	$type = $component->getType();
150	9	if (!isset($componentsByType[$type])) {
151	9	$componentsByType[$type] = [];
152		}
153	9	$componentsByType[$type][] = $component;
154		}
155
156		// render ordered components
157	18	foreach ($this->componentsBuildOrder as $type) {
158	18	if (!isset($componentsByType[$type])) {
159	18	continue;
160		}
161	2	foreach ($componentsByType[$type] as $component) {
162	2	$this->addComponentLines($lines, $component);
163		}
164	2	unset($componentsByType[$type]);
165		}
166
167		// render all other
168	18	foreach ($componentsByType as $components) {
169	7	foreach ($components as $component) {
170	7	$this->addComponentLines($lines, $component);
171		}
172		}
173	18	}
174
175		/**
176		* @param array $lines
177		* @param Component $component
178		*/
179	9	private function addComponentLines(array &$lines, self $component)
180		{
181	9	foreach ($component->build() as $l) {
182	9	$lines[] = $l;
183		}
184	9	}
185		}
186

markuspoerschke / iCal

Push — master ( 7dc19a...8d6915 )

Component::setComponents() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like