hiapi\commands\SearchCommand

Complexity

Total Complexity

8

Size/Duplication

Total Lines	49
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Test Coverage

Coverage

0%

Importance

Changes

0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	rules()	0	25	5
A	getSpecification()	0	11	3

<?php
/**
 * HiAPI Yii2 base project for building API
 *
 * @link      https://github.com/hiqdev/hiapi
 * @package   hiapi
 * @license   BSD-3-Clause
 * @copyright Copyright (c) 2017, HiQDev (http://hiqdev.com/)
 */

namespace hiapi\commands;

use hiapi\validators\RefValidator;
use hiqdev\yii\DataMapper\query\Specification;

/**
 * Class SearchCommand
 *
 * @author Andrii Vasyliev <sol@hiqdev.com>
 */
abstract class SearchCommand extends EntityCommand
{
    public $select;
    public $limit;
    public $page;
    public $where = [];
    public $filter = [];
    public $with = [];
    public $include = [];
    public $count;

    public function rules()
    {
        return [
            ['select', 'safe'],
            [['where', 'filter'], 'safe'],
            [['page'], 'integer'],
            ['limit', function () {
                if (empty($this->limit)) {
                    return;
                }

                if (mb_strtolower($this->limit) === 'all') {
                    $this->limit = 'all';
                    return;
                }

                if ($this->limit < 1 || $this->limit > 1000) {
                    $this->addError('limit', 'Limit must be between 1 and 1000');
                    return;
                }
            }],
            [['with', 'include'], 'each', 'rule' => [RefValidator::class]],
            [['count'], 'boolean']
        ];
    }

    public function getSpecification(): Specification
    {
        $spec = new Specification();
        foreach (['select', 'limit', 'with', 'where'] as $key) {
            if (!empty($this->{$key})) {
                $spec->{$key} = $this->{$key};
            }
        }

        return $spec;
    }
}