QueryHelper::prepareParamValue() - Code Metrics - flipboxfactory/craft-ember - Measure and Improve Code Quality continuously with Scrutinizer

QueryHelper::prepareParamValue() B
last analyzed 2020-01-10 17:19 UTC

↳ Parent: QueryHelper

Complexity

Conditions	8
Paths	7

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	72

Importance

Changes

Metric	Value
dl	0
loc	36
ccs	0
cts	28
cp	0
rs	8.0995
c	0
b	0
f	0
cc	8
nc	7
nop	3
crap	72

<?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\helpers;

use craft\helpers\StringHelper;
use yii\db\Query;
use yii\db\QueryInterface;

/**
 * @author Flipbox Factory <[email protected]>
 * @since 2.0.0
 */
class QueryHelper
{
    /**
     * @var array
     */
    protected static $operators = ['not ', '!=', '<=', '>=', '<', '>', '='];

    /**
     * @param $condition
     * @return array
     */
    public static function conditionToCriteria($condition)
    {
        if (empty($condition)) {
            return $condition;
        }

        // Assume it's an id
        if (!is_array($condition)) {
            $condition = [
                'id' => $condition
            ];
        }

        return ['where' => ['and', $condition]];
    }

    /**
     * @param QueryInterface|Query $query
     * @param array $config
     * @return QueryInterface
     */
    public static function configure(QueryInterface $query, $config = []): QueryInterface
    {
        // Halt
        if (empty($config)) {
            return $query;
        }

        // Force array
        if (!is_array($config)) {
            $config = ArrayHelper::toArray($config, [], false);
        }

        // Populate query attributes
        foreach ($config as $name => $value) {
            if ($query->canSetProperty($name)) {
                $query->$name = $value;
            }
        }

        return $query;
    }

    /**
     * Prepares a query params input value to be used as a condition.  This will attempt to resolve an object
     * or look one up based on a 'handle' or other unique string identifier (via the lookup callable).
     *
     * ```php
     *
     * [
     *      'and',
     *      'not' => [
     *          4, elementFiveHandle, $someElementWithIdOfSix
     *      ]
     * ]
     * ```
     * Would result in a query condition as `NOT IN (4, 5, 6)`.
     *
     * @param $value
     * @param callable|null $lookup
     * @return array|string
     */
    public static function prepareParam($value, callable $lookup = null)
    {
        if (!is_array($value)) {
            // An object (model, element, record)
            if (is_object($value)) {
                // Try to grab the Id from it
                try {
                    return $value->id ?: false;
                } catch (\Exception $e) {
function fx() {
    try {
        doSomething();
        return true;
    }
    catch (\Exception $e) {
        return false;
    }

    return false;
}
                    // Carry on
                }
            }

            // alpha identifier (handle, etc)
            if (is_string($value) &&
                !in_array($value, ['and', 'or'], true) &&
                StringHelper::isAlpha($value)
            ) {
                if (null !== $lookup) {
                    if (null !== ($val = call_user_func($lookup, $value))) {
                        return static::prepareParam($val, $lookup);
                    }
                }
            }

            return $value;
        }

        // Traverse
        $return = [];
        foreach ($value as $key => $val) {
            $return = ArrayHelper::merge(
                $return,
                static::prepareParamValue($key, $val, $lookup)
            );
        }

        return $return;
    }

    /**
     * @param $key
     * @param $value
     * @param callable|null $lookup
     * @return array
     */
    protected static function prepareParamValue($key, $value, callable $lookup = null): array
    {
        $value = static::prepareParam($value, $lookup);

        // Move arrays up one level
        if (is_array($value)) {
            $values = [];

            $firstVal = strtolower(reset($value));

            foreach ($value as $k => $val) {
                $values = ArrayHelper::merge(
                    $values,
                    static::prepareParamValue(
                        is_numeric($k) ? $key : $k,
                        $val,
                        $lookup
                    )
                );
            }

            if (in_array($firstVal, ['and', 'or'], true)) {
                return [$values];
            }

            return $values;
        }

        if (!is_numeric($key)) {
            if (is_string($value) || is_numeric($value)) {
                $value = $key . ' ' . $value;
            }
        }

        return [$value];
    }
}


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\helpers;
10
11			use craft\helpers\StringHelper;
12			use yii\db\Query;
13			use yii\db\QueryInterface;
14
15			/**
16			* @author Flipbox Factory <[email protected]>
17			* @since 2.0.0
18			*/
19			class QueryHelper
20			{
21			/**
22			* @var array
23			*/
24			protected static $operators = ['not ', '!=', '<=', '>=', '<', '>', '='];
25
26			/**
27			* @param $condition
28			* @return array
29			*/
30			public static function conditionToCriteria($condition)
31			{
32			if (empty($condition)) {
33			return $condition;
34			}
35
36			// Assume it's an id
37			if (!is_array($condition)) {
38			$condition = [
39			'id' => $condition
40			];
41			}
42
43			return ['where' => ['and', $condition]];
44			}
45
46			/**
47			* @param QueryInterface\|Query $query
48			* @param array $config
49			* @return QueryInterface
50			*/
51			public static function configure(QueryInterface $query, $config = []): QueryInterface
52			{
53			// Halt
54			if (empty($config)) {
55			return $query;
56			}
57
58			// Force array
59			if (!is_array($config)) {
60			$config = ArrayHelper::toArray($config, [], false);
61			}
62
63			// Populate query attributes
64			foreach ($config as $name => $value) {
65			if ($query->canSetProperty($name)) {
66			$query->$name = $value;
67			}
68			}
69
70			return $query;
71			}
72
73			/**
74			* Prepares a query params input value to be used as a condition. This will attempt to resolve an object
75			* or look one up based on a 'handle' or other unique string identifier (via the lookup callable).
76			*
77			* ```php
78			*
79			* [
80			* 'and',
81			* 'not' => [
82			* 4, elementFiveHandle, $someElementWithIdOfSix
83			* ]
84			* ]
85			* ```
86			* Would result in a query condition as `NOT IN (4, 5, 6)`.
87			*
88			* @param $value
89			* @param callable\|null $lookup
90			* @return array\|string
91			*/
92			public static function prepareParam($value, callable $lookup = null)
93			{
94			if (!is_array($value)) {
95			// An object (model, element, record)
96			if (is_object($value)) {
97			// Try to grab the Id from it
98			try {
99			return $value->id ?: false;
100			} catch (\Exception $e) {
			0 ignored issues – show Unused Code introduced 2019-01-24 20:14 UTC by Report Bug Copy Issue Report `catch (\Exception $e) { }` does not seem to be reachable. This check looks for unreachable code. It uses sophisticated control flow analysis techniques to find statements which will never be executed. Unreachable code is most often the result of `return`, `die` or `exit` statements that have been added for debug purposes. function fx() { try { doSomething(); return true; } catch (\Exception $e) { return false; } return false; } In the above example, the last `return false` will never be executed, because a return statement has already been met in every possible execution path. Loading history...
101			// Carry on
102			}
103			}
104
105			// alpha identifier (handle, etc)
106			if (is_string($value) &&
107			!in_array($value, ['and', 'or'], true) &&
108			StringHelper::isAlpha($value)
109			) {
110			if (null !== $lookup) {
111			if (null !== ($val = call_user_func($lookup, $value))) {
112			return static::prepareParam($val, $lookup);
113			}
114			}
115			}
116
117			return $value;
118			}
119
120			// Traverse
121			$return = [];
122			foreach ($value as $key => $val) {
123			$return = ArrayHelper::merge(
124			$return,
125			static::prepareParamValue($key, $val, $lookup)
126			);
127			}
128
129			return $return;
130			}
131
132			/**
133			* @param $key
134			* @param $value
135			* @param callable\|null $lookup
136			* @return array
137			*/
138			protected static function prepareParamValue($key, $value, callable $lookup = null): array
139			{
140			$value = static::prepareParam($value, $lookup);
141
142			// Move arrays up one level
143			if (is_array($value)) {
144			$values = [];
145
146			$firstVal = strtolower(reset($value));
147
148			foreach ($value as $k => $val) {
149			$values = ArrayHelper::merge(
150			$values,
151			static::prepareParamValue(
152			is_numeric($k) ? $key : $k,
153			$val,
154			$lookup
155			)
156			);
157			}
158
159			if (in_array($firstVal, ['and', 'or'], true)) {
160			return [$values];
161			}
162
163			return $values;
164			}
165
166			if (!is_numeric($key)) {
167			if (is_string($value) \|\| is_numeric($value)) {
168			$value = $key . ' ' . $value;
169			}
170			}
171
172			return [$value];
173			}
174			}
175

flipboxfactory / craft-ember

QueryHelper::prepareParamValue() B last analyzed 2020-01-10 17:19 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

QueryHelper::prepareParamValue() B
last analyzed 2020-01-10 17:19 UTC