funayaki / cakephp-cart

src/Controller/Component/CartComponent.php

<?php
/*
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * This software consists of voluntary contributions made by many individuals
 * and is licensed under the MIT license.
 */

namespace Cart\Controller\Component;

use Cake\Controller\Component;
use Cake\Controller\ComponentRegistry;
use Cart\Exception\BuyableLimitExceededException;

/**
 * @author Rafael Queiroz <rafaelfqf@gmail.com>
 */
class CartComponent extends Component
{

    /**
     * @var array
     */
    protected $_defaultConfig = [
        'storage' => \Cart\Storage\SessionStorage::class
    ];

    /**
     * @var \Cart\Storage\StorageInterface
     */
    protected $_storage;

    /**
     * @param array $config
     */
    public function initialize(array $config)
    {
        parent::initialize($config);
        $this->storage(new $this->_config['storage']($this->_registry->getController()->request));
    }

    /**
     * @param \Cart\Entity\EntityBuyableAwareInterface $entity
     * @param int $quantity
     * @return bool
     * @throws \Cart\Exception\BuyableLimitExceededException
     */
    public function add(\Cart\Entity\EntityBuyableAwareInterface $entity, $quantity = 1)
    {
        $this->_validate($entity, $quantity);
        if ($this->_entityExists($entity)) {
            return $this->edit($entity, $this->count($entity) + $quantity);
        }

        $this->_ensureBuyable($entity, $quantity);

        $objects = $this->get();
        $objects[] = [
            'entity' => $entity,
            'quantity' => $quantity,
            'total' => $entity->getPrice() * $quantity,
        ];

        $this->storage()->write($objects);
        return true;
    }

    /**
     * @param \Cart\Entity\EntityBuyableAwareInterface $entity
     * @param int $quantity
     * @return bool
     * @throws \Cart\Exception\BuyableLimitExceededException
     */
    public function edit(\Cart\Entity\EntityBuyableAwareInterface $entity, $quantity = 1)
    {
        $this->_validate($entity, $quantity);

        $objects = $this->get();
        foreach ($objects as &$object) {
            if ($object['entity'] == $entity) {

                $this->_ensureBuyable($entity, $quantity);

                $object['quantity'] = $quantity;
                $object['total'] = $entity->getPrice() * $object['quantity'];
                $this->storage()->write($objects);

                return true;
            }
        }

        throw new \Exception();
    }

    /**
     * @param \Cart\Entity\EntityBuyableAwareInterface $entity
     * @return bool
     * @throws \Exception
     */
    public function delete(\Cart\Entity\EntityBuyableAwareInterface $entity)
    {
        $objects = $this->get();
        foreach ($objects as $key => $object) {
            if ($object['entity'] == $entity) {
                unset ($objects[$key]);
                $this->storage()->write($objects);
                return true;
            }
        }

        throw new \Exception();
    }

    /**
     * @param \Cart\Entity\EntityBuyableAwareInterface|null $entity
     * @return mixed
     * @throws \Exception
     */
    public function get(\Cart\Entity\EntityBuyableAwareInterface $entity = null)
    {
        $objects = $this->storage()->read();

        if ($entity) {
            foreach ($objects as $object) {
                if ($object['entity'] == $entity) {
                    return $object;
                }
            }

            throw new \Exception();
        }

        return $objects;
    }

    /**
     * @param \Cart\Entity\EntityBuyableAwareInterface|null $entity
     * @return mixed
     * @throws \Exception
     */
    public function count(\Cart\Entity\EntityBuyableAwareInterface $entity = null)
    {
        if ($entity) {
            return $this->get($entity)['quantity'];
        }

        return array_reduce($this->get(), function ($count, $object) {
            return $count + $object['quantity'];
        }, 0);
    }

    /**
     * @return void
     */
    public function clear()
    {
        $this->storage()->delete();
    }

    /**
     * @param \Cart\Entity\EntityBuyableAwareInterface|null $entity
     * @return mixed
     * @throws \Exception
     */
    public function total(\Cart\Entity\EntityBuyableAwareInterface $entity = null)
    {
        if ($entity) {
            return $this->get($entity)['total'];
        }

        return array_reduce($this->get(), function ($total, $object) {
            return $total + $object['total'];
        }, 0);
    }

    /**
     * @param \Cart\Storage\StorageInterface $storage
     * @return \Cart\Storage\StorageInterface
     */
    public function storage(\Cart\Storage\StorageInterface $storage = null)
    {
        if (!$this->_storage instanceof \Cart\Storage\StorageInterface) {

$this->_storage is always a sub-type of Cart\Storage\StorageInterface.

            $this->_storage = $storage;
        }

        return $this->_storage;
    }

    /**
     * @param $entity
     * @param $quantity
     * @throws \Exception
     */
    protected function _validate($entity, $quantity)
    {
        if (!$entity instanceof \Cart\Entity\EntityBuyableAwareInterface) {
            throw new \Exception();
        }
        if ($quantity < 1) {
            throw new \Exception();
        }
    }

    /**
     * @param \Cart\Entity\EntityBuyableAwareInterface $entity
     * @return bool
     */
    protected function _entityExists(\Cart\Entity\EntityBuyableAwareInterface $entity)
    {
        try {
            $this->get($entity);
            return true;
        } catch (\Exception $e) {
            return false;
        }
    }

    /**
     * @param \Cart\Entity\EntityBuyableAwareInterface $entity
     * @param $quantity
     * @return bool
     * @throws \Cart\Exception\BuyableLimitExceededException
     */
    protected function _ensureBuyable(\Cart\Entity\EntityBuyableAwareInterface $entity, $quantity)
    {
        if ($quantity > $entity->getBuyableLimit()) {
            throw  new BuyableLimitExceededException();
        }

        return true;
    }
}