SyncByElementTrait - Code Metrics - Inspection of "raw sync / contact batch" - flipboxfactory/craft-hubspot - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — develop ( d5a3eb...d52d90 )

by Nate

created 2018-07-06 05:56 UTC

SyncByElementTrait A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	157
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	10

Test Coverage

Coverage

Importance

Changes

Metric	Value
wmc	5
lcom	1
cbo	10
dl	0
loc	157
ccs	0
cts	44
cp	0
rs	10
c	0
b	0
f	0

6 Methods

Rating	Name	Size	Complexity
	rawHttpReadRelay()	5	?
	rawHttpUpsertRelay()	6	?
A	syncDown()	20	2
A	rawSyncDown()	25	1
A	syncUp()	15	1
A	rawSyncUp()	25	1

<?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\resources\traits;

use craft\base\Element;
use craft\base\ElementInterface;
use flipbox\hubspot\connections\ConnectionInterface;
use flipbox\hubspot\fields\Objects;
use flipbox\hubspot\helpers\ConnectionHelper;
use flipbox\hubspot\HubSpot;
use flipbox\hubspot\pipeline\Resource;
use flipbox\hubspot\pipeline\stages\ElementAssociationStage;
use flipbox\hubspot\pipeline\stages\ElementSaveStage;
use flipbox\hubspot\traits\TransformElementIdTrait;
use flipbox\hubspot\traits\TransformElementPayloadTrait;
use Psr\SimpleCache\CacheInterface;

/**
 * @author Flipbox Factory <[email protected]>
 * @since 1.0.0
 */
trait SyncByElementTrait
{
    use TransformElementIdTrait,
        TransformElementPayloadTrait;

    /**
     * @param string $id
     * @param ConnectionInterface|string|null $connection
     * @param CacheInterface|string|null $cache
     * @return callable
     */
    public abstract function rawHttpReadRelay(
        string $id,
        ConnectionInterface $connection = null,
        CacheInterface $cache = null
    ): callable;

    /**
     * @param array $payload
     * @param string|null $identifier
     * @param ConnectionInterface|string|null $connection
     * @param CacheInterface|string|null $cache
     * @return callable
     * @throws \yii\base\InvalidConfigException
     */
    public abstract function rawHttpUpsertRelay(
        array $payload,
        string $identifier = null,
        ConnectionInterface $connection = null,
        CacheInterface $cache = null
    ): callable;

    /**
     * @param ElementInterface $element
     * @param Objects $field
     * @param ConnectionInterface|null $connection
     * @param CacheInterface|null $cache
     * @return bool
     * @throws \yii\base\InvalidConfigException
     */
    public function syncDown(
        ElementInterface $element,
        Objects $field,
        ConnectionInterface $connection = null,
        CacheInterface $cache = null
    ): bool {
        /** @var Element $element */

        if (null === ($id = $this->transformElementId($element, $field))) {
            return false;
        }

        return $this->rawSyncDown(
            $element,
            $field,
            $id,
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
            $connection,
            $cache
        );
    }

    /**
     * @param ElementInterface $element
     * @param Objects $field
     * @param string $id
     * @param ConnectionInterface|null $connection
     * @param CacheInterface|null $cache
     * @return bool
     * @throws \yii\base\InvalidConfigException
     */
    public function rawSyncDown(
        ElementInterface $element,
        Objects $field,
        string $id,
        ConnectionInterface $connection = null,
        CacheInterface $cache = null
    ): bool {
        /** @var Element $element */

        (new Resource(
            $this->rawHttpReadRelay(
                $id,
                ConnectionHelper::resolveConnection($connection),
                $cache
            ),
            null,
            HubSpot::getInstance()->getPsrLogger()
        ))->build()->pipe(
            new ElementSaveStage($field)
        )->pipe(
            new ElementAssociationStage($field)
        )(null, $element);

        return !$element->hasErrors();
    }

    /**
     * @param ElementInterface $element
     * @param Objects $field
     * @param ConnectionInterface|null $connection
     * @param CacheInterface|null $cache
     * @return bool
     * @throws \yii\base\InvalidConfigException
     */

    public function syncUp(
        ElementInterface $element,
        Objects $field,
        ConnectionInterface $connection = null,
        CacheInterface $cache = null
    ): bool {
        return $this->rawSyncUp(
            $element,
            $field,
            $this->transformElementPayload($element, $field),
            $this->transformElementId($element, $field),

            $connection,
            $cache
        );
    }

    /**
     * @param ElementInterface $element
     * @param Objects $field
     * @param array $payload
     * @param string|null $id
     * @param ConnectionInterface|null $connection
     * @param CacheInterface|null $cache
     * @return bool
     * @throws \yii\base\InvalidConfigException
     */
    public function rawSyncUp(
        ElementInterface $element,
        Objects $field,
        array $payload,
        string $id = null,
        ConnectionInterface $connection = null,
        CacheInterface $cache = null
    ): bool {
        /** @var Element $element */

        (new Resource(
            $this->rawHttpUpsertRelay(
                $payload,
                $id,
                $connection,
                $cache
            ),
            null,
            HubSpot::getInstance()->getPsrLogger()
        ))->build()->pipe(
            new ElementAssociationStage($field)
        )(null, $element);

        return !$element->hasErrors();
    }
}


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\resources\traits;
10
11			use craft\base\Element;
12			use craft\base\ElementInterface;
13			use flipbox\hubspot\connections\ConnectionInterface;
14			use flipbox\hubspot\fields\Objects;
15			use flipbox\hubspot\helpers\ConnectionHelper;
16			use flipbox\hubspot\HubSpot;
17			use flipbox\hubspot\pipeline\Resource;
18			use flipbox\hubspot\pipeline\stages\ElementAssociationStage;
19			use flipbox\hubspot\pipeline\stages\ElementSaveStage;
20			use flipbox\hubspot\traits\TransformElementIdTrait;
21			use flipbox\hubspot\traits\TransformElementPayloadTrait;
22			use Psr\SimpleCache\CacheInterface;
23
24			/**
25			* @author Flipbox Factory <[email protected]>
26			* @since 1.0.0
27			*/
28			trait SyncByElementTrait
29			{
30			use TransformElementIdTrait,
31			TransformElementPayloadTrait;
32
33			/**
34			* @param string $id
35			* @param ConnectionInterface\|string\|null $connection
36			* @param CacheInterface\|string\|null $cache
37			* @return callable
38			*/
39			public abstract function rawHttpReadRelay(
40			string $id,
41			ConnectionInterface $connection = null,
42			CacheInterface $cache = null
43			): callable;
44
45			/**
46			* @param array $payload
47			* @param string\|null $identifier
48			* @param ConnectionInterface\|string\|null $connection
49			* @param CacheInterface\|string\|null $cache
50			* @return callable
51			* @throws \yii\base\InvalidConfigException
52			*/
53			public abstract function rawHttpUpsertRelay(
54			array $payload,
55			string $identifier = null,
56			ConnectionInterface $connection = null,
57			CacheInterface $cache = null
58			): callable;
59
60			/**
61			* @param ElementInterface $element
62			* @param Objects $field
63			* @param ConnectionInterface\|null $connection
64			* @param CacheInterface\|null $cache
65			* @return bool
66			* @throws \yii\base\InvalidConfigException
67			*/
68			public function syncDown(
69			ElementInterface $element,
70			Objects $field,
71			ConnectionInterface $connection = null,
72			CacheInterface $cache = null
73			): bool {
74			/** @var Element $element */
75
76			if (null === ($id = $this->transformElementId($element, $field))) {
77			return false;
78			}
79
80			return $this->rawSyncDown(
81			$element,
82			$field,
83			$id,
			1 ignored issue – show Documentation introduced 2018-07-06 06:08 UTC by Report Bug Copy Issue Report `$id` is of type `array`, but the function expects a `string`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
84			$connection,
85			$cache
86			);
87			}
88
89			/**
90			* @param ElementInterface $element
91			* @param Objects $field
92			* @param string $id
93			* @param ConnectionInterface\|null $connection
94			* @param CacheInterface\|null $cache
95			* @return bool
96			* @throws \yii\base\InvalidConfigException
97			*/
98			public function rawSyncDown(
99			ElementInterface $element,
100			Objects $field,
101			string $id,
102			ConnectionInterface $connection = null,
103			CacheInterface $cache = null
104			): bool {
105			/** @var Element $element */
106
107			(new Resource(
108			$this->rawHttpReadRelay(
109			$id,
110			ConnectionHelper::resolveConnection($connection),
111			$cache
112			),
113			null,
114			HubSpot::getInstance()->getPsrLogger()
115			))->build()->pipe(
116			new ElementSaveStage($field)
117			)->pipe(
118			new ElementAssociationStage($field)
119			)(null, $element);
120
121			return !$element->hasErrors();
122			}
123
124			/**
125			* @param ElementInterface $element
126			* @param Objects $field
127			* @param ConnectionInterface\|null $connection
128			* @param CacheInterface\|null $cache
129			* @return bool
130			* @throws \yii\base\InvalidConfigException
131			*/
132
133			public function syncUp(
134			ElementInterface $element,
135			Objects $field,
136			ConnectionInterface $connection = null,
137			CacheInterface $cache = null
138			): bool {
139			return $this->rawSyncUp(
140			$element,
141			$field,
142			$this->transformElementPayload($element, $field),
143			$this->transformElementId($element, $field),
			1 ignored issue – show Bug introduced 2018-07-06 06:08 UTC by Report Bug Copy Issue Report It seems like `$this->transformElementId($element, $field)` targeting `flipbox\hubspot\traits\T...t::transformElementId()` can also be of type `array`; however, `flipbox\hubspot\services...ementTrait::rawSyncUp()` does only seem to accept `null\|string`, maybe add an additional type check? This check looks at variables that are passed out again to other methods. If the outgoing method call has stricter type requirements than the method itself, an issue is raised. An additional type check may prevent trouble. Loading history...
144			$connection,
145			$cache
146			);
147			}
148
149			/**
150			* @param ElementInterface $element
151			* @param Objects $field
152			* @param array $payload
153			* @param string\|null $id
154			* @param ConnectionInterface\|null $connection
155			* @param CacheInterface\|null $cache
156			* @return bool
157			* @throws \yii\base\InvalidConfigException
158			*/
159			public function rawSyncUp(
160			ElementInterface $element,
161			Objects $field,
162			array $payload,
163			string $id = null,
164			ConnectionInterface $connection = null,
165			CacheInterface $cache = null
166			): bool {
167			/** @var Element $element */
168
169			(new Resource(
170			$this->rawHttpUpsertRelay(
171			$payload,
172			$id,
173			$connection,
174			$cache
175			),
176			null,
177			HubSpot::getInstance()->getPsrLogger()
178			))->build()->pipe(
179			new ElementAssociationStage($field)
180			)(null, $element);
181
182			return !$element->hasErrors();
183			}
184			}
185

flipboxfactory / craft-hubspot

Push — develop ( d5a3eb...d52d90 )

SyncByElementTrait A

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

6 Methods

Duplication Side-by-Side

Filter issues like