ComicVine\Api\Controllers\ControllerRequestAbstract

Complexity

Total Complexity

2

Size/Duplication

Total Lines	54
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes	3
Bugs	0	Features	0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	setFilters()	0	12	1
A	setUrl()	0	4	1

<?php

namespace ComicVine\Api\Controllers;

use ComicVine\Exceptions\EmptyControllerRequestUrl;

/**
 * Abstract base for ControllerRequest. Here
 * methods from ControllerRequest are assigned
 * and finally method call new controller.
 *
 * Class ControllerRequestAbstract
 *
 * @package grzgajda/comicvine-api
 * @author  Grzegorz Gajda <grz.gajda@outlook.com>
 */
abstract class ControllerRequestAbstract
{

    /**
     * Filters for GET request.
     *
     * @var array
     */
    protected $enabledFilters
        = [
            'field_list' => true,
            'limit'      => false,
            'offset'     => false,
            'sort'       => false,
            'filter'     => false,
        ];

    /**
     * Set parameters which can be added to URL.
     *
     * @param bool|false $limit  The number of results to display per page.
     * @param bool|false $offset Return results starting with the object at the offset specified.
     * @param bool|false $sort   The result set can be sorted by the marked fields in the Fields section below.
     * @param bool|false $filter The result can be filtered by the marked fields in the Fields section below.
     *
     * @return $this
     */
    protected function setFilters($limit = false, $offset = false, $sort = false, $filter = false)
    {
        $this->enabledFilters = [
            'field_list' => true,
            'limit'      => $limit,
            'offset'     => $offset,
            'sort'       => $sort,
            'filter'     => $filter,
        ];

        return $this;
    }

    /**
     * Add url for this type of request.
     *
     * @param string $url Part of URL.
     *
     * @return \ComicVine\Api\Controllers\ControllerQuery
     * @throws \ComicVine\Exceptions\EmptyControllerRequestUrl
     */
    protected function setUrl($url)
    {
        return new ControllerQuery($this->enabledFilters, $url);
    }

}