ItemGroup::add() - Code Metrics - clippings/fluid-gallery - Measure and Improve Code Quality continuously with Scrutinizer

ItemGroup::add() A
last analyzed 2020-02-11 10:35 UTC

↳ Parent: ItemGroup

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	3
CRAP Score	1

Importance

Changes

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

<?php

namespace CL\FluidGallery;

use ArrayObject;
use Closure;

/**
 * @author    Ivan Kerin <[email protected]>
 * @copyright 2015, Clippings Ltd.
 * @license   http://spdx.org/licenses/BSD-3-Clause
 */
class ItemGroup extends ArrayObject {

    private $margin;

    /**
     * @param Item[] $items
     * @param float  $margin
     */
    public function __construct(array $items, $margin = 0)
    {
        foreach ($items as $item) {
            $this->add($item);
        }

        $this->margin = $margin;
    }

    /**
     * Get the margin
     * @return float
     */
    public function getMargin()
    {
        return $this->margin;
    }

    /**
     * Get the margin as a percentage of total
     * @param  float $total
     * @return float
     */
    public function getMarginPercent($total)
    {
        return ($this->margin / $total) * 100;
    }

    /**
     * Change the margin
     * @param float $margin
     */
    public function setMargin($margin)
    {
        $this->margin = $margin;

        return $this;
    }

    /**
     * Add item
     * @param Item $item
     */
    public function add(Item $item)
    {
        $this->append($item);
    }

    /**
     * Extract an ItemGroup, removing all the items from the parent ItemGroup
     * @param  Closure $extract
     * @return ItemGroup
     */
    public function extract(Closure $extract)
    {
        $array = $this->getArrayCopy();

        $extracted = $extract(new ItemGroup($array, $this->margin));

        $this->exchangeArray(array_diff($array, $extracted->getArrayCopy()));

        return $extracted;
    }

    /**
     * Set all widths, keeping aspect ratios
     * @param integer $width
     */
    public function setWidth($width)
    {
        foreach ($this as $item) {
            $item->setWidth($width);
        }

        return $this;
    }

    /**
     * Set all hights, keeping aspect ratios
     * @param integer $height
     */
    public function setHeight($height)
    {
        foreach ($this as $item) {
            $item->setHeight($height);
        }

        return $this;
    }

    /**
     * Multiple the width/height of all the items by $scale
     * @param float $scale
     */
    public function setScale($scale)
    {
        foreach ($this as $item) {
            $item->setWidth($item->getWidth() * $scale);
        }

        return $this;
    }

    /**
     * Return a new ItemGroup with items, filtered by the Closure
     * @param  Closure $filter
     * @return ItemGroup
     */
    public function filter(Closure $filter)
    {
        return new ItemGroup(array_filter($this->getArrayCopy(), $filter), $this->margin);
    }

    /**
     * Return a new ItemGroup with items, sliced by the $offcet and $limit
     * @param  Closure $filter
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     * @return ItemGroup
     */
    public function slice($offset, $limit)
    {
        return new ItemGroup(array_slice($this->getArrayCopy(), $offset, $limit), $this->margin);
    }

    /**
     * Scale all of the widths of the items to match an overall width, respecting margins
     * @param  float $width
     * @return ItemGroup
     */
    public function scaleToWidth($width)
    {
        $items = clone $this;
        $widthWithoutMargins = $width - $items->getGaps() * $this->margin;
        $sumWidths = $items->sumWidths();

        if ($sumWidths and $sumWidths < $widthWithoutMargins) {
            $difference = $widthWithoutMargins / $sumWidths;
            $items->setScale($difference);
        }

        return $items;
    }

    /**
     * Scale all of the widths of the items to match an overall height, respecting margins
     * @param  float $height
     * @return ItemGroup
     */
    public function scaleToHeight($height)
    {
        $items = clone $this;
        $heightWithoutMargins = $height - $items->getGaps() * $this->margin;
        $sumHeights = $items->sumHeights();

        if ($sumHeights and $sumHeights < $heightWithoutMargins) {
            $difference = $heightWithoutMargins / $sumHeights;
            $items->setScale($difference);
        }

        return $items;
    }

    /**
     * Remove all items that fall outside of width, when aligned horizontally, spaced by $margin
     * @param  integer $width
     * @param  integer $margin
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     */
    public function horizontalSlice($width)
    {
        $current = 0;

        return $this
            ->filter(function(Item $item) use ($width, &$current) {
                $current += $item->getWidth() + $this->margin;

                return $current <= ($width + $this->margin);
            });
    }

    /**
     * Remove all items that fall outside of height, when aligned horizontally, spaced by $margin
     * @param  integer $height
     * @param  integer $margin
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     */
    public function verticalSlice($height)
    {
        $current = 0;

        return $this->filter(function(Item $item) use ($height, &$current) {
            $current += $item->getHeight() + $this->margin;

            return $current <= ($height + $this->margin);
        });
    }

    /**
     * @return integer
     */
    public function getGaps()
    {
        return max(count($this) - 1, 0);
    }

    /**
     * @return float
     */
    public function getWidth()
    {
        return $this->sumWidths() + $this->getGaps() * $this->margin;
    }

    /**
     * @return float
     */
    public function getHeight()
    {
        return $this->sumHeights() + $this->getGaps() * $this->margin;
    }

    /**
     * @return float
     */
    public function sumWidths()
    {
        return array_sum(array_map(function(Item $item) {
            return $item->getWidth();
        }, $this->getArrayCopy()));
    }

    /**
     * @return float
     */
    public function sumHeights()
    {
        return array_sum(array_map(function(Item $item) {
            return $item->getHeight();
        }, $this->getArrayCopy()));
    }
}


1		<?php
2
3		namespace CL\FluidGallery;
4
5		use ArrayObject;
6		use Closure;
7
8		/**
9		* @author Ivan Kerin <[email protected]>
10		* @copyright 2015, Clippings Ltd.
11		* @license http://spdx.org/licenses/BSD-3-Clause
12		*/
13		class ItemGroup extends ArrayObject {
14
15		private $margin;
16
17		/**
18		* @param Item[] $items
19		* @param float $margin
20		*/
21	1	public function __construct(array $items, $margin = 0)
22		{
23	1	foreach ($items as $item) {
24	1	$this->add($item);
25		}
26
27	1	$this->margin = $margin;
28	1	}
29
30		/**
31		* Get the margin
32		* @return float
33		*/
34	1	public function getMargin()
35		{
36	1	return $this->margin;
37		}
38
39		/**
40		* Get the margin as a percentage of total
41		* @param float $total
42		* @return float
43		*/
44	1	public function getMarginPercent($total)
45		{
46	1	return ($this->margin / $total) * 100;
47		}
48
49		/**
50		* Change the margin
51		* @param float $margin
52		*/
53	1	public function setMargin($margin)
54		{
55	1	$this->margin = $margin;
56
57	1	return $this;
58		}
59
60		/**
61		* Add item
62		* @param Item $item
63		*/
64	1	public function add(Item $item)
65		{
66	1	$this->append($item);
67	1	}
68
69		/**
70		* Extract an ItemGroup, removing all the items from the parent ItemGroup
71		* @param Closure $extract
72		* @return ItemGroup
73		*/
74	1	public function extract(Closure $extract)
75		{
76	1	$array = $this->getArrayCopy();
77
78	1	$extracted = $extract(new ItemGroup($array, $this->margin));
79
80	1	$this->exchangeArray(array_diff($array, $extracted->getArrayCopy()));
81
82	1	return $extracted;
83		}
84
85		/**
86		* Set all widths, keeping aspect ratios
87		* @param integer $width
88		*/
89	1	public function setWidth($width)
90		{
91	1	foreach ($this as $item) {
92	1	$item->setWidth($width);
93		}
94
95	1	return $this;
96		}
97
98		/**
99		* Set all hights, keeping aspect ratios
100		* @param integer $height
101		*/
102	1	public function setHeight($height)
103		{
104	1	foreach ($this as $item) {
105	1	$item->setHeight($height);
106		}
107
108	1	return $this;
109		}
110
111		/**
112		* Multiple the width/height of all the items by $scale
113		* @param float $scale
114		*/
115	1	public function setScale($scale)
116		{
117	1	foreach ($this as $item) {
118	1	$item->setWidth($item->getWidth() * $scale);
119		}
120
121	1	return $this;
122		}
123
124		/**
125		* Return a new ItemGroup with items, filtered by the Closure
126		* @param Closure $filter
127		* @return ItemGroup
128		*/
129	1	public function filter(Closure $filter)
130		{
131	1	return new ItemGroup(array_filter($this->getArrayCopy(), $filter), $this->margin);
132		}
133
134		/**
135		* Return a new ItemGroup with items, sliced by the $offcet and $limit
136		* @param Closure $filter
		0 ignored issues – show Bug introduced 2017-03-04 20:15 UTC by Report Bug Copy Issue Report There is no parameter named `$filter`. 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...
137		* @return ItemGroup
138		*/
139	1	public function slice($offset, $limit)
140		{
141	1	return new ItemGroup(array_slice($this->getArrayCopy(), $offset, $limit), $this->margin);
142		}
143
144		/**
145		* Scale all of the widths of the items to match an overall width, respecting margins
146		* @param float $width
147		* @return ItemGroup
148		*/
149	1	public function scaleToWidth($width)
150		{
151	1	$items = clone $this;
152	1	$widthWithoutMargins = $width - $items->getGaps() * $this->margin;
153	1	$sumWidths = $items->sumWidths();
154
155	1	if ($sumWidths and $sumWidths < $widthWithoutMargins) {
156	1	$difference = $widthWithoutMargins / $sumWidths;
157	1	$items->setScale($difference);
158		}
159
160	1	return $items;
161		}
162
163		/**
164		* Scale all of the widths of the items to match an overall height, respecting margins
165		* @param float $height
166		* @return ItemGroup
167		*/
168	1	public function scaleToHeight($height)
169		{
170	1	$items = clone $this;
171	1	$heightWithoutMargins = $height - $items->getGaps() * $this->margin;
172	1	$sumHeights = $items->sumHeights();
173
174	1	if ($sumHeights and $sumHeights < $heightWithoutMargins) {
175	1	$difference = $heightWithoutMargins / $sumHeights;
176	1	$items->setScale($difference);
177		}
178
179	1	return $items;
180		}
181
182		/**
183		* Remove all items that fall outside of width, when aligned horizontally, spaced by $margin
184		* @param integer $width
185		* @param integer $margin
		0 ignored issues – show Bug introduced 2017-03-04 20:15 UTC by Report Bug Copy Issue Report There is no parameter named `$margin`. 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...
186		*/
187	1	public function horizontalSlice($width)
188		{
189	1	$current = 0;
190
191		return $this
192		->filter(function(Item $item) use ($width, &$current) {
193	1	$current += $item->getWidth() + $this->margin;
194
195	1	return $current <= ($width + $this->margin);
196	1	});
197		}
198
199		/**
200		* Remove all items that fall outside of height, when aligned horizontally, spaced by $margin
201		* @param integer $height
202		* @param integer $margin
		0 ignored issues – show Bug introduced 2017-03-04 20:15 UTC by Report Bug Copy Issue Report There is no parameter named `$margin`. 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...
203		*/
204	1	public function verticalSlice($height)
205		{
206	1	$current = 0;
207
208		return $this->filter(function(Item $item) use ($height, &$current) {
209	1	$current += $item->getHeight() + $this->margin;
210
211	1	return $current <= ($height + $this->margin);
212	1	});
213		}
214
215		/**
216		* @return integer
217		*/
218	1	public function getGaps()
219		{
220	1	return max(count($this) - 1, 0);
221		}
222
223		/**
224		* @return float
225		*/
226	1	public function getWidth()
227		{
228	1	return $this->sumWidths() + $this->getGaps() * $this->margin;
229		}
230
231		/**
232		* @return float
233		*/
234	1	public function getHeight()
235		{
236	1	return $this->sumHeights() + $this->getGaps() * $this->margin;
237		}
238
239		/**
240		* @return float
241		*/
242	1	public function sumWidths()
243		{
244		return array_sum(array_map(function(Item $item) {
245	1	return $item->getWidth();
246	1	}, $this->getArrayCopy()));
247		}
248
249		/**
250		* @return float
251		*/
252	1	public function sumHeights()
253		{
254		return array_sum(array_map(function(Item $item) {
255	1	return $item->getHeight();
256	1	}, $this->getArrayCopy()));
257		}
258		}
259

clippings / fluid-gallery

ItemGroup::add() A last analyzed 2020-02-11 10:35 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

ItemGroup::add() A
last analyzed 2020-02-11 10:35 UTC