ElementQueryOptionsTrait::createQuery() - Code Metrics - Inspection of "reverting queryConfig property / adding createQuer..." - flipboxfactory/craft-ember - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — develop ( 7cef7e...c9d3f4 )

by Nate

created 2019-03-18 23:51 UTC

ElementQueryOptionsTrait::createQuery() A

↳ Parent: ElementQueryOptionsTrait

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

Metric	Value
dl	0
loc	7
ccs	0
cts	5
cp	0
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	0
crap	2

<?php

/**
 * @copyright  Copyright (c) Flipbox Digital Limited
 * @license    https://github.com/flipboxfactory/craft-ember/blob/master/LICENSE
 * @link       https://github.com/flipboxfactory/craft-ember/
 */

namespace flipbox\craft\ember\cli;

use craft\base\ElementInterface;
use craft\elements\db\ElementQuery;
use craft\elements\db\ElementQueryInterface;
use flipbox\craft\ember\helpers\QueryHelper;
use yii\base\Action;
use yii\base\Exception;
use yii\base\InvalidArgumentException;
use yii\helpers\Inflector;

/**
 * @property string $elementType
 * @property array $queryConfig
 * @property Action $action
 */
trait ElementQueryOptionsTrait
{
    /**
     * @var array
     * The query conditional id logic for (ElementQuery only) used to source the sync operation.
     * example: -id=1,2,4
     */
    public $queryId = [];

    /**
     * @var array
     * The query conditional status logic for (ElementQuery only) used to source the sync operation.
     * example: -status=active,pending
     */
    public $queryStatus = [];

    /**
     * @var array
     * The query conditional used to source the sync operation.
     * example: -where='and,elements.dateUpdated > "2000-01-01",elements.dateCreated < "2010-01-01"'
     */
    public $queryWhere = [];

    /**
     * @var int
     * The query limit logic used to source the sync operation. Set to -1 to remove limit.
     * example: -limit=10
     */
    public $queryLimit = 100;

    /**
     * @var int
     * The query offset logic used to source the sync operation.
     * example: -limit=0
     */
    public $queryOffset = 0;

    /**
     * @var ElementQueryInterface|ElementQuery
     */
    private $query;

    /**
     * Returns properties corresponding to the options for the action id
     * Child classes may override this method to specify possible properties.
     *
     * @param string $actionID the action id of the current request
     * @return array properties corresponding to the options for the action
     */
    abstract public function getOptionValues($actionID);

    /**
     * Returns option alias names.
     * Child classes may override this method to specify alias options.
     *
     * @return array the options alias names valid for the action
     * where the keys is alias name for option and value is option name.
     *
     * @since 2.0.8
     * @see options()
     */
    abstract public function optionAliases();

    /**
     * @return string
     * @throws Exception
     */
    protected function elementType(): string
    {
        if (null === ($elementType = $this->elementType ?? null)) {
            throw new Exception("Invalid element type.");
        }
        return $elementType;
    }

    /**
     * @return array
     */
    protected function queryConfig(): array
    {
        return $this->queryConfig ?? [];
    }

    /**
     * @inheritdoc
     */
    protected function queryOptions()
    {
        return [
            'queryId',
            'queryStatus',
            'queryWhere',
            'queryLimit',
            'queryOffset',
        ];
    }

    /**
     * @inheritdoc
     */
    protected function queryOptionAliases()
    {
        return [
            'id' => 'query-id',
            'status' => 'query-status',
            'where' => 'query-where',
            'limit' => 'query-limit',
            'offset' => 'query-offset',
        ];
    }

    /*******************************************
     * PREPARE
     *******************************************/

    /**
     * @throws Exception
     */
    protected function prepQuery()
    {
        $config = [];

        // Flip the array to grab the alias which matches the query method name
        $alias = array_flip($this->queryOptionAliases());

        // Defaults
        foreach ($this->getOptionValues($this->action->id) as $optionName => $optionValue) {
            // Convert CamelName to id-case
            $optionId  = Inflector::camel2id($optionName);

            // Only handle query params
            if (!array_key_exists($optionId, $alias)) {
                continue;
            }

            if (null !== ($queryMethod = $alias[$optionId] ?? null)) {
                try {
                    $optionValue = $this->prepOptionValue($optionName, $optionValue);
                    $config[$queryMethod] = $optionValue;
                } catch (InvalidArgumentException $e) {
                    // The option is ignored
                }
            }
        }

        QueryHelper::configure(
            $this->getQuery(
                $this->queryConfig()
            ),
            $config
        );
    }

    /**
     * @param $method
     * @param $value
     * @return mixed
     */
    private function prepOptionValue($method, $value)
    {
        // Add a specific prep method to the option
        $prepQueryOption = 'prep' . ucfirst($method);
        if (method_exists($this, $prepQueryOption)) {
            $value = $this->{$prepQueryOption}($value);
        }

        return $value;
    }

    /*******************************************
     * PREPARE SPECIFIC ATTRIBUTES
     *******************************************/

    /**
     * @param $value
     * @return null|array
     */
    protected function prepQueryId($value)
    {
        if (empty($value)) {
            return null;
        }

        return $value;
    }

    /**
     * @param $value
     * @return null|array
     */
    protected function prepQueryStatus($value)
    {
        if (empty($value)) {
            return null;
        }

        return $value;
    }

    /**
     * @param $value
     * @return null|array
     */
    protected function prepQueryWhere($value)
    {
        if (empty($value)) {
            return null;
        }

        return $value;
    }

    /**
     * @param array $config
     * @return ElementQuery|ElementQueryInterface
     * @throws Exception
     */
    protected function getQuery(array $config = []): ElementQueryInterface
    {
        if (null === $this->query) {
            $this->query = $this->createQuery();

            QueryHelper::configure(
                $this->query,
                $config
            );
        }

        return $this->query;
    }

    /**
     * @return ElementQueryInterface
     * @throws Exception
     */
    protected function createQuery(): ElementQueryInterface
    {
        /** @var ElementInterface $elementClass */
        $elementClass = $this->elementType();

        return $elementClass::find();
    }
}


1			<?php
2
3			/**
4			* @copyright Copyright (c) Flipbox Digital Limited
5			* @license https://github.com/flipboxfactory/craft-ember/blob/master/LICENSE
6			* @link https://github.com/flipboxfactory/craft-ember/
7			*/
8
9			namespace flipbox\craft\ember\cli;
10
11			use craft\base\ElementInterface;
12			use craft\elements\db\ElementQuery;
13			use craft\elements\db\ElementQueryInterface;
14			use flipbox\craft\ember\helpers\QueryHelper;
15			use yii\base\Action;
16			use yii\base\Exception;
17			use yii\base\InvalidArgumentException;
18			use yii\helpers\Inflector;
19
20			/**
21			* @property string $elementType
22			* @property array $queryConfig
23			* @property Action $action
24			*/
25			trait ElementQueryOptionsTrait
26			{
27			/**
28			* @var array
29			* The query conditional id logic for (ElementQuery only) used to source the sync operation.
30			* example: -id=1,2,4
31			*/
32			public $queryId = [];
33
34			/**
35			* @var array
36			* The query conditional status logic for (ElementQuery only) used to source the sync operation.
37			* example: -status=active,pending
38			*/
39			public $queryStatus = [];
40
41			/**
42			* @var array
43			* The query conditional used to source the sync operation.
44			* example: -where='and,elements.dateUpdated > "2000-01-01",elements.dateCreated < "2010-01-01"'
45			*/
46			public $queryWhere = [];
47
48			/**
49			* @var int
50			* The query limit logic used to source the sync operation. Set to -1 to remove limit.
51			* example: -limit=10
52			*/
53			public $queryLimit = 100;
54
55			/**
56			* @var int
57			* The query offset logic used to source the sync operation.
58			* example: -limit=0
59			*/
60			public $queryOffset = 0;
61
62			/**
63			* @var ElementQueryInterface\|ElementQuery
64			*/
65			private $query;
66
67			/**
68			* Returns properties corresponding to the options for the action id
69			* Child classes may override this method to specify possible properties.
70			*
71			* @param string $actionID the action id of the current request
72			* @return array properties corresponding to the options for the action
73			*/
74			abstract public function getOptionValues($actionID);
75
76			/**
77			* Returns option alias names.
78			* Child classes may override this method to specify alias options.
79			*
80			* @return array the options alias names valid for the action
81			* where the keys is alias name for option and value is option name.
82			*
83			* @since 2.0.8
84			* @see options()
85			*/
86			abstract public function optionAliases();
87
88			/**
89			* @return string
90			* @throws Exception
91			*/
92			protected function elementType(): string
93			{
94			if (null === ($elementType = $this->elementType ?? null)) {
95			throw new Exception("Invalid element type.");
96			}
97			return $elementType;
98			}
99
100			/**
101			* @return array
102			*/
103			protected function queryConfig(): array
104			{
105			return $this->queryConfig ?? [];
106			}
107
108			/**
109			* @inheritdoc
110			*/
111			protected function queryOptions()
112			{
113			return [
114			'queryId',
115			'queryStatus',
116			'queryWhere',
117			'queryLimit',
118			'queryOffset',
119			];
120			}
121
122			/**
123			* @inheritdoc
124			*/
125			protected function queryOptionAliases()
126			{
127			return [
128			'id' => 'query-id',
129			'status' => 'query-status',
130			'where' => 'query-where',
131			'limit' => 'query-limit',
132			'offset' => 'query-offset',
133			];
134			}
135
136			/*******************************************
137			* PREPARE
138			*******************************************/
139
140			/**
141			* @throws Exception
142			*/
143			protected function prepQuery()
144			{
145			$config = [];
146
147			// Flip the array to grab the alias which matches the query method name
148			$alias = array_flip($this->queryOptionAliases());
149
150			// Defaults
151			foreach ($this->getOptionValues($this->action->id) as $optionName => $optionValue) {
152			// Convert CamelName to id-case
153			$optionId = Inflector::camel2id($optionName);
154
155			// Only handle query params
156			if (!array_key_exists($optionId, $alias)) {
157			continue;
158			}
159
160			if (null !== ($queryMethod = $alias[$optionId] ?? null)) {
161			try {
162			$optionValue = $this->prepOptionValue($optionName, $optionValue);
163			$config[$queryMethod] = $optionValue;
164			} catch (InvalidArgumentException $e) {
165			// The option is ignored
166			}
167			}
168			}
169
170			QueryHelper::configure(
171			$this->getQuery(
172			$this->queryConfig()
173			),
174			$config
175			);
176			}
177
178			/**
179			* @param $method
180			* @param $value
181			* @return mixed
182			*/
183			private function prepOptionValue($method, $value)
184			{
185			// Add a specific prep method to the option
186			$prepQueryOption = 'prep' . ucfirst($method);
187			if (method_exists($this, $prepQueryOption)) {
188			$value = $this->{$prepQueryOption}($value);
189			}
190
191			return $value;
192			}
193
194			/*******************************************
195			* PREPARE SPECIFIC ATTRIBUTES
196			*******************************************/
197
198			/**
199			* @param $value
200			* @return null\|array
201			*/
202			protected function prepQueryId($value)
203			{
204			if (empty($value)) {
205			return null;
206			}
207
208			return $value;
209			}
210
211			/**
212			* @param $value
213			* @return null\|array
214			*/
215			protected function prepQueryStatus($value)
216			{
217			if (empty($value)) {
218			return null;
219			}
220
221			return $value;
222			}
223
224			/**
225			* @param $value
226			* @return null\|array
227			*/
228			protected function prepQueryWhere($value)
229			{
230			if (empty($value)) {
231			return null;
232			}
233
234			return $value;
235			}
236
237			/**
238			* @param array $config
239			* @return ElementQuery\|ElementQueryInterface
240			* @throws Exception
241			*/
242			protected function getQuery(array $config = []): ElementQueryInterface
243			{
244			if (null === $this->query) {
245			$this->query = $this->createQuery();
246
247			QueryHelper::configure(
248			$this->query,
249			$config
250			);
251			}
252
253			return $this->query;
254			}
255
256			/**
257			* @return ElementQueryInterface
258			* @throws Exception
259			*/
260			protected function createQuery(): ElementQueryInterface
261			{
262			/** @var ElementInterface $elementClass */
263			$elementClass = $this->elementType();
264
265			return $elementClass::find();
266			}
267			}
268

flipboxfactory / craft-ember

Push — develop ( 7cef7e...c9d3f4 )

ElementQueryOptionsTrait::createQuery() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like