DomainAssociations - Code Metrics - Inspection of "fafb06b3dd4f8622549eb7cf3f7c9f2f7a0e7c8c" - flipboxfactory/craft-domains - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Branch — master (fafb06)

by Nate

created 2018-03-01 15:27 UTC

DomainAssociations B

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	590
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	9

Test Coverage

Coverage

Importance

Changes

Metric	Value
wmc	48
lcom	1
cbo	9
dl	0
loc	590
ccs	0
cts	359
cp	0
rs	8.4864
c	0
b	0
f	0

16 Methods

Rating	Name	Size	Complexity
B	save()	41	6
B	associate()	56	6
B	dissociate()	58	6
B	updateOrder()	24	2
B	insertRecord()	42	2
B	deleteRecord()	38	2
B	associateAll()	25	4
A	dissociateAll()	15	3
B	applySortOrder()	28	4
A	nextSortOrder()	13	1
A	autoReorder()	18	2
A	getCurrentDomainAssociations()	8	1
A	currentSortOrder()	7	1
A	baseAssociationQuery()	10	1
A	associationExists()	17	2
B	reOrderIfChanged()	14	5

How to fix Complexity

<?php

/**
 * @copyright  Copyright (c) Flipbox Digital Limited
 * @license    https://flipboxfactory.com/software/domains/license
 * @link       https://www.flipboxfactory.com/software/domains/
 */

namespace flipbox\domains\services;

use Craft;
use craft\base\Element;
use craft\base\ElementInterface;
use craft\db\Query;
use flipbox\domains\db\DomainsQuery;
use flipbox\domains\Domains as DomainsPlugin;
use flipbox\domains\events\DomainAssociationEvent;
use flipbox\domains\fields\Domains;
.
|-- OtherDir
|   |-- Bar.php
|   `-- Foo.php
`-- SomeDir
    `-- Foo.php
use flipbox\domains\models\Domain;
use flipbox\ember\helpers\ArrayHelper;
use yii\base\Component;

/**
 * @author Flipbox Factory <[email protected]>
 * @since 1.0.0
 */
class DomainAssociations extends Component
{
    /**
     * @event DomainAssociationEvent The event that is triggered before a domain association.
     *
     * You may set [[DomainAssociationEvent::isValid]] to `false` to prevent the associate action.
     */
    const EVENT_BEFORE_ASSOCIATE = 'beforeAssociate';

    /**
     * @event DomainAssociationEvent The event that is triggered after a domain association.
     */
    const EVENT_AFTER_ASSOCIATE = 'afterAssociate';

    /**
     * @event DomainAssociationEvent The event that is triggered before a domain dissociation.
     *
     * You may set [[DomainAssociationEvent::isValid]] to `false` to prevent the dissociate action.
     */
    const EVENT_BEFORE_DISSOCIATE = 'beforeDissociate';

    /**
     * @event DomainAssociationEvent The event that is triggered after a domain dissociation.
     */
    const EVENT_AFTER_DISSOCIATE = 'afterDissociate';

    /**
     * @param Domains $field
     * @param DomainsQuery $query
     * @param ElementInterface|Element $element
     * @return bool
     * @throws \Exception
     */
    public function save(
        Domains $field,
        DomainsQuery $query,
        ElementInterface $element
    ) {
        // Nothing to save
        if (null === ($models = $query->getCachedResult())) {
            return true;
        }

        $transaction = Craft::$app->getDb()->beginTransaction();
        try {
            $currentModels = $this->getCurrentDomainAssociations($field, $element);

            $newOrder = [];
            if (!$this->associateAll($element, $models, $currentModels, $newOrder)) {
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
                $transaction->rollBack();
                return false;
            }

            if (!$this->dissociateAll($element, $currentModels)) {
                $transaction->rollBack();
                return false;
            }

            if (!$this->reOrderIfChanged(
                DomainsPlugin::getInstance()->getField()->getTableName($field),
                $newOrder,
                $element
            )) {
                $transaction->rollBack();
                return false;
            }
        } catch (\Exception $e) {
            $transaction->rollBack();
            throw $e;
        }

        $transaction->commit();
        return true;
    }

    /*******************************************
     * ASSOCIATE
     *******************************************/

    /**
     * @param Domain $model
     * @return bool
     * @throws \Exception
     */
    public function associate(Domain $model): bool
    {

        if ($model->sortOrder === null) {
            $model->sortOrder = $this->nextSortOrder($model);
        }

        if ($this->associationExists($model)) {
            return $this->applySortOrder($model);
        }

        $event = new DomainAssociationEvent([
            'domain' => $model
        ]);

        $this->trigger(
            static::EVENT_BEFORE_ASSOCIATE,
            $event
        );

        // Green light?
        if (!$event->isValid) {
            DomainsPlugin::info(
                "Event aborted association.",
                __METHOD__
            );

            return false;
        }

        $transaction = Craft::$app->getDb()->beginTransaction();
        try {
            if (!$this->insertRecord(
                DomainsPlugin::getInstance()->getField()->getTableName($model->getField()),
                $model->getElementId(),
                $model->domain,
                $model->status,
                $model->sortOrder,
                $model->getSiteId()
            )) {
                $transaction->rollBack();
                return false;
            }

            $this->trigger(
                static::EVENT_AFTER_ASSOCIATE,
                $event
            );
        } catch (\Exception $e) {
            $transaction->rollBack();
            throw $e;
        }

        $transaction->commit();
        return true;
    }

    /*******************************************
     * DISSOCIATE
     *******************************************/

    /**
     * @param Domain $model
     * @param bool $autoReorder
     * @return bool
     * @throws \Exception
     */
    public function dissociate(
        Domain $model,
        bool $autoReorder = true
    ) {
        if (!$this->associationExists($model)) {
            return true;
        }

        $event = new DomainAssociationEvent([
            'domain' => $model
        ]);

        // Trigger event
        $this->trigger(
            static::EVENT_BEFORE_DISSOCIATE,
            $event
        );

        // Green light?
        if (!$event->isValid) {
            DomainsPlugin::info(
                "Event aborted dissociation.",
                __METHOD__
            );
            return false;
        }

        $tableName = DomainsPlugin::getInstance()->getField()->getTableName($model->getField());

        $transaction = Craft::$app->getDb()->beginTransaction();
        try {
            $this->deleteRecord(
                $tableName,
                $model->getElementId(),
                $model->domain,
                $model->getSiteId()
            );

            $this->trigger(
                static::EVENT_AFTER_DISSOCIATE,
                $event
            );

            // Reorder?
            if ($autoReorder === true &&
                !$this->autoReorder($tableName, $model->getElementId(), $model->getSiteId())
            ) {
                $transaction->rollBack();
                return false;
            }
        } catch (\Exception $e) {
            $transaction->rollBack();
            throw $e;
        }

        $transaction->commit();
        return true;
    }

    /*******************************************
     * ORDER
     *******************************************/

    /**
     * @param string $tableName
     * @param int $elementId
     * @param int $siteId
     * @param array $sortOrder
     * @return bool
     * @throws \yii\db\Exception
     */
    public function updateOrder(
        string $tableName,
        int $elementId,
        int $siteId,
        array $sortOrder
    ): bool {
        $db = Craft::$app->getDb();

        foreach ($sortOrder as $domain => $order) {
            $db->createCommand()
                ->update(
                    $tableName,
                    ['sortOrder' => $order],
                    [
                        'domain' => $domain,
                        'elementId' => $elementId,
                        'siteId' => $siteId
                    ]
                )
                ->execute();
        }

        return true;
    }

    /*******************************************
     * INSERT / DELETE
     *******************************************/

    /**
     * @param string $tableName
     * @param int $elementId
     * @param string $domain
     * @param string $status
     * @param int $sortOrder
     * @param int $siteId
     * @return bool
     * @throws \yii\db\Exception
     */
    private function insertRecord(
        string $tableName,
        int $elementId,
        string $domain,
        string $status,
        int $sortOrder,
        int $siteId
    ): bool {
        if (!$successful = (bool)Craft::$app->getDb()->createCommand()->insert(
            $tableName,
            [
                'elementId' => $elementId,
                'domain' => $domain,
                'status' => $status,
                'sortOrder' => $sortOrder,
                'siteId' => $siteId
            ]
        )->execute()) {
            DomainsPlugin::trace(
                sprintf(
                    "Failed to associate domain '%s' to element '%s' for site '%s'.",
                    (string)$domain,
                    (string)$elementId,
                    (string)$siteId
                ),
                __METHOD__
            );
            return false;
        }

        DomainsPlugin::trace(
            sprintf(
                "Successfully associated domain '%s' to element '%s' for site '%s'.",
                (string)$domain,
                (string)$elementId,
                (string)$siteId
            ),
            __METHOD__
        );

        return true;
    }

    /**
     * @param string $tableName
     * @param int $elementId
     * @param string $domain
     * @param int $siteId
     * @return bool
     * @throws \yii\db\Exception
     */
    private function deleteRecord(
        string $tableName,
        int $elementId,
        string $domain,
        int $siteId
    ): bool {
        if (!$successful = (bool)Craft::$app->getDb()->createCommand()->delete(
            $tableName,
            [
                'elementId' => $elementId,
                'domain' => $domain,
                'siteId' => $siteId
            ]
        )->execute()) {
            DomainsPlugin::trace(
                sprintf(
                    "Failed to dissociate domain '%s' with element '%s' for site '%s'.",
                    (string)$domain,
                    (string)$elementId,
                    (string)$siteId
                ),
                __METHOD__
            );
            return false;
        }

        DomainsPlugin::trace(
            sprintf(
                "Successfully dissociated domain '%s' with element '%s' for site '%s'",
                (string)$domain,
                (string)$elementId,
                (string)$siteId
            ),
            __METHOD__
        );

        return true;
    }


    /*******************************************
     * ASSOCIATE / DISSOCIATE MANY
     *******************************************/

    /**
     * @param ElementInterface|Element $element
     * @param array $models
     * @param array $currentModels
     * @param array $newOrder
     * @return bool
     * @throws \Exception
     */
    private function associateAll(
        ElementInterface $element,
        array $models,
        array &$currentModels,
        array &$newOrder
    ): bool {
        $ct = 1;
        foreach ($models as $model) {
            $model->setElement($element);
            $model->setSiteId($element->siteId);
interface SomeInterface { }
class SomeClass implements SomeInterface {
    public $a;
}

function someFunction(SomeInterface $object) {
    if ($object instanceof SomeClass) {
        $a = $object->a;
    }
}
            $model->sortOrder = $ct;

            $newOrder[$model->domain] = $ct++;

            if (null !== ArrayHelper::remove($currentModels, $model->domain)) {
                continue;
            }

            if (!$this->associate($model)) {
                return false;
            }
        }

        return true;
    }

    /**
     * @param ElementInterface|Element $element
     * @param array $models
     * @return bool
     * @throws \Exception
     */
    private function dissociateAll(
        ElementInterface $element,
        array $models
    ): bool {
        foreach ($models as $model) {
            $model->setElement($element);
            $model->setSiteId($element->siteId);
interface SomeInterface { }
class SomeClass implements SomeInterface {
    public $a;
}

function someFunction(SomeInterface $object) {
    if ($object instanceof SomeClass) {
        $a = $object->a;
    }
}

            if (!$this->dissociate($model)) {
                return false;
            }
        }

        return true;
    }

    /*******************************************
     * SORT ORDER
     *******************************************/

    /**
     * @param Domain $model
     * @return bool
     * @throws \Exception
     * @throws \yii\db\Exception
     */
    private function applySortOrder(
        Domain $model
    ): bool {
        $tableName = DomainsPlugin::getInstance()->getField()->getTableName($model->getField());

        $currentSortOrder = $this->currentSortOrder($tableName, $model->getElementId(), $model->getSiteId());

        if (count($currentSortOrder) < $model->sortOrder) {
            $model->sortOrder = count($currentSortOrder);
        }

        $order = ArrayHelper::insertSequential($currentSortOrder, $model->domain, $model->sortOrder);

        if ($order === false) {
            return $this->associate($model);
        }

        if ($order === true) {
            return true;
        }

        return $this->updateOrder(
            $tableName,
            $model->getElementId(),
            $model->getSiteId(),
            $order
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
        );
    }

    /**
     * @param Domain $model
     * @return int
     */
    private function nextSortOrder(
        Domain $model
    ): int {
        $maxSortOrder = $this->baseAssociationQuery(
            DomainsPlugin::getInstance()->getField()->getTableName($model->getField()),
            $model->getElementId(),
            $model->getSiteId()
        )->max('[[sortOrder]]');

        $maxSortOrder++;

        return $maxSortOrder;
    }

    /**
     * Re-orders so they are in sequential order
     *
     * @param string $tableName
     * @param int $elementId
     * @param int $siteId
     * @return bool
     * @throws \yii\db\Exception
     */
    protected function autoReorder(string $tableName, int $elementId, int $siteId): bool
    {
        $currentSortOrder = $this->currentSortOrder($tableName, $elementId, $siteId);

        if (empty($currentSortOrder)) {
            return true;
        }

        return $this->updateOrder(
            $tableName,
            $elementId,
            $siteId,
            array_combine(
                range(1, count($currentSortOrder)),
                array_keys($currentSortOrder)
            )
        );
    }

    /**
     * @param Domains $field
     * @param ElementInterface|Element $element
     * @return array|null
     */
    protected function getCurrentDomainAssociations(Domains $field, ElementInterface $element)
    {
        return (new DomainsQuery($field))
            ->siteId($element->siteId)
interface SomeInterface { }
class SomeClass implements SomeInterface {
    public $a;
}

function someFunction(SomeInterface $object) {
    if ($object instanceof SomeClass) {
        $a = $object->a;
    }
}
            ->elementId($element->getId())
            ->indexBy('domain')
            ->all();
    }

    /**
     * @param string $tableName
     * @param int $elementId
     * @param int $siteId
     * @return array
     */
    private function currentSortOrder(string $tableName, int $elementId, int $siteId): array
    {
        return $this->baseAssociationQuery($tableName, $elementId, $siteId)
            ->indexBy('domain')
            ->select(['sortOrder'])
            ->column();
    }

    /**
     * @param string $tableName
     * @param int $elementId
     * @param int $siteId
     * @return Query
     */
    private function baseAssociationQuery(string $tableName, int $elementId, int $siteId): Query
    {
        return (new Query())
            ->from($tableName)
            ->where([
                'elementId' => $elementId,
                'siteId' => $siteId
            ])
            ->orderBy(['sortOrder' => SORT_ASC]);
    }

    /*******************************************
     * UTILITIES
     *******************************************/

    /**
     * @param Domain $model
     * @return bool
     */
    private function associationExists(
        Domain $model
    ): bool {
        $tableName = DomainsPlugin::getInstance()->getField()->getTableName($model->getField());

        $condition = [
            'domain' => $model->domain,
        ];

        if ($model->sortOrder !== null) {
            $condition['sortOrder'] = $model->sortOrder;
        }

        return $this->baseAssociationQuery($tableName, $model->getElementId(), $model->getSiteId())
            ->andWhere($condition)
            ->exists();
    }

    /**
     * @param string $tableName
     * @param array $newOrder
     * @param ElementInterface|Element $element
     * @return bool
     * @throws \yii\db\Exception
     */
    private function reOrderIfChanged(string $tableName, array $newOrder, ElementInterface $element)
    {
        $currentOrder = $this->currentSortOrder($tableName, $element->getId(), $element->siteId);
interface SomeInterface { }
class SomeClass implements SomeInterface {
    public $a;
}

function someFunction(SomeInterface $object) {
    if ($object instanceof SomeClass) {
        $a = $object->a;
    }
}

        if ((empty($currentOrder) && empty($newOrder)) || $currentOrder == $newOrder) {
            return true;
        }

        if (!$this->updateOrder($tableName, $element->getId(), $element->siteId, $newOrder)) {
interface SomeInterface { }
class SomeClass implements SomeInterface {
    public $a;
}

function someFunction(SomeInterface $object) {
    if ($object instanceof SomeClass) {
        $a = $object->a;
    }
}
            return false;
        }

        return true;
    }
}


Branch — master (fafb06)

DomainAssociations B

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

16 Methods

How to fix Complexity

Complex Class

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

1			<?php
2
3			/**
4			* @copyright Copyright (c) Flipbox Digital Limited
5			* @license https://flipboxfactory.com/software/domains/license
6			* @link https://www.flipboxfactory.com/software/domains/
7			*/
8
9			namespace flipbox\domains\services;
10
11			use Craft;
12			use craft\base\Element;
13			use craft\base\ElementInterface;
14			use craft\db\Query;
15			use flipbox\domains\db\DomainsQuery;
16			use flipbox\domains\Domains as DomainsPlugin;
17			use flipbox\domains\events\DomainAssociationEvent;
18			use flipbox\domains\fields\Domains;
			0 ignored issues – show Bug introduced 2018-03-01 14:58 UTC by Report Bug Copy Issue Report This use statement conflicts with another class in this namespace, `flipbox\domains\services\Domains`. Let’s assume that you have a directory layout like this: . \|-- OtherDir \| \|-- Bar.php \| `-- Foo.php `-- SomeDir `-- Foo.php and let’s assume the following content of `Bar.php`: // Bar.php namespace OtherDir; use SomeDir\Foo; // This now conflicts the class OtherDir\Foo If both files `OtherDir/Foo.php` and `SomeDir/Foo.php` are loaded in the same runtime, you will see a PHP error such as the following: PHP Fatal error: Cannot use SomeDir\Foo as Foo because the name is already in use in OtherDir/Foo.php However, as `OtherDir/Foo.php` does not necessarily have to be loaded and the error is only triggered if it is loaded before `OtherDir/Bar.php`, this problem might go unnoticed for a while. In order to prevent this error from surfacing, you must import the namespace with a different alias: // Bar.php namespace OtherDir; use SomeDir\Foo as SomeDirFoo; // There is no conflict anymore. Loading history...
19			use flipbox\domains\models\Domain;
20			use flipbox\ember\helpers\ArrayHelper;
21			use yii\base\Component;
22
23			/**
24			* @author Flipbox Factory <[email protected]>
25			* @since 1.0.0
26			*/
27			class DomainAssociations extends Component
28			{
29			/**
30			* @event DomainAssociationEvent The event that is triggered before a domain association.
31			*
32			* You may set [[DomainAssociationEvent::isValid]] to `false` to prevent the associate action.
33			*/
34			const EVENT_BEFORE_ASSOCIATE = 'beforeAssociate';
35
36			/**
37			* @event DomainAssociationEvent The event that is triggered after a domain association.
38			*/
39			const EVENT_AFTER_ASSOCIATE = 'afterAssociate';
40
41			/**
42			* @event DomainAssociationEvent The event that is triggered before a domain dissociation.
43			*
44			* You may set [[DomainAssociationEvent::isValid]] to `false` to prevent the dissociate action.
45			*/
46			const EVENT_BEFORE_DISSOCIATE = 'beforeDissociate';
47
48			/**
49			* @event DomainAssociationEvent The event that is triggered after a domain dissociation.
50			*/
51			const EVENT_AFTER_DISSOCIATE = 'afterDissociate';
52
53			/**
54			* @param Domains $field
55			* @param DomainsQuery $query
56			* @param ElementInterface\|Element $element
57			* @return bool
58			* @throws \Exception
59			*/
60			public function save(
61			Domains $field,
62			DomainsQuery $query,
63			ElementInterface $element
64			) {
65			// Nothing to save
66			if (null === ($models = $query->getCachedResult())) {
67			return true;
68			}
69
70			$transaction = Craft::$app->getDb()->beginTransaction();
71			try {
72			$currentModels = $this->getCurrentDomainAssociations($field, $element);
73
74			$newOrder = [];
75			if (!$this->associateAll($element, $models, $currentModels, $newOrder)) {
			0 ignored issues – show Bug introduced 2018-03-01 14:58 UTC by Report Bug Copy Issue Report It seems like `$currentModels` defined by `$this->getCurrentDomainA...tions($field, $element)` on line `72` can also be of type `null`; however, `flipbox\domains\services...iations::associateAll()` does only seem to accept `array`, maybe add an additional type check? If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check: /** * @return array\|string */ function returnsDifferentValues($x) { if ($x) { return 'foo'; } return array(); } $x = returnsDifferentValues($y); if (is_array($x)) { // $x is an array. } If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue. Loading history...
76			$transaction->rollBack();
77			return false;
78			}
79
80			if (!$this->dissociateAll($element, $currentModels)) {
81			$transaction->rollBack();
82			return false;
83			}
84
85			if (!$this->reOrderIfChanged(
86			DomainsPlugin::getInstance()->getField()->getTableName($field),
87			$newOrder,
88			$element
89			)) {
90			$transaction->rollBack();
91			return false;
92			}
93			} catch (\Exception $e) {
94			$transaction->rollBack();
95			throw $e;
96			}
97
98			$transaction->commit();
99			return true;
100			}
101
102			/*******************************************
103			* ASSOCIATE
104			*******************************************/
105
106			/**
107			* @param Domain $model
108			* @return bool
109			* @throws \Exception
110			*/
111			public function associate(Domain $model): bool
112			{
113
114			if ($model->sortOrder === null) {
115			$model->sortOrder = $this->nextSortOrder($model);
116			}
117
118			if ($this->associationExists($model)) {
119			return $this->applySortOrder($model);
120			}
121
122			$event = new DomainAssociationEvent([
123			'domain' => $model
124			]);
125
126			$this->trigger(
127			static::EVENT_BEFORE_ASSOCIATE,
128			$event
129			);
130
131			// Green light?
132			if (!$event->isValid) {
133			DomainsPlugin::info(
134			"Event aborted association.",
135			__METHOD__
136			);
137
138			return false;
139			}
140
141			$transaction = Craft::$app->getDb()->beginTransaction();
142			try {
143			if (!$this->insertRecord(
144			DomainsPlugin::getInstance()->getField()->getTableName($model->getField()),
145			$model->getElementId(),
146			$model->domain,
147			$model->status,
148			$model->sortOrder,
149			$model->getSiteId()
150			)) {
151			$transaction->rollBack();
152			return false;
153			}
154
155			$this->trigger(
156			static::EVENT_AFTER_ASSOCIATE,
157			$event
158			);
159			} catch (\Exception $e) {
160			$transaction->rollBack();
161			throw $e;
162			}
163
164			$transaction->commit();
165			return true;
166			}
167
168			/*******************************************
169			* DISSOCIATE
170			*******************************************/
171
172			/**
173			* @param Domain $model
174			* @param bool $autoReorder
175			* @return bool
176			* @throws \Exception
177			*/
178			public function dissociate(
179			Domain $model,
180			bool $autoReorder = true
181			) {
182			if (!$this->associationExists($model)) {
183			return true;
184			}
185
186			$event = new DomainAssociationEvent([
187			'domain' => $model
188			]);
189
190			// Trigger event
191			$this->trigger(
192			static::EVENT_BEFORE_DISSOCIATE,
193			$event
194			);
195
196			// Green light?
197			if (!$event->isValid) {
198			DomainsPlugin::info(
199			"Event aborted dissociation.",
200			__METHOD__
201			);
202			return false;
203			}
204
205			$tableName = DomainsPlugin::getInstance()->getField()->getTableName($model->getField());
206
207			$transaction = Craft::$app->getDb()->beginTransaction();
208			try {
209			$this->deleteRecord(
210			$tableName,
211			$model->getElementId(),
212			$model->domain,
213			$model->getSiteId()
214			);
215
216			$this->trigger(
217			static::EVENT_AFTER_DISSOCIATE,
218			$event
219			);
220
221			// Reorder?
222			if ($autoReorder === true &&
223			!$this->autoReorder($tableName, $model->getElementId(), $model->getSiteId())
224			) {
225			$transaction->rollBack();
226			return false;
227			}
228			} catch (\Exception $e) {
229			$transaction->rollBack();
230			throw $e;
231			}
232
233			$transaction->commit();
234			return true;
235			}
236
237			/*******************************************
238			* ORDER
239			*******************************************/
240
241			/**
242			* @param string $tableName
243			* @param int $elementId
244			* @param int $siteId
245			* @param array $sortOrder
246			* @return bool
247			* @throws \yii\db\Exception
248			*/
249			public function updateOrder(
250			string $tableName,
251			int $elementId,
252			int $siteId,
253			array $sortOrder
254			): bool {
255			$db = Craft::$app->getDb();
256
257			foreach ($sortOrder as $domain => $order) {
258			$db->createCommand()
259			->update(
260			$tableName,
261			['sortOrder' => $order],
262			[
263			'domain' => $domain,
264			'elementId' => $elementId,
265			'siteId' => $siteId
266			]
267			)
268			->execute();
269			}
270
271			return true;
272			}
273
274			/*******************************************
275			* INSERT / DELETE
276			*******************************************/
277
278			/**
279			* @param string $tableName
280			* @param int $elementId
281			* @param string $domain
282			* @param string $status
283			* @param int $sortOrder
284			* @param int $siteId
285			* @return bool
286			* @throws \yii\db\Exception
287			*/
288			private function insertRecord(
289			string $tableName,
290			int $elementId,
291			string $domain,
292			string $status,
293			int $sortOrder,
294			int $siteId
295			): bool {
296			if (!$successful = (bool)Craft::$app->getDb()->createCommand()->insert(
297			$tableName,
298			[
299			'elementId' => $elementId,
300			'domain' => $domain,
301			'status' => $status,
302			'sortOrder' => $sortOrder,
303			'siteId' => $siteId
304			]
305			)->execute()) {
306			DomainsPlugin::trace(
307			sprintf(
308			"Failed to associate domain '%s' to element '%s' for site '%s'.",
309			(string)$domain,
310			(string)$elementId,
311			(string)$siteId
312			),
313			__METHOD__
314			);
315			return false;
316			}
317
318			DomainsPlugin::trace(
319			sprintf(
320			"Successfully associated domain '%s' to element '%s' for site '%s'.",
321			(string)$domain,
322			(string)$elementId,
323			(string)$siteId
324			),
325			__METHOD__
326			);
327
328			return true;
329			}
330
331			/**
332			* @param string $tableName
333			* @param int $elementId
334			* @param string $domain
335			* @param int $siteId
336			* @return bool
337			* @throws \yii\db\Exception
338			*/
339			private function deleteRecord(
340			string $tableName,
341			int $elementId,
342			string $domain,
343			int $siteId
344			): bool {
345			if (!$successful = (bool)Craft::$app->getDb()->createCommand()->delete(
346			$tableName,
347			[
348			'elementId' => $elementId,
349			'domain' => $domain,
350			'siteId' => $siteId
351			]
352			)->execute()) {
353			DomainsPlugin::trace(
354			sprintf(
355			"Failed to dissociate domain '%s' with element '%s' for site '%s'.",
356			(string)$domain,
357			(string)$elementId,
358			(string)$siteId
359			),
360			__METHOD__
361			);
362			return false;
363			}
364
365			DomainsPlugin::trace(
366			sprintf(
367			"Successfully dissociated domain '%s' with element '%s' for site '%s'",
368			(string)$domain,
369			(string)$elementId,
370			(string)$siteId
371			),
372			__METHOD__
373			);
374
375			return true;
376			}
377
378
379			/*******************************************
380			* ASSOCIATE / DISSOCIATE MANY
381			*******************************************/
382
383			/**
384			* @param ElementInterface\|Element $element
385			* @param array $models
386			* @param array $currentModels
387			* @param array $newOrder
388			* @return bool
389			* @throws \Exception
390			*/
391			private function associateAll(
392			ElementInterface $element,
393			array $models,
394			array &$currentModels,
395			array &$newOrder
396			): bool {
397			$ct = 1;
398			foreach ($models as $model) {
399			$model->setElement($element);
400			$model->setSiteId($element->siteId);
			1 ignored issue – show Bug introduced 2017-11-06 17:36 UTC by Report Bug Copy Issue Report Accessing `siteId` on the interface `craft\base\ElementInterface` suggest that you code against a concrete implementation. How about adding an `instanceof` check? If you access a property on an interface, you most likely code against a concrete implementation of the interface. Available Fixes Adding an additional type check: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeInterface $object) { if ($object instanceof SomeClass) { $a = $object->a; } } Changing the type hint: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeClass $object) { $a = $object->a; } Loading history...
401			$model->sortOrder = $ct;
402
403			$newOrder[$model->domain] = $ct++;
404
405			if (null !== ArrayHelper::remove($currentModels, $model->domain)) {
406			continue;
407			}
408
409			if (!$this->associate($model)) {
410			return false;
411			}
412			}
413
414			return true;
415			}
416
417			/**
418			* @param ElementInterface\|Element $element
419			* @param array $models
420			* @return bool
421			* @throws \Exception
422			*/
423			private function dissociateAll(
424			ElementInterface $element,
425			array $models
426			): bool {
427			foreach ($models as $model) {
428			$model->setElement($element);
429			$model->setSiteId($element->siteId);
			1 ignored issue – show Bug introduced 2018-03-01 14:58 UTC by Report Bug Copy Issue Report Accessing `siteId` on the interface `craft\base\ElementInterface` suggest that you code against a concrete implementation. How about adding an `instanceof` check? If you access a property on an interface, you most likely code against a concrete implementation of the interface. Available Fixes Adding an additional type check: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeInterface $object) { if ($object instanceof SomeClass) { $a = $object->a; } } Changing the type hint: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeClass $object) { $a = $object->a; } Loading history...
430
431			if (!$this->dissociate($model)) {
432			return false;
433			}
434			}
435
436			return true;
437			}
438
439			/*******************************************
440			* SORT ORDER
441			*******************************************/
442
443			/**
444			* @param Domain $model
445			* @return bool
446			* @throws \Exception
447			* @throws \yii\db\Exception
448			*/
449			private function applySortOrder(
450			Domain $model
451			): bool {
452			$tableName = DomainsPlugin::getInstance()->getField()->getTableName($model->getField());
453
454			$currentSortOrder = $this->currentSortOrder($tableName, $model->getElementId(), $model->getSiteId());
455
456			if (count($currentSortOrder) < $model->sortOrder) {
457			$model->sortOrder = count($currentSortOrder);
458			}
459
460			$order = ArrayHelper::insertSequential($currentSortOrder, $model->domain, $model->sortOrder);
461
462			if ($order === false) {
463			return $this->associate($model);
464			}
465
466			if ($order === true) {
467			return true;
468			}
469
470			return $this->updateOrder(
471			$tableName,
472			$model->getElementId(),
473			$model->getSiteId(),
474			$order
			0 ignored issues – show Bug introduced 2018-03-01 14:58 UTC by Report Bug Copy Issue Report It seems like `$order` defined by `\flipbox\ember\helpers\A...ain, $model->sortOrder)` on line `460` can also be of type `boolean`; however, `flipbox\domains\services...ciations::updateOrder()` does only seem to accept `array`, maybe add an additional type check? If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check: /** * @return array\|string */ function returnsDifferentValues($x) { if ($x) { return 'foo'; } return array(); } $x = returnsDifferentValues($y); if (is_array($x)) { // $x is an array. } If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue. Loading history...
475			);
476			}
477
478			/**
479			* @param Domain $model
480			* @return int
481			*/
482			private function nextSortOrder(
483			Domain $model
484			): int {
485			$maxSortOrder = $this->baseAssociationQuery(
486			DomainsPlugin::getInstance()->getField()->getTableName($model->getField()),
487			$model->getElementId(),
488			$model->getSiteId()
489			)->max('[[sortOrder]]');
490
491			$maxSortOrder++;
492
493			return $maxSortOrder;
494			}
495
496			/**
497			* Re-orders so they are in sequential order
498			*
499			* @param string $tableName
500			* @param int $elementId
501			* @param int $siteId
502			* @return bool
503			* @throws \yii\db\Exception
504			*/
505			protected function autoReorder(string $tableName, int $elementId, int $siteId): bool
506			{
507			$currentSortOrder = $this->currentSortOrder($tableName, $elementId, $siteId);
508
509			if (empty($currentSortOrder)) {
510			return true;
511			}
512
513			return $this->updateOrder(
514			$tableName,
515			$elementId,
516			$siteId,
517			array_combine(
518			range(1, count($currentSortOrder)),
519			array_keys($currentSortOrder)
520			)
521			);
522			}
523
524			/**
525			* @param Domains $field
526			* @param ElementInterface\|Element $element
527			* @return array\|null
528			*/
529			protected function getCurrentDomainAssociations(Domains $field, ElementInterface $element)
530			{
531			return (new DomainsQuery($field))
532			->siteId($element->siteId)
			1 ignored issue – show Bug introduced 2017-11-06 17:36 UTC by Report Bug Copy Issue Report Accessing `siteId` on the interface `craft\base\ElementInterface` suggest that you code against a concrete implementation. How about adding an `instanceof` check? If you access a property on an interface, you most likely code against a concrete implementation of the interface. Available Fixes Adding an additional type check: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeInterface $object) { if ($object instanceof SomeClass) { $a = $object->a; } } Changing the type hint: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeClass $object) { $a = $object->a; } Loading history...
533			->elementId($element->getId())
534			->indexBy('domain')
535			->all();
536			}
537
538			/**
539			* @param string $tableName
540			* @param int $elementId
541			* @param int $siteId
542			* @return array
543			*/
544			private function currentSortOrder(string $tableName, int $elementId, int $siteId): array
545			{
546			return $this->baseAssociationQuery($tableName, $elementId, $siteId)
547			->indexBy('domain')
548			->select(['sortOrder'])
549			->column();
550			}
551
552			/**
553			* @param string $tableName
554			* @param int $elementId
555			* @param int $siteId
556			* @return Query
557			*/
558			private function baseAssociationQuery(string $tableName, int $elementId, int $siteId): Query
559			{
560			return (new Query())
561			->from($tableName)
562			->where([
563			'elementId' => $elementId,
564			'siteId' => $siteId
565			])
566			->orderBy(['sortOrder' => SORT_ASC]);
567			}
568
569			/*******************************************
570			* UTILITIES
571			*******************************************/
572
573			/**
574			* @param Domain $model
575			* @return bool
576			*/
577			private function associationExists(
578			Domain $model
579			): bool {
580			$tableName = DomainsPlugin::getInstance()->getField()->getTableName($model->getField());
581
582			$condition = [
583			'domain' => $model->domain,
584			];
585
586			if ($model->sortOrder !== null) {
587			$condition['sortOrder'] = $model->sortOrder;
588			}
589
590			return $this->baseAssociationQuery($tableName, $model->getElementId(), $model->getSiteId())
591			->andWhere($condition)
592			->exists();
593			}
594
595			/**
596			* @param string $tableName
597			* @param array $newOrder
598			* @param ElementInterface\|Element $element
599			* @return bool
600			* @throws \yii\db\Exception
601			*/
602			private function reOrderIfChanged(string $tableName, array $newOrder, ElementInterface $element)
603			{
604			$currentOrder = $this->currentSortOrder($tableName, $element->getId(), $element->siteId);
			1 ignored issue – show Bug introduced 2018-03-01 14:58 UTC by Report Bug Copy Issue Report Accessing `siteId` on the interface `craft\base\ElementInterface` suggest that you code against a concrete implementation. How about adding an `instanceof` check? If you access a property on an interface, you most likely code against a concrete implementation of the interface. Available Fixes Adding an additional type check: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeInterface $object) { if ($object instanceof SomeClass) { $a = $object->a; } } Changing the type hint: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeClass $object) { $a = $object->a; } Loading history...
605
606			if ((empty($currentOrder) && empty($newOrder)) \|\| $currentOrder == $newOrder) {
607			return true;
608			}
609
610			if (!$this->updateOrder($tableName, $element->getId(), $element->siteId, $newOrder)) {
			1 ignored issue – show Bug introduced 2018-03-01 14:58 UTC by Report Bug Copy Issue Report Accessing `siteId` on the interface `craft\base\ElementInterface` suggest that you code against a concrete implementation. How about adding an `instanceof` check? If you access a property on an interface, you most likely code against a concrete implementation of the interface. Available Fixes Adding an additional type check: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeInterface $object) { if ($object instanceof SomeClass) { $a = $object->a; } } Changing the type hint: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeClass $object) { $a = $object->a; } Loading history...
611			return false;
612			}
613
614			return true;
615			}
616			}
617

flipboxfactory / craft-domains

Branch — master (fafb06)

DomainAssociations B

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

16 Methods

How to fix Complexity

Complex Class

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like