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

FixedOrderByTrait::fixedOrderColumn()
last analyzed 2020-01-10 17:19 UTC

↳ Parent: FixedOrderByTrait

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	1
ccs	0
cts	0
cp	0
c	0
b	0
f	0
nc	1

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

use craft\db\Connection as CraftConnection;
use craft\db\FixedOrderExpression;
use craft\db\QueryAbortedException;
use craft\helpers\StringHelper;
use yii\base\Exception;
use yii\db\Connection;

/**
 * @author Flipbox Factory <[email protected]>
 * @since 2.0.0
 *
 * @method void traitApplyEmptyOrderByParams(Connection $db)
 */
trait FixedOrderByTrait
{
    use OrderByTrait {
        applyEmptyOrderByParams as traitApplyEmptyOrderByParams;
    }

    /**
     * @var bool Whether results should be returned in the order specified by [[domain]].
     */
    public $fixedOrder = false;

    /**
     * @return string
     */
    abstract protected function fixedOrderColumn(): string;

    /**
     * @param Connection $db
     * @throws Exception
     * @throws QueryAbortedException
     */
    protected function applyEmptyOrderByParams(Connection $db)
    {
        if ($this->fixedOrder) {
            $values = $this->{$this->fixedOrderColumn()};
            if (!is_array($values)) {
                $values = is_string($values) ? StringHelper::split($values) : [$values];
            }

            if (empty($values)) {
                throw new QueryAbortedException;
            }

            // Order the elements in the exact order that the Search service returned them in
            if (!$db instanceof CraftConnection) {
                throw new Exception('The database connection doesn\'t support fixed ordering.');
            }

            $this->orderBy = [new FixedOrderExpression($this->fixedOrderColumn(), $values, $db)];
        } else {
            $this->traitApplyEmptyOrderByParams($db);
        }
    }
}


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\queries;
10
11			use craft\db\Connection as CraftConnection;
12			use craft\db\FixedOrderExpression;
13			use craft\db\QueryAbortedException;
14			use craft\helpers\StringHelper;
15			use yii\base\Exception;
16			use yii\db\Connection;
17
18			/**
19			* @author Flipbox Factory <[email protected]>
20			* @since 2.0.0
21			*
22			* @method void traitApplyEmptyOrderByParams(Connection $db)
23			*/
24			trait FixedOrderByTrait
25			{
26			use OrderByTrait {
27			applyEmptyOrderByParams as traitApplyEmptyOrderByParams;
28			}
29
30			/**
31			* @var bool Whether results should be returned in the order specified by [[domain]].
32			*/
33			public $fixedOrder = false;
34
35			/**
36			* @return string
37			*/
38			abstract protected function fixedOrderColumn(): string;
39
40			/**
41			* @param Connection $db
42			* @throws Exception
43			* @throws QueryAbortedException
44			*/
45			protected function applyEmptyOrderByParams(Connection $db)
46			{
47			if ($this->fixedOrder) {
48			$values = $this->{$this->fixedOrderColumn()};
49			if (!is_array($values)) {
50			$values = is_string($values) ? StringHelper::split($values) : [$values];
51			}
52
53			if (empty($values)) {
54			throw new QueryAbortedException;
55			}
56
57			// Order the elements in the exact order that the Search service returned them in
58			if (!$db instanceof CraftConnection) {
59			throw new Exception('The database connection doesn\'t support fixed ordering.');
60			}
61
62			$this->orderBy = [new FixedOrderExpression($this->fixedOrderColumn(), $values, $db)];
63			} else {
64			$this->traitApplyEmptyOrderByParams($db);
65			}
66			}
67			}
68

flipboxfactory / craft-ember

FixedOrderByTrait::fixedOrderColumn() last analyzed 2020-01-10 17:19 UTC

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

FixedOrderByTrait::fixedOrderColumn()
last analyzed 2020-01-10 17:19 UTC