layoutRow::setPosition() - Code Metrics - Inspection of "Scrollables" - eXpansionPluginPack/eXpansion2 - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#100)

unknown

created 2017-07-28 17:57 UTC

layoutRow::setPosition() A

↳ Parent: layoutRow

Complexity

Conditions	1
Paths	1

Size

Total Lines	5
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

Metric	Value
c	0
b	0
f	0
dl	0
loc	5
rs	9.4285
ccs	0
cts	5
cp	0
cc	1
eloc	3
nc	1
nop	2
crap	2

<?php

namespace eXpansion\Framework\Gui\Layouts;

use FML\Controls\Control;
use FML\Controls\Frame;
use FML\Controls\Quad;
use FML\Elements\Format;
use FML\Script\Features\ScriptFeature;
use FML\Types\Container;
use FML\Types\Renderable;
use FML\Types\ScriptFeatureable;

class layoutRow implements Renderable, ScriptFeatureable, Container
{

    protected $frameClasses = [];
    /**
     * @var float|int
     */
    protected $height = 0;
    /**
     * @var float|int
     */
    protected $width = 0;

    /** @var Control[] */
    protected $elements = [];

    /**
     * @var float|int
     */
    protected $margin = 1;

    /**
     * @var float|int
     */
    protected $startX;

    /**
     * @var float|int
     */
    protected $startY;

    /**
     * layoutLine constructor.
     * @param float $startX
     * @param float $startY
     * @param object[] $elements
     * @param int $margin
     * @throws \Exception
     */
    public function __construct($startX, $startY, $elements = [], $margin = 0)
    {
        if (!is_array($elements)) {
            throw new \Exception('not an array');
        }

        $this->margin = $margin;
        $this->elements = $elements;
        $this->setPosition($startX, $startY);
        $this->updateSize();
    }

    protected function updateSize() {
        $sizeX = 0;
        $sizeY= 0;
        foreach ($this->elements as $idx => $element) {
            $sizeY += $element->getY() + $element->getHeight() + $this->margin;

            if (abs($element->getX()) + $element->getWidth() > $sizeX) {
                $sizeX = abs($element->getX()) + $element->getWidth();
            }
        }
        $this->setSize($sizeX, $sizeY);
    }

    public function setPosition($x, $y)
    {
        $this->startX = $x;
        $this->startY = $y;
    }

    /**
     * @param mixed $startX
     * @return
     */
    public function setX($startX)
    {
        $this->startX = $startX;

        return $this;
    }

    /**
     * @param mixed $startY
     * @return
     */
    public function setY($startY)
    {
        $this->startY = $startY;

        return $this;
    }


    /**
     * Render the XML element
     *
     * @param \DOMDocument $domDocument DOMDocument for which the XML element should be rendered
     * @return \DOMElement
     */
    public function render(\DOMDocument $domDocument)
    {
        $frame = new Frame();
        $frame->setPosition($this->startX, $this->startY);
        $frame->addClasses($this->frameClasses);

        $startY = 0;

        foreach ($this->elements as $idx => $element) {
            $pos = $element->getY();
            $element->setY($startY + $pos);
            $startY -= $pos + $element->getHeight() + $this->margin;
            $frame->addChild($element);
        }

        $frame->setSize($this->getWidth(), $this->getHeight());
        return $frame->render($domDocument);
    }

    /**
     * Get the Script Features
     *
     * @return ScriptFeature[]
     */
    public function getScriptFeatures()

    {
        $features = [];
        foreach ($this->elements as $element) {
            if ($element instanceof ScriptFeatureable) {
                $features[] = $element->getScriptFeatures();
            }
        }
        return ScriptFeature::collect($features);
    }

    /**
     * @return mixed
     */
    public function getX()
    {
        return $this->startX;
    }

    /**
     * @return mixed
     */
    public function getY()
    {
        return $this->startY;
    }

    /**
     * @return float
     */
    public function getHeight()
    {
        return $this->height;
    }

    /**
     * @param float $height
     */
    public function setHeight($height)
    {
        $this->height = $height;
    }

    /**
     * @param float $width
     * @return layoutRow
     */
    public function setWidth($width)
    {
        $this->width = $width;

        return $this;
    }

    /**
     * @return float|int
     */
    public function getWidth()
    {
        return $this->width;
    }

    /**
     * @param Renderable $element
     */
    public function addChild(Renderable $element)
    {
        $this->elements[] = $element;
        $this->updateSize();
    }

    public function getChildren()
    {
        return $this->elements;
    }


    public function addClass($class)
    {
        $this->frameClasses[] = $class;
    }

    /**
     * Add a new child
     *
     * @api
     * @param Renderable $child Child Control to add
     * @return static
     * @deprecated Use addChild()
     * @see        Container::addChild()
     */
    public function add(Renderable $child)
    {
        // TODO: Implement add() method.
    }

    /**
     * Add new children
     *
     * @api
     * @param Renderable[] $children Child Controls to add
     * @return static
     */
    public function addChildren(array $children)
    {
        // TODO: Implement addChildren() method.
    }

    /**
     * Remove all children
     *
     * @api
     * @return static
     */
    public function removeAllChildren()
    {
        // TODO: Implement removeAllChildren() method.
    }

    /**
     * Remove all children
     *
     * @api
     * @return static
     * @deprecated Use removeAllChildren()
     * @see        Container::removeAllChildren()
     */
    public function removeChildren()
    {
        // TODO: Implement removeChildren() method.
    }

    /**
     * Get the Format
     *
     * @api
     * @param bool $createIfEmpty If the format should be created if it doesn't exist yet
     * @return Format
     * @deprecated Use Style
     * @see        Style
     */
    public function getFormat($createIfEmpty = true)
    {
        // TODO: Implement getFormat() method.
    }

    /**
     * Set the Format
     *
     * @api
     * @param Format $format New Format
     * @return static
     * @deprecated Use Style
     * @see        Style
     */
    public function setFormat(Format $format = null)
    {
        // TODO: Implement setFormat() method.
    }

    private function setSize($sizeX, $sizeY)
    {
        $this->width = $sizeX;
        $this->height = $sizeY;
    }
}


1		<?php
2
3		namespace eXpansion\Framework\Gui\Layouts;
4
5		use FML\Controls\Control;
6		use FML\Controls\Frame;
7		use FML\Controls\Quad;
8		use FML\Elements\Format;
9		use FML\Script\Features\ScriptFeature;
10		use FML\Types\Container;
11		use FML\Types\Renderable;
12		use FML\Types\ScriptFeatureable;
13
14		class layoutRow implements Renderable, ScriptFeatureable, Container
15		{
16
17		protected $frameClasses = [];
18		/**
19		* @var float\|int
20		*/
21		protected $height = 0;
22		/**
23		* @var float\|int
24		*/
25		protected $width = 0;
26
27		/** @var Control[] */
28		protected $elements = [];
29
30		/**
31		* @var float\|int
32		*/
33		protected $margin = 1;
34
35		/**
36		* @var float\|int
37		*/
38		protected $startX;
39
40		/**
41		* @var float\|int
42		*/
43		protected $startY;
44
45		/**
46		* layoutLine constructor.
47		* @param float $startX
48		* @param float $startY
49		* @param object[] $elements
50		* @param int $margin
51		* @throws \Exception
52		*/
53		public function __construct($startX, $startY, $elements = [], $margin = 0)
54		{
55		if (!is_array($elements)) {
56		throw new \Exception('not an array');
57		}
58
59		$this->margin = $margin;
60		$this->elements = $elements;
61		$this->setPosition($startX, $startY);
62		$this->updateSize();
63		}
64
65		protected function updateSize() {
66		$sizeX = 0;
67		$sizeY= 0;
68		foreach ($this->elements as $idx => $element) {
69		$sizeY += $element->getY() + $element->getHeight() + $this->margin;
70
71		if (abs($element->getX()) + $element->getWidth() > $sizeX) {
72		$sizeX = abs($element->getX()) + $element->getWidth();
73		}
74		}
75		$this->setSize($sizeX, $sizeY);
76		}
77
78		public function setPosition($x, $y)
79		{
80		$this->startX = $x;
81		$this->startY = $y;
82		}
83
84		/**
85		* @param mixed $startX
86		* @return
87		*/
88		public function setX($startX)
89		{
90		$this->startX = $startX;
91
92		return $this;
93		}
94
95		/**
96		* @param mixed $startY
97		* @return
98		*/
99		public function setY($startY)
100		{
101		$this->startY = $startY;
102
103		return $this;
104		}
105
106
107		/**
108		* Render the XML element
109		*
110		* @param \DOMDocument $domDocument DOMDocument for which the XML element should be rendered
111		* @return \DOMElement
112		*/
113		public function render(\DOMDocument $domDocument)
114		{
115		$frame = new Frame();
116		$frame->setPosition($this->startX, $this->startY);
117		$frame->addClasses($this->frameClasses);
118
119		$startY = 0;
120
121		foreach ($this->elements as $idx => $element) {
122		$pos = $element->getY();
123		$element->setY($startY + $pos);
124		$startY -= $pos + $element->getHeight() + $this->margin;
125		$frame->addChild($element);
126		}
127
128		$frame->setSize($this->getWidth(), $this->getHeight());
129		return $frame->render($domDocument);
130		}
131
132		/**
133		* Get the Script Features
134		*
135		* @return ScriptFeature[]
136		*/
137	View Code Duplication	public function getScriptFeatures()
		0 ignored issues – show Duplication introduced 2017-07-28 18:00 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
138		{
139		$features = [];
140		foreach ($this->elements as $element) {
141		if ($element instanceof ScriptFeatureable) {
142		$features[] = $element->getScriptFeatures();
143		}
144		}
145		return ScriptFeature::collect($features);
146		}
147
148		/**
149		* @return mixed
150		*/
151		public function getX()
152		{
153		return $this->startX;
154		}
155
156		/**
157		* @return mixed
158		*/
159		public function getY()
160		{
161		return $this->startY;
162		}
163
164		/**
165		* @return float
166		*/
167		public function getHeight()
168		{
169		return $this->height;
170		}
171
172		/**
173		* @param float $height
174		*/
175		public function setHeight($height)
176		{
177		$this->height = $height;
178		}
179
180		/**
181		* @param float $width
182		* @return layoutRow
183		*/
184		public function setWidth($width)
185		{
186		$this->width = $width;
187
188		return $this;
189		}
190
191		/**
192		* @return float\|int
193		*/
194		public function getWidth()
195		{
196		return $this->width;
197		}
198
199		/**
200		* @param Renderable $element
201		*/
202		public function addChild(Renderable $element)
203		{
204		$this->elements[] = $element;
205		$this->updateSize();
206		}
207
208		public function getChildren()
209		{
210		return $this->elements;
211		}
212
213
214		public function addClass($class)
215		{
216		$this->frameClasses[] = $class;
217		}
218
219		/**
220		* Add a new child
221		*
222		* @api
223		* @param Renderable $child Child Control to add
224		* @return static
225		* @deprecated Use addChild()
226		* @see Container::addChild()
227		*/
228		public function add(Renderable $child)
229		{
230		// TODO: Implement add() method.
231		}
232
233		/**
234		* Add new children
235		*
236		* @api
237		* @param Renderable[] $children Child Controls to add
238		* @return static
239		*/
240		public function addChildren(array $children)
241		{
242		// TODO: Implement addChildren() method.
243		}
244
245		/**
246		* Remove all children
247		*
248		* @api
249		* @return static
250		*/
251		public function removeAllChildren()
252		{
253		// TODO: Implement removeAllChildren() method.
254		}
255
256		/**
257		* Remove all children
258		*
259		* @api
260		* @return static
261		* @deprecated Use removeAllChildren()
262		* @see Container::removeAllChildren()
263		*/
264		public function removeChildren()
265		{
266		// TODO: Implement removeChildren() method.
267		}
268
269		/**
270		* Get the Format
271		*
272		* @api
273		* @param bool $createIfEmpty If the format should be created if it doesn't exist yet
274		* @return Format
275		* @deprecated Use Style
276		* @see Style
277		*/
278		public function getFormat($createIfEmpty = true)
279		{
280		// TODO: Implement getFormat() method.
281		}
282
283		/**
284		* Set the Format
285		*
286		* @api
287		* @param Format $format New Format
288		* @return static
289		* @deprecated Use Style
290		* @see Style
291		*/
292		public function setFormat(Format $format = null)
293		{
294		// TODO: Implement setFormat() method.
295		}
296
297		private function setSize($sizeX, $sizeY)
298		{
299		$this->width = $sizeX;
300		$this->height = $sizeY;
301		}
302		}
303

eXpansionPluginPack / eXpansion2

Pull Request — master (#100)

layoutRow::setPosition() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like