Brownie\CartsGuru\Model\Base\DataModel

Complexity

Total Complexity

12

Size/Duplication

Total Lines	115
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes

0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	validate()	0	15	3
A	getItemList()	0	3	1
A	setItemList()	0	4	1
A	toArray()	0	11	3
A	getRequiredFields()	0	3	1
A	getEndpoint()	0	3	1
A	addItem()	0	7	2

<?php
/**
 * @category    Brownie/CartsGuru
 * @author      Brownie <oss.brownie@gmail.com>
 * @license     http://www.gnu.org/copyleft/lesser.html
 */

namespace Brownie\CartsGuru\Model\Base;

use Brownie\CartsGuru\Exception\ValidateException;
use Brownie\CartsGuru\Model\Item;
use Brownie\CartsGuru\Model\ItemList;

/**
 * Data model.
 *
 * @method  DataModel    setSiteId($siteId)    Sets siteId.
 */
abstract class DataModel extends ArrayList
{

    /**
     * List of required fields.
     *
     * @var array
     */
    protected $requiredFields = array();

    /**
     * Endpoint name.
     *
     * @var string
     */
    protected $endpoint = '';

    /**
     * Returns the field list as an array.
     *
     * @return array
     */
    public function toArray()
    {
        $args = parent::toArray();
        if ($args['items']) {
            $list = array();
            foreach ($args['items']->toArray() as $item) {
                $list[] = array_filter($item->toArray());
            }
            $args['items'] = $list;
        }
        return array_filter($args);
    }

    /**
     * Add item.
     *
     * @param Item  $item   Product.
     *
     * @return self
     */
    public function addItem(Item $item)
    {
        if (is_null($this->getItemList())) {
            $this->setItemList(new ItemList());
        }
        $this->getItemList()->add($item);
        return $this;
    }

    /**
     * Set item list.
     *
     * @param ItemList      $itemList       Item list.
     *
     * @return self
     */
    private function setItemList(ItemList $itemList)
    {
        $this->fields['items'] = $itemList;
        return $this;
    }

    /**
     * Return item list.
     *
     * @return ItemList
     */
    private function getItemList()
    {
        return $this->fields['items'];
    }

    /**
     * Validates contact data.
     *
     * @throws ValidateException
     */
    public function validate()
    {
        $args = array_filter($this->toArray());

        $keys = array_diff($this->getRequiredFields(), array_keys($args));

        if (!empty($keys)) {
            throw new ValidateException('No required fields: ' . implode(', ', $keys));
        }

        /**
         * @var $item   Item    Product.
         */
        foreach ($this->getItemList()->toArray() as $item) {
            $item->validate();
        }
    }

    /**
     * Returns a list of required fields.
     *
     * @return array
     */
    protected function getRequiredFields()
    {
        return $this->requiredFields;
    }

    /**
     * Returns a endpoint name.
     *
     * @return string
     */
    public function getEndpoint()
    {
        return $this->endpoint;
    }
}