clippings / fluid-gallery

src/ItemGroup.php

<?php

namespace CL\FluidGallery;

use ArrayObject;
use Closure;

/**
 * @author    Ivan Kerin <ikerin@gmail.com>
 * @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

There is no parameter named $filter. Was it maybe removed?

     * @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

There is no parameter named $margin. Was it maybe removed?

     */
    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

There is no parameter named $margin. Was it maybe removed?

     */
    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()));
    }
}