CompanyContacts::rawRemovePipeline() - Code Metrics - Inspection of "moving destructive logic to ‘builder’ classes" - flipboxfactory/craft-hubspot - Measure and Improve Code Quality continuously with Scrutinizer

Completed
Push — develop ( 639fa1...b48ec5 )

by Nate
created 2018-06-29 23:00 UTC
CompanyContacts::rawRemovePipeline() A

↳ Parent: CompanyContacts
Complexity

Conditions	1
Paths	1
Size

Total Lines
Duplication

Lines	0
Ratio	0 %
Code Coverage

Tests	0
CRAP Score	2
Importance

Changes
Metric	Value
dl	0
loc	22
c	0
b	0
f	0
ccs	0
cts	11
cp	0
rs	9.568
cc	1
nc	1
nop	5
crap	2
<?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;

use flipbox\hubspot\builders\CompanyContactsBuilder;
use flipbox\hubspot\builders\CompanyContactsBuilderInterface;
use flipbox\hubspot\connections\ConnectionInterface;
use flipbox\hubspot\criteria\CompanyContactsCriteria;
use flipbox\hubspot\criteria\ObjectCriteriaInterface;
use flipbox\hubspot\helpers\TransformerHelper;
use flipbox\hubspot\HubSpot;
use flipbox\hubspot\pipeline\Resource;
use flipbox\hubspot\services\resources\traits\ReadObjectTrait;
use flipbox\hubspot\traits\CacheResolverTrait;
use flipbox\hubspot\traits\ConnectionResolverTrait;
use flipbox\hubspot\transformers\collections\TransformerCollectionInterface;
use Flipbox\Relay\HubSpot\Builder\Resources\Company\Contacts\Add;
use Flipbox\Relay\HubSpot\Builder\Resources\Company\Contacts\All;
use Flipbox\Relay\HubSpot\Builder\Resources\Company\Contacts\Remove;
use League\Pipeline\PipelineBuilderInterface;
use Psr\Http\Message\ResponseInterface;
use Psr\SimpleCache\CacheInterface;
use yii\base\Component;

/**
 * @author Flipbox Factory <[email protected]>
 * @since 1.0.0
 */
class CompanyContacts extends Component
{
    use ConnectionResolverTrait,
        CacheResolverTrait,
        ReadObjectTrait;

    /**
     * The HubSpot Resource name
     */
    const HUBSPOT_RESOURCE = 'companyContacts';

    /**
     * @param array $config
     * @return ObjectCriteriaInterface
     */
    public function getCriteria(array $config = []): ObjectCriteriaInterface
    {
        return new CompanyContactsCriteria($config);
    }

    /**
     * @param array $config
     * @return CompanyContactsBuilderInterface
     */
    public function getBuilder(array $config = []): CompanyContactsBuilderInterface
    {
        return new CompanyContactsBuilder($config);
    }

    /*******************************************
     * READ
     *******************************************/

    /**
     * @inheritdoc
     */
    public function rawReadPipeline(
        string $id,
        ConnectionInterface $connection = null,
        CacheInterface $cache = null,
        TransformerCollectionInterface $transformer = null
    ): PipelineBuilderInterface {
        $transformer = TransformerHelper::populateTransformerCollection($transformer, [
            'resource' => [All::class]
        ]);

        return (new Resource(
            $this->rawHttpReadRelay(
                $id,
                $connection,
                $cache
            ),
            $transformer,
            HubSpot::getInstance()->getPsrLogger()
        ));
    }

    /**
     * @inheritdoc
     */
    public function rawHttpReadRelay(
        string $id,
        ConnectionInterface $connection = null,
        CacheInterface $cache = null
    ): callable {
        return (new All(
            $id,
            $this->resolveConnection($connection),
            $this->resolveCache($cache),
function notNullable(stdClass $x) { }

// Unsafe
function withoutCheck(stdClass $x = null) {
    notNullable($x);
}

// Safe - Alternative 1: Adding Additional Type-Check
function withCheck(stdClass $x = null) {
    if ($x instanceof stdClass) {
        notNullable($x);
    }
}

// Safe - Alternative 2: Changing Parameter
function withNonNullableParam(stdClass $x) {
    notNullable($x);
}
            HubSpot::getInstance()->getPsrLogger()
        ))->build();
    }


    /*******************************************
     * ADD
     *******************************************/

    /**
     * @param CompanyContactsBuilderInterface $builder
     * @param ConnectionInterface|null $connection
     * @param CacheInterface|null $cache
     * @param TransformerCollectionInterface|null $transformer
     * @param null $source
     * @return mixed
     * @throws \yii\base\InvalidConfigException
     */
    public function add(
        CompanyContactsBuilderInterface $builder,
        ConnectionInterface $connection = null,
        CacheInterface $cache = null,
        TransformerCollectionInterface $transformer = null,
        $source = null
    ) {
        return $this->rawAdd(
            $builder->getCompanyId(),
            $builder->getContactId(),
            $connection,
            $cache,
            $transformer,
            $source
        );
    }

    /**
     * @param string $companyId
     * @param string $contactId
     * @param ConnectionInterface|null $connection
     * @param CacheInterface|null $cache
     * @param TransformerCollectionInterface|null $transformer
     * @return PipelineBuilderInterface
     * @throws \yii\base\InvalidConfigException
     */
    public function rawAddPipeline(
        string $companyId,
        string $contactId,
        ConnectionInterface $connection = null,
        CacheInterface $cache = null,
        TransformerCollectionInterface $transformer = null
    ): PipelineBuilderInterface {
        $transformer = TransformerHelper::populateTransformerCollection($transformer, [
            'resource' => [Add::class]
        ]);

        return (new Resource(
            $this->rawHttpAddRelay(
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
                $companyId,
                $contactId,
                $connection,
                $cache
            ),
            $transformer,
            HubSpot::getInstance()->getPsrLogger()
        ));
    }

    /**
     * @param string $companyId
     * @param string $contactId
     * @param ConnectionInterface|null $connection
     * @param CacheInterface|null $cache
     * @param TransformerCollectionInterface|null $transformer
     * @param null $source
     * @return mixed
     * @throws \yii\base\InvalidConfigException
     */
    public function rawAdd(
        string $companyId,
        string $contactId,
        ConnectionInterface $connection = null,
        CacheInterface $cache = null,
        TransformerCollectionInterface $transformer = null,
        $source = null
    ) {
        return $this->rawAddPipeline(
            $companyId,
            $contactId,
            $connection,
            $cache,
            $transformer
        )($source);
    }


    /**
     * @param CompanyContactsBuilderInterface $builder
     * @param ConnectionInterface|null $connection
     * @param CacheInterface|null $cache
     * @param TransformerCollectionInterface|null $transformer
     * @return PipelineBuilderInterface
     * @throws \yii\base\InvalidConfigException
     */
    public function addPipeline(
        CompanyContactsBuilderInterface $builder,
        ConnectionInterface $connection = null,
        CacheInterface $cache = null,
        TransformerCollectionInterface $transformer = null
    ): PipelineBuilderInterface {
        return $this->rawAddPipeline(
            $builder->getCompanyId(),
            $builder->getContactId(),
            $connection,
            $cache,
            $transformer
        );
    }

    /**
     * @param CompanyContactsBuilderInterface $builder
     * @param ConnectionInterface|null $connection
     * @param CacheInterface|null $cache
     * @return callable
     * @throws \yii\base\InvalidConfigException
     */
    public function httpAddRelay(
        CompanyContactsBuilderInterface $builder,
        ConnectionInterface $connection = null,
        CacheInterface $cache = null
    ): callable {
        return $this->rawHttpAddRelay(
            $builder->getCompanyId(),
            $builder->getContactId(),
            $connection,
            $cache
        );
    }

    /**
     * @param string $companyId
     * @param string $contactId
     * @param ConnectionInterface|null $connection
     * @param CacheInterface|null $cache
     * @return callable
     * @throws \yii\base\InvalidConfigException
     */
    public function rawHttpAddRelay(
        string $companyId,
        string $contactId,
        ConnectionInterface $connection = null,
        CacheInterface $cache = null
    ): callable {
        return (new Add(
            $companyId,
            $contactId,
            $this->resolveConnection($connection),
            $this->resolveCache($cache),
function notNullable(stdClass $x) { }

// Unsafe
function withoutCheck(stdClass $x = null) {
    notNullable($x);
}

// Safe - Alternative 1: Adding Additional Type-Check
function withCheck(stdClass $x = null) {
    if ($x instanceof stdClass) {
        notNullable($x);
    }
}

// Safe - Alternative 2: Changing Parameter
function withNonNullableParam(stdClass $x) {
    notNullable($x);
}
            HubSpot::getInstance()->getPsrLogger()
        ))->build();
    }

    /**
     * @param CompanyContactsBuilderInterface $builder
     * @param ConnectionInterface|null $connection
     * @param CacheInterface|null $cache
     * @return ResponseInterface
     * @throws \yii\base\InvalidConfigException
     */
    public function httpAdd(
        CompanyContactsBuilderInterface $builder,
        ConnectionInterface $connection = null,
        CacheInterface $cache = null
    ): ResponseInterface {
        return $this->rawHttpAdd(
            $builder->getCompanyId(),
            $builder->getContactId(),
            $connection,
function notNullable(stdClass $x) { }

// Unsafe
function withoutCheck(stdClass $x = null) {
    notNullable($x);
}

// Safe - Alternative 1: Adding Additional Type-Check
function withCheck(stdClass $x = null) {
    if ($x instanceof stdClass) {
        notNullable($x);
    }
}

// Safe - Alternative 2: Changing Parameter
function withNonNullableParam(stdClass $x) {
    notNullable($x);
}
            $cache
function notNullable(stdClass $x) { }

// Unsafe
function withoutCheck(stdClass $x = null) {
    notNullable($x);
}

// Safe - Alternative 1: Adding Additional Type-Check
function withCheck(stdClass $x = null) {
    if ($x instanceof stdClass) {
        notNullable($x);
    }
}

// Safe - Alternative 2: Changing Parameter
function withNonNullableParam(stdClass $x) {
    notNullable($x);
}
        );
    }

    /**
     * @param string $companyId
     * @param string $contactId
     * @param ConnectionInterface|null $connection
     * @param CacheInterface|null $cache
     * @return ResponseInterface
     * @throws \yii\base\InvalidConfigException
     */
    public function rawHttpAdd(
        string $companyId,
        string $contactId,
        ConnectionInterface $connection,
        CacheInterface $cache
    ): ResponseInterface {
        return $this->rawHttpAddRelay(
            $companyId,
            $contactId,
            $connection,
            $cache
        )();
    }


    /*******************************************
     * REMOVE
     *******************************************/

    /**
     * @param CompanyContactsBuilderInterface $builder
     * @param ConnectionInterface|null $connection
     * @param CacheInterface|null $cache
     * @param TransformerCollectionInterface|null $transformer
     * @param null $source
     * @return mixed
     * @throws \yii\base\InvalidConfigException
     */
    public function remove(
        CompanyContactsBuilderInterface $builder,
        ConnectionInterface $connection = null,
        CacheInterface $cache = null,
        TransformerCollectionInterface $transformer = null,
        $source = null
    ) {
        return $this->rawRemove(
            $builder->getCompanyId(),
            $builder->getContactId(),
            $connection,
            $cache,
            $transformer,
            $source
        );
    }

    /**
     * @param string $companyId
     * @param string $contactId
     * @param ConnectionInterface|null $connection
     * @param CacheInterface|null $cache
     * @param TransformerCollectionInterface|null $transformer
     * @param null $source
     * @return mixed
     * @throws \yii\base\InvalidConfigException
     */
    public function rawRemove(
        string $companyId,
        string $contactId,
        ConnectionInterface $connection = null,
        CacheInterface $cache = null,
        TransformerCollectionInterface $transformer = null,
        $source = null
    ) {
        return $this->rawRemovePipeline(
            $companyId,
            $contactId,
            $connection,
            $cache,
            $transformer
        )($source);
    }

    /**
     * @param CompanyContactsBuilderInterface $builder
     * @param ConnectionInterface|null $connection
     * @param CacheInterface|null $cache
     * @param TransformerCollectionInterface|null $transformer
     * @return PipelineBuilderInterface
     * @throws \yii\base\InvalidConfigException
     */
    public function removePipeline(
        CompanyContactsBuilderInterface $builder,
        ConnectionInterface $connection = null,
        CacheInterface $cache = null,
        TransformerCollectionInterface $transformer = null
    ): PipelineBuilderInterface {
        return $this->rawRemovePipeline(
            $builder->getCompanyId(),
            $builder->getContactId(),
            $connection,
            $cache,
            $transformer
        );
    }

    /**
     * @param string $companyId
     * @param string $contactId
     * @param ConnectionInterface|null $connection
     * @param CacheInterface|null $cache
     * @param TransformerCollectionInterface|null $transformer
     * @return PipelineBuilderInterface
     * @throws \yii\base\InvalidConfigException
     */
    public function rawRemovePipeline(
        string $companyId,
        string $contactId,
        ConnectionInterface $connection = null,
        CacheInterface $cache = null,
        TransformerCollectionInterface $transformer = null
    ): PipelineBuilderInterface {
        $transformer = TransformerHelper::populateTransformerCollection($transformer, [
            'resource' => [Remove::class]
        ]);

        return (new Resource(
            $this->rawHttpAddRelay(
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
                $companyId,
                $contactId,
                $connection,
                $cache
            ),
            $transformer,
            HubSpot::getInstance()->getPsrLogger()
        ));
    }

    /**
     * @param CompanyContactsBuilderInterface $builder
     * @param ConnectionInterface|null $connection
     * @param CacheInterface|null $cache
     * @return callable
     * @throws \yii\base\InvalidConfigException
     */
    public function httpRemoveRelay(
        CompanyContactsBuilderInterface $builder,
        ConnectionInterface $connection = null,
        CacheInterface $cache = null
    ): callable {
        return $this->rawHttpRemoveRelay(
            $builder->getCompanyId(),
            $builder->getContactId(),
            $connection,
            $cache
        );
    }

    /**
     * @param string $companyId
     * @param string $contactId
     * @param ConnectionInterface|null $connection
     * @param CacheInterface|null $cache
     * @return callable
     * @throws \yii\base\InvalidConfigException
     */
    public function rawHttpRemoveRelay(
        string $companyId,
        string $contactId,
        ConnectionInterface $connection = null,
        CacheInterface $cache = null
    ): callable {
        return (new Remove(
            $companyId,
            $contactId,
            $this->resolveConnection($connection),
            $this->resolveCache($cache),
function notNullable(stdClass $x) { }

// Unsafe
function withoutCheck(stdClass $x = null) {
    notNullable($x);
}

// Safe - Alternative 1: Adding Additional Type-Check
function withCheck(stdClass $x = null) {
    if ($x instanceof stdClass) {
        notNullable($x);
    }
}

// Safe - Alternative 2: Changing Parameter
function withNonNullableParam(stdClass $x) {
    notNullable($x);
}
            HubSpot::getInstance()->getPsrLogger()
        ))->build();
    }

    /**
     * @param CompanyContactsBuilderInterface $builder
     * @param ConnectionInterface|null $connection
     * @param CacheInterface|null $cache
     * @return ResponseInterface
     * @throws \yii\base\InvalidConfigException
     */
    public function httpRemove(
        CompanyContactsBuilderInterface $builder,
        ConnectionInterface $connection = null,
        CacheInterface $cache = null
    ): ResponseInterface {
        return $this->rawHttpRemove(
            $builder->getCompanyId(),
            $builder->getContactId(),
            $connection,
function notNullable(stdClass $x) { }

// Unsafe
function withoutCheck(stdClass $x = null) {
    notNullable($x);
}

// Safe - Alternative 1: Adding Additional Type-Check
function withCheck(stdClass $x = null) {
    if ($x instanceof stdClass) {
        notNullable($x);
    }
}

// Safe - Alternative 2: Changing Parameter
function withNonNullableParam(stdClass $x) {
    notNullable($x);
}
            $cache
function notNullable(stdClass $x) { }

// Unsafe
function withoutCheck(stdClass $x = null) {
    notNullable($x);
}

// Safe - Alternative 1: Adding Additional Type-Check
function withCheck(stdClass $x = null) {
    if ($x instanceof stdClass) {
        notNullable($x);
    }
}

// Safe - Alternative 2: Changing Parameter
function withNonNullableParam(stdClass $x) {
    notNullable($x);
}
        );
    }

    /**
     * @param string $companyId
     * @param string $contactId
     * @param ConnectionInterface|null $connection
     * @param CacheInterface|null $cache
     * @return ResponseInterface
     * @throws \yii\base\InvalidConfigException
     */
    public function rawHttpRemove(
        string $companyId,
        string $contactId,
        ConnectionInterface $connection,
        CacheInterface $cache
    ): ResponseInterface {
        return $this->rawHttpRemoveRelay(
            $companyId,
            $contactId,
            $connection,
            $cache
        )();
    }
}

flipboxfactory / craft-hubspot

Push — develop ( 639fa1...b48ec5 )

CompanyContacts::rawRemovePipeline() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like
