ResourceAssociations::save() - Code Metrics - Inspection of "adding relay-hubspot as a dependency" - flipboxfactory/craft-hubspot - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — develop ( f37ae4...1d947e )

by Nate

created 2018-06-26 19:44 UTC

ResourceAssociations::save() B

↳ Parent: ResourceAssociations

Complexity

Conditions	6
Paths	3

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	42

Importance

Changes

Metric	Value
dl	0
loc	22
ccs	0
cts	20
cp	0
rs	8.9457
c	0
b	0
f	0
cc	6
nc	3
nop	2
crap	42

<?php

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

namespace flipbox\hubspot\services;

use craft\base\ElementInterface;
use craft\errors\ElementNotFoundException;
use craft\helpers\Json;
use flipbox\hubspot\db\ResourceAssociationQuery;
use flipbox\hubspot\fields\Resources;
.
|-- OtherDir
|   |-- Bar.php
|   `-- Foo.php
`-- SomeDir
    `-- Foo.php
use flipbox\hubspot\HubSpot;
use flipbox\hubspot\records\ResourceAssociation;
use flipbox\craft\sortable\associations\db\SortableAssociationQueryInterface;
use flipbox\craft\sortable\associations\records\SortableAssociationInterface;
use flipbox\craft\sortable\associations\services\SortableAssociations;
use flipbox\ember\services\traits\records\Accessor;
use flipbox\ember\validators\MinMaxValidator;

/**
 * @author Flipbox Factory <[email protected]>
 * @since 1.0.0
 *
 * @method ResourceAssociationQuery parentGetQuery($config = [])
 * @method ResourceAssociation create(array $attributes = [])
 * @method ResourceAssociation find($identifier)
 * @method ResourceAssociation get($identifier)
 * @method ResourceAssociation findByCondition($condition = [])
 * @method ResourceAssociation getByCondition($condition = [])
 * @method ResourceAssociation findByCriteria($criteria = [])
 * @method ResourceAssociation getByCriteria($criteria = [])
 * @method ResourceAssociation[] findAllByCondition($condition = [])
 * @method ResourceAssociation[] getAllByCondition($condition = [])
 * @method ResourceAssociation[] findAllByCriteria($criteria = [])
 * @method ResourceAssociation[] getAllByCriteria($criteria = [])
 */
class ResourceAssociations extends SortableAssociations
{
    use Accessor {
        getQuery as parentGetQuery;
    }

    /**
     * @inheritdoc
     */
    const SOURCE_ATTRIBUTE = ResourceAssociation::SOURCE_ATTRIBUTE;

    /**
     * @inheritdoc
     */
    const TARGET_ATTRIBUTE = ResourceAssociation::TARGET_ATTRIBUTE;

    /**
     * @inheritdoc
     */
    public function init()
    {
        $settings = HubSpot::getInstance()->getSettings();
        $this->cacheDuration = $settings->associationsCacheDuration;
        $this->cacheDependency = $settings->associationsCacheDependency;

        parent::init();
    }

    /**
     * @inheritdoc
     * @return ResourceAssociationQuery
     */
    public function getQuery($config = []): SortableAssociationQueryInterface
    {
        return $this->parentGetQuery($config);
    }

    /**
     * @inheritdoc
     * @param ResourceAssociation $record
     * @return ResourceAssociationQuery
     */
    protected function associationQuery(
        SortableAssociationInterface $record
    ): SortableAssociationQueryInterface {
        return $this->query(
            $record->{static::SOURCE_ATTRIBUTE},
            $record->fieldId,
interface SomeInterface { }
class SomeClass implements SomeInterface {
    public $a;
}

function someFunction(SomeInterface $object) {
    if ($object instanceof SomeClass) {
        $a = $object->a;
    }
}
            $record->siteId
interface SomeInterface { }
class SomeClass implements SomeInterface {
    public $a;
}

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

    /**
     * @inheritdoc
     * @param ResourceAssociationQuery $query
     */
    protected function existingAssociations(
        SortableAssociationQueryInterface $query
    ): array {
        $source = $this->resolveStringAttribute($query, 'element');
        $field = $this->resolveStringAttribute($query, 'field');
        $site = $this->resolveStringAttribute($query, 'siteId');

        if ($source === null || $field === null || $site === null) {
            return [];
        }

        return $this->associations($source, $field, $site);
    }


    /**
     * @param string $hubSpotId
     * @return ElementInterface
     * @throws ElementNotFoundException
     */
    public function getElementByHubSpotId(string $hubSpotId): ElementInterface
    {
        if (!$element = $this->findElementByHubSpotId($hubSpotId)) {
            throw new ElementNotFoundException(sprintf(
                "Unable to get element from HubSpot Id: '%s'.",
                $hubSpotId
            ));
        }

        return $element;
    }

    /**
     * @param string $hubSpotId
     * @return ElementInterface|null
     */
    public function findElementByHubSpotId(string $hubSpotId)
    {
        $record = $this->findByCondition([
            'objectId' => $hubSpotId
        ]);

        if ($record === null) {
            return null;
        }

        return $record->getElement();
    }

    /**
     * Find the HubSpot Id by Element Id
     *
     * @param int $id
     * @return string|null
     */
    public function findHubSpotIdByElementId(int $id)
    {
        $hubSpotId = $this->getQuery()
            ->select(['hubSpotId'])
            ->element($id)
            ->scalar();

        if (!$hubSpotId) {
            return null;
        }

        return $hubSpotId;
    }


    /**
     * @param $source
     * @param int $fieldId
     * @param int $siteId
     * @return ResourceAssociationQuery
     */
    private function query(
        $source,
        int $fieldId,
        int $siteId
    ): ResourceAssociationQuery {
        return $this->getQuery()
            ->where([
                static::SOURCE_ATTRIBUTE => $source,
                'fieldId' => $fieldId,
                'siteId' => $siteId
            ])
            ->orderBy(['sortOrder' => SORT_ASC]);
    }

    /**
     * @param $source
     * @param int $fieldId
     * @param int $siteId
     * @return array
     */
    private function associations(
        $source,
        int $fieldId,
        int $siteId
    ): array {
        return $this->query($source, $fieldId, $siteId)
            ->indexBy(static::TARGET_ATTRIBUTE)
            ->all();
    }

    /**
     * @inheritdoc
     * @param bool $validate
     * @throws \Exception
     */
    public function save(
        SortableAssociationQueryInterface $query,
        bool $validate = true
    ): bool {
        if ($validate === true && null !== ($field = $this->resolveFieldFromQuery($query))) {
            $error = '';
            (new MinMaxValidator([
                'min' => $field->min ? (int)$field->min : null,
                'max' => $field->max ? (int)$field->max : null
            ]))->validate($query, $error);

            if (!empty($error)) {
                HubSpot::error(sprintf(
                    "Hubspot Resource failed to save due to the following validation errors: '%s'",
                    Json::encode($error)
                ));
                return false;
            }
        }

        return parent::save($query);
    }

    /**
     * @param SortableAssociationQueryInterface $query
     * @return Resources|null
     */
    protected function resolveFieldFromQuery(
        SortableAssociationQueryInterface $query
    ) {
        if (null === ($fieldId = $this->resolveStringAttribute($query, 'field'))) {
            return null;
        }

        return HubSpot::getInstance()->getResourcesField()->findById($fieldId);
    }

    /**
     * @inheritdoc
     */
    protected static function tableAlias(): string
    {
        return ResourceAssociation::tableAlias();
    }

    /**
     * @inheritdoc
     */
    public static function recordClass(): string
    {
        return ResourceAssociation::class;
    }
}


Push — develop ( f37ae4...1d947e )

ResourceAssociations::save() B

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Available Fixes

1			<?php
2
3			/**
4			* @copyright Copyright (c) Flipbox Digital Limited
5			* @license https://flipboxfactory.com/software/hubspot/license
6			* @link https://www.flipboxfactory.com/software/hubspot/
7			*/
8
9			namespace flipbox\hubspot\services;
10
11			use craft\base\ElementInterface;
12			use craft\errors\ElementNotFoundException;
13			use craft\helpers\Json;
14			use flipbox\hubspot\db\ResourceAssociationQuery;
15			use flipbox\hubspot\fields\Resources;
			0 ignored issues – show Bug introduced 2018-06-26 20:03 UTC by Report Bug Copy Issue Report This use statement conflicts with another class in this namespace, `flipbox\hubspot\services\Resources`. 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...
16			use flipbox\hubspot\HubSpot;
17			use flipbox\hubspot\records\ResourceAssociation;
18			use flipbox\craft\sortable\associations\db\SortableAssociationQueryInterface;
19			use flipbox\craft\sortable\associations\records\SortableAssociationInterface;
20			use flipbox\craft\sortable\associations\services\SortableAssociations;
21			use flipbox\ember\services\traits\records\Accessor;
22			use flipbox\ember\validators\MinMaxValidator;
23
24			/**
25			* @author Flipbox Factory <[email protected]>
26			* @since 1.0.0
27			*
28			* @method ResourceAssociationQuery parentGetQuery($config = [])
29			* @method ResourceAssociation create(array $attributes = [])
30			* @method ResourceAssociation find($identifier)
31			* @method ResourceAssociation get($identifier)
32			* @method ResourceAssociation findByCondition($condition = [])
33			* @method ResourceAssociation getByCondition($condition = [])
34			* @method ResourceAssociation findByCriteria($criteria = [])
35			* @method ResourceAssociation getByCriteria($criteria = [])
36			* @method ResourceAssociation[] findAllByCondition($condition = [])
37			* @method ResourceAssociation[] getAllByCondition($condition = [])
38			* @method ResourceAssociation[] findAllByCriteria($criteria = [])
39			* @method ResourceAssociation[] getAllByCriteria($criteria = [])
40			*/
41			class ResourceAssociations extends SortableAssociations
42			{
43			use Accessor {
44			getQuery as parentGetQuery;
45			}
46
47			/**
48			* @inheritdoc
49			*/
50			const SOURCE_ATTRIBUTE = ResourceAssociation::SOURCE_ATTRIBUTE;
51
52			/**
53			* @inheritdoc
54			*/
55			const TARGET_ATTRIBUTE = ResourceAssociation::TARGET_ATTRIBUTE;
56
57			/**
58			* @inheritdoc
59			*/
60			public function init()
61			{
62			$settings = HubSpot::getInstance()->getSettings();
63			$this->cacheDuration = $settings->associationsCacheDuration;
64			$this->cacheDependency = $settings->associationsCacheDependency;
65
66			parent::init();
67			}
68
69			/**
70			* @inheritdoc
71			* @return ResourceAssociationQuery
72			*/
73			public function getQuery($config = []): SortableAssociationQueryInterface
74			{
75			return $this->parentGetQuery($config);
76			}
77
78			/**
79			* @inheritdoc
80			* @param ResourceAssociation $record
81			* @return ResourceAssociationQuery
82			*/
83			protected function associationQuery(
84			SortableAssociationInterface $record
85			): SortableAssociationQueryInterface {
86			return $this->query(
87			$record->{static::SOURCE_ATTRIBUTE},
88			$record->fieldId,
			0 ignored issues – show Bug introduced 2018-06-26 20:03 UTC by Report Bug Copy Issue Report Accessing `fieldId` on the interface `flipbox\craft\sortable\a...bleAssociationInterface` 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...
89			$record->siteId
			0 ignored issues – show Bug introduced 2018-06-26 20:03 UTC by Report Bug Copy Issue Report Accessing `siteId` on the interface `flipbox\craft\sortable\a...bleAssociationInterface` 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...
90			);
91			}
92
93			/**
94			* @inheritdoc
95			* @param ResourceAssociationQuery $query
96			*/
97			protected function existingAssociations(
98			SortableAssociationQueryInterface $query
99			): array {
100			$source = $this->resolveStringAttribute($query, 'element');
101			$field = $this->resolveStringAttribute($query, 'field');
102			$site = $this->resolveStringAttribute($query, 'siteId');
103
104			if ($source === null \|\| $field === null \|\| $site === null) {
105			return [];
106			}
107
108			return $this->associations($source, $field, $site);
109			}
110
111
112			/**
113			* @param string $hubSpotId
114			* @return ElementInterface
115			* @throws ElementNotFoundException
116			*/
117			public function getElementByHubSpotId(string $hubSpotId): ElementInterface
118			{
119			if (!$element = $this->findElementByHubSpotId($hubSpotId)) {
120			throw new ElementNotFoundException(sprintf(
121			"Unable to get element from HubSpot Id: '%s'.",
122			$hubSpotId
123			));
124			}
125
126			return $element;
127			}
128
129			/**
130			* @param string $hubSpotId
131			* @return ElementInterface\|null
132			*/
133			public function findElementByHubSpotId(string $hubSpotId)
134			{
135			$record = $this->findByCondition([
136			'objectId' => $hubSpotId
137			]);
138
139			if ($record === null) {
140			return null;
141			}
142
143			return $record->getElement();
144			}
145
146			/**
147			* Find the HubSpot Id by Element Id
148			*
149			* @param int $id
150			* @return string\|null
151			*/
152			public function findHubSpotIdByElementId(int $id)
153			{
154			$hubSpotId = $this->getQuery()
155			->select(['hubSpotId'])
156			->element($id)
157			->scalar();
158
159			if (!$hubSpotId) {
160			return null;
161			}
162
163			return $hubSpotId;
164			}
165
166
167			/**
168			* @param $source
169			* @param int $fieldId
170			* @param int $siteId
171			* @return ResourceAssociationQuery
172			*/
173			private function query(
174			$source,
175			int $fieldId,
176			int $siteId
177			): ResourceAssociationQuery {
178			return $this->getQuery()
179			->where([
180			static::SOURCE_ATTRIBUTE => $source,
181			'fieldId' => $fieldId,
182			'siteId' => $siteId
183			])
184			->orderBy(['sortOrder' => SORT_ASC]);
185			}
186
187			/**
188			* @param $source
189			* @param int $fieldId
190			* @param int $siteId
191			* @return array
192			*/
193			private function associations(
194			$source,
195			int $fieldId,
196			int $siteId
197			): array {
198			return $this->query($source, $fieldId, $siteId)
199			->indexBy(static::TARGET_ATTRIBUTE)
200			->all();
201			}
202
203			/**
204			* @inheritdoc
205			* @param bool $validate
206			* @throws \Exception
207			*/
208			public function save(
209			SortableAssociationQueryInterface $query,
210			bool $validate = true
211			): bool {
212			if ($validate === true && null !== ($field = $this->resolveFieldFromQuery($query))) {
213			$error = '';
214			(new MinMaxValidator([
215			'min' => $field->min ? (int)$field->min : null,
216			'max' => $field->max ? (int)$field->max : null
217			]))->validate($query, $error);
218
219			if (!empty($error)) {
220			HubSpot::error(sprintf(
221			"Hubspot Resource failed to save due to the following validation errors: '%s'",
222			Json::encode($error)
223			));
224			return false;
225			}
226			}
227
228			return parent::save($query);
229			}
230
231			/**
232			* @param SortableAssociationQueryInterface $query
233			* @return Resources\|null
234			*/
235			protected function resolveFieldFromQuery(
236			SortableAssociationQueryInterface $query
237			) {
238			if (null === ($fieldId = $this->resolveStringAttribute($query, 'field'))) {
239			return null;
240			}
241
242			return HubSpot::getInstance()->getResourcesField()->findById($fieldId);
243			}
244
245			/**
246			* @inheritdoc
247			*/
248			protected static function tableAlias(): string
249			{
250			return ResourceAssociation::tableAlias();
251			}
252
253			/**
254			* @inheritdoc
255			*/
256			public static function recordClass(): string
257			{
258			return ResourceAssociation::class;
259			}
260			}
261

flipboxfactory / craft-hubspot

Push — develop ( f37ae4...1d947e )

ResourceAssociations::save() B

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like