Surfnet\StepupMiddlewareClientBundle\Dto\CollectionDto

Complexity

Total Complexity

13

Size/Duplication

Total Lines	139
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	0

Importance

Changes

0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	createElementFromData()	0	6	1
A	getCurrentPage()	0	4	1
A	getElements()	0	4	1
A	__construct()	0	8	1
A	fromData()	0	15	2
A	getFilterOption()	0	7	2
A	getOnlyElement()	0	12	3
A	getItemsPerPage()	0	4	1
A	getTotalItems()	0	4	1

<?php

/**
 * Copyright 2014 SURFnet bv
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

namespace Surfnet\StepupMiddlewareClientBundle\Dto;

use LogicException;
use Symfony\Component\Validator\Constraints as Assert;

abstract class CollectionDto implements Dto
{
    /**
     * @Assert\Valid
     *
     * @var array
     */
    protected $elements;

    /**
     * @var int
     */
    protected $totalItems;

    /**
     * @var int
     */
    protected $currentPage;

    /**
     * @var int
     */
    protected $itemsPerPage;

    /**
     * @var array
     */
    private $filterOptions;

    /**
     * @param array $elements
     * @param int   $totalItems
     * @param int   $currentPage
     * @param int   $itemsPerPage
     * @param array $filterOptions
     */
    public function __construct(array $elements, $totalItems, $currentPage, $itemsPerPage, $filterOptions = array())
    {
        $this->elements = $elements;
        $this->totalItems = (int) $totalItems;
        $this->currentPage = (int) $currentPage;
        $this->itemsPerPage = (int) $itemsPerPage;
        $this->filterOptions = $filterOptions;
    }

    /**
     * @param  array  $data
     * @return static
     */
    public static function fromData(array $data)
    {
        $elements = [];
        foreach ($data['items'] as $key => $item) {
            $elements[$key] = static::createElementFromData($item);
        }

        return new static(
            $elements,
            $data['collection']['total_items'],
            $data['collection']['page'],
            $data['collection']['page_size'],
            $data['filters']
        );
    }

    /**
     * Load the element in the collection based on the data given
     *
     * @param  array $item
     * @return mixed
     */
    protected static function createElementFromData(array $item)
    {
        throw new LogicException(sprintf(
            'The method "%s::createElementFromData must be implemented to load the Collection Element"'
        ));
    }

    /**
     * @return int
     */
    public function getCurrentPage()
    {
        return $this->currentPage;
    }

    /**
     * @return array
     */
    public function getElements()
    {
        return $this->elements;
    }

    /**
     * @param string $key
     * @return array
     */
    public function getFilterOption($key)
    {
        if (!array_key_exists($key, $this->filterOptions)) {
            return [];
        }
        return $this->filterOptions[$key];
    }

    /**
     * @return mixed|null
     * @throws LogicException When there is more than 1 element present.
     */
    public function getOnlyElement()
    {
        $elementCount = count($this->elements);

        if ($elementCount === 1) {
            return reset($this->elements);
        } elseif ($elementCount === 0) {
            return null;
        }

        throw new LogicException(sprintf('There are %d elements in this collection instead of one.', $elementCount));
    }

    /**
     * @return int
     */
    public function getItemsPerPage()
    {
        return $this->itemsPerPage;
    }

    /**
     * @return int
     */
    public function getTotalItems()
    {
        return $this->totalItems;
    }
}