Config::isEnableCorrelationId() - Code Metrics - Inspection of "WIP: move enableCorrelationId to client config" - commercetools/commercetools-php-sdk - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Branch — refactor_config_class (b4bd7c)

by Jens
created 2018-04-11 10:16 UTC
Config::isEnableCorrelationId() A

↳ Parent: Config
Complexity

Conditions	1
Paths	1
Size

Total Lines	3
Code Lines	1
Duplication

Lines	0
Ratio	0 %
Code Coverage

Tests	0
CRAP Score	2
Importance

Changes
Metric	Value
dl	0
loc	3
ccs	0
cts	2
cp	0
rs	10
c	0
b	0
f	0
cc	1
eloc	1
nc	1
nop	0
crap	2
<?php
/**
 * @author @jenschude <[email protected]>
 * @created: 20.01.15, 17:54
 */

namespace Commercetools\Core;

use Commercetools\Core\Client\ClientConfig;
use Commercetools\Core\Client\Credentials;
use Commercetools\Core\Error\Message;
use Commercetools\Core\Error\InvalidArgumentException;
use Commercetools\Core\Helper\CorrelationIdProvider;
use Commercetools\Core\Helper\DefaultCorrelationIdProvider;
use Commercetools\Core\Helper\Uuid;
use Commercetools\Core\Model\Common\ContextAwareInterface;
use Commercetools\Core\Model\Common\ContextTrait;

/**
 * Client configuration object
 *
 * @description
 *
 * Often configuration like credentials is stored in YAML or INI files. To setup the configuration object
 * this can be done by the fromArray method.
 *
 * Configuration file:
 *
 * ```
 * [commercetools]
 * client_id = '<client-id>'
 * client_secret = '<client-secret>'
 * project = '<project>'
 * ```
 *
 * Config instantiation:
 *
 * ```php
 * $iniConfig = parse_ini_file('<config-file>.ini', true);
 * $config = Config::fromArray($iniConfig['commercetools']);
 * ```
 *
 * ### Exceptions ###
 *
 * The client by default suppresses exceptions when a response had been returned by the API and the result
 * can be handled afterwards by checking the isError method of the response. For interacting with Exceptions
 * they can be enabled with the throwExceptions flag.
 *
 * ```php
 * $config->setThrowExceptions(true);
 * $client = new Client($config);
 * try {
 *     $response = $client->execute($request);
 * } catch (\Commercetools\Core\Error\ApiException $e) {
 *     // handle Exception
 * }
 * ```
 * @package Commercetools\Core
 */
class Config extends ConfigObject implements ContextAwareInterface
{
    use ContextTrait;

    const OAUTH_URL = 'oauth_url';
    const CLIENT_ID = 'client_id';
    const CLIENT_SECRET = 'client_secret';
    const SCOPE = 'scope';
    const PROJECT = 'project';
    const API_URL = 'api_url';
    const USER_NAME = Credentials::USER_NAME;
    const PASSWORD = Credentials::PASSWORD;
    const REFRESH_TOKEN = Credentials::REFRESH_TOKEN;
    const BEARER_TOKEN = Credentials::BEARER_TOKEN;
    const ANONYMOUS_ID = Credentials::ANONYMOUS_ID;
    const GRANT_TYPE = Credentials::GRANT_TYPE;

    const GRANT_TYPE_CLIENT = Credentials::GRANT_TYPE_CLIENT;
    const GRANT_TYPE_PASSWORD = Credentials::GRANT_TYPE_PASSWORD;
    const GRANT_TYPE_REFRESH = Credentials::GRANT_TYPE_REFRESH;
    const GRANT_TYPE_ANONYMOUS = Credentials::GRANT_TYPE_ANONYMOUS;
    const GRANT_TYPE_BEARER_TOKEN = Credentials::GRANT_TYPE_BEARER_TOKEN;

    /**
     * @var Credentials
     */
    protected $credentials;

    /**
     * @var string
     */
    protected $cacheDir;

    protected $clientConfig;

    protected $oauthClientConfig;

    public function __construct()
    {
        $this->credentials = new Credentials();
        $this->clientConfig = new ClientConfig('https://api.sphere.io');
        $this->oauthClientConfig = new ClientConfig('https://auth.sphere.io');
    }

    /**
     * @param array $configValues
     * @return static
     */
    public static function fromArray(array $configValues)
    {
        $config = static::of();
        array_walk(
            $configValues,
            function ($value, $key) use ($config) {
                $functionName = 'set' . $config->camelize($key);
                if (!is_callable([$config, $functionName])) {
                    throw new InvalidArgumentException(sprintf(Message::SETTER_NOT_IMPLEMENTED, $key));
                }
                $config->$functionName($value);
            }
        );

        return $config;
    }

    protected function camelize($scored)
    {
        return lcfirst(
            implode(
                '',
                array_map(
                    'ucfirst',
                    array_map(
                        'strtolower',
                        explode('_', $scored)
                    )
                )
            )
        );
    }

    /**
     * @deprecated
     * @return string
     */
    public function getOauthUrl()
    {
        switch ($this->credentials->getGrantType()) {
            case static::GRANT_TYPE_ANONYMOUS:
                return $this->oauthClientConfig->getBaseUri() . '/oauth/' .
                    $this->credentials->getProject() . '/anonymous/token';
            case static::GRANT_TYPE_PASSWORD:
            case static::GRANT_TYPE_REFRESH:
                return $this->oauthClientConfig->getBaseUri() . '/oauth/' .
                    $this->credentials->getProject() . '/customers/token';
            default:
                return $this->oauthClientConfig->getBaseUri() . '/oauth/token';
        }
    }

    /**
     * @return static
     */
    public static function of()
    {
        return new static();
    }

    /**
     * @deprecated
     * @return string
     */
    public function getGrantType()
    {
        return $this->credentials->getGrantType();
    }

    /**
     * @deprecated
     * @param string $grantType
     * @return $this
     */
    public function setGrantType($grantType)
    {
        $this->credentials->setGrantType($grantType);

        return $this;
    }

    /**
     * @deprecated
     * @return string
     */
    public function getUsername()
    {
        return $this->credentials->getUsername();
    }

    /**
     * @deprecated
     * @param string $username
     * @return $this
     */
    public function setUsername($username)
    {
        $this->credentials->setUsername($username);

        return $this;
    }

    /**
     * @deprecated
     * @return string
     */
    public function getPassword()
    {
        return $this->credentials->getPassword();
    }

    /**
     * @deprecated
     * @param string $password
     * @return $this
     */
    public function setPassword($password)
    {
        $this->credentials->setPassword($password);

        return $this;
    }

    /**
     * @deprecated
     * @return string
     */
    public function getRefreshToken()
    {
        return $this->credentials->getRefreshToken();
    }

    /**
     * @deprecated
     * @param string $refreshToken
     * @return $this
     */
    public function setRefreshToken($refreshToken)
    {
        $this->credentials->setRefreshToken($refreshToken);

        return $this;
    }

    /**
     * @deprecated
     * @return string
     */
    public function getAnonymousId()
    {
        return $this->credentials->getAnonymousId();
    }

    /**
     * @deprecated
     * @param string $anonymousId
     * @return $this
     */
    public function setAnonymousId($anonymousId)
    {
        $this->credentials->setAnonymousId($anonymousId);

        return $this;
    }

    /**
     * @return string
     */
    public function getCacheDir()
    {
        return $this->cacheDir;
    }

    /**
     * @param string $cacheDir
     * @return $this
     */
    public function setCacheDir($cacheDir)
    {
        $this->cacheDir = $cacheDir;

        return $this;
    }

    /**
     * @deprecated
     * @return string
     */
    public function getLogLevel()
    {
        return $this->clientConfig->getLogLevel();
    }

    /**
     * @deprecated
     * @param string $logLevel
     * @return $this
     */
    public function setLogLevel($logLevel)
    {
        $this->clientConfig->setLogLevel($logLevel);

        return $this;
    }

    /**
     * @deprecated
     * @return mixed
     */
    public function getMessageFormatter()
    {
        return $this->clientConfig->getMessageFormatter();
    }

    /**
     * @deprecated
     * @param mixed $messageFormatter
     * @return $this
     */
    public function setMessageFormatter($messageFormatter)
    {
        $this->clientConfig->setMessageFormatter($messageFormatter);
        return $this;
    }

    /**
     * @deprecated
     * @return CorrelationIdProvider|null
     */
    public function getCorrelationIdProvider()
    {
        return $this->clientConfig->getCorrelationIdProvider();
    }

    /**
     * @deprecated
     * @param CorrelationIdProvider $correlationIdProvider
     * @return Config
     */
    public function setCorrelationIdProvider(CorrelationIdProvider $correlationIdProvider)
    {
        $this->clientConfig->setCorrelationIdProvider($correlationIdProvider);

        return $this;
    }

    /**
     * @deprecated
     * @return bool
     */
    public function isEnableCorrelationId()
    {
        return $this->clientConfig->isEnableCorrelationId();
    }

    /**
     * @deprecated
     * @param bool $enableCorrelationId
     * @return Config
     */
    public function setEnableCorrelationId($enableCorrelationId)
    {
        $this->clientConfig->setEnableCorrelationId($enableCorrelationId);
        return $this;
    }

    /**
     * @deprecated
     * @return array
     */
    public function getClientOptions()
    {
        return $this->clientConfig->getClientOptions();
    }

    /**
     * @deprecated
     * @param array $clientConfig
     * @return Config
     */
    public function setClientOptions(array $clientConfig)
    {
        $this->clientConfig->setClientOptions($clientConfig);
        return $this;
    }

    /**
     * @deprecated
     * @return array
     */
    public function getOAuthClientOptions()
    {
        return $this->oauthClientConfig->getClientOptions();
    }

    /**
     * @deprecated
     * @param array $clientOptions
     * @return Config
     */
    public function setOAuthClientOptions(array $clientOptions)
    {
        $this->oauthClientConfig->setClientOptions($clientOptions);
        return $this;
    }

    /**
     * @deprecated
     * @return string
     */
    public function getBearerToken()
    {
        return $this->credentials->getBearerToken();
    }

    /**
     * @deprecated
     * @param string $bearerToken
     * @return Config
     */
    public function setBearerToken($bearerToken)
    {
        $this->credentials->setBearerToken($bearerToken);
        return $this;
    }

    /**
     * @deprecated
     * @return string
     */
    public function getClientSecret()
    {
        return $this->credentials->getClientSecret();
    }

    /**
     * @deprecated
     * @param string $clientSecret
     * @return $this
     */
    public function setClientSecret($clientSecret)
    {
        $this->credentials->setClientSecret($clientSecret);

        return $this;
    }

    /**
     * @deprecated
     * @return string
     */
    public function getClientId()
    {
        return $this->credentials->getClientId();
    }

    /**
     * @deprecated
     * @param string $clientId
     * @return $this
     */
    public function setClientId($clientId)
    {
        $this->credentials->setClientId($clientId);

        return $this;
    }

    /**
     * @deprecated
     * @return string
     */
    public function getProject()
    {
        return $this->credentials->getProject();
    }

    /**
     * @deprecated
     * @param string $project
     * @return $this
     */
    public function setProject($project)
    {
        $this->credentials->setProject($project);
        $this->clientConfig->setProject($project);

        return $this;
    }

    /**
     * @deprecated
     * @return string
     */
    public function getScope()
    {
        return $this->credentials->getScope();
    }

    /**
     * @deprecated
     * @param string $scope
     * @return $this
     */
    public function setScope($scope)
    {
        $this->credentials->setScope($scope);

        return $this;
    }

    /**
     * @deprecated
     * @param string $oauthUrl
     * @return $this
     */
    public function setOauthUrl($oauthUrl)
    {
        $this->oauthClientConfig->setBaseUri($oauthUrl);

        return $this;
    }

    /**
     * @deprecated
     * @return string
     */
    public function getApiUrl()
    {
        return $this->clientConfig->getBaseUri();
    }

    /**
     * @deprecated
     * @param string $apiUrl
     * @return $this
     */
    public function setApiUrl($apiUrl)
    {
        $this->clientConfig->setBaseUri($apiUrl);

        return $this;
    }

    /**
     * @deprecated
     * @return bool
     */
    public function check()
    {
        return $this->credentials->check();
    }

    /**
     * @deprecated use getClientOptions()['concurrency'] instead
     * @return int
     */
    public function getBatchPoolSize()
    {
        return $this->clientConfig->getBatchPoolSize();
        return /** @scrutinizer ignore-deprecated */ $this->clientConfig->getBatchPoolSize();
    }

    /**
     * @deprecated use setClientOptions(['concurrency' => 5]) instead
     * @param int $batchPoolSize
     * @return $this
     */
    public function setBatchPoolSize($batchPoolSize)
    {
        $this->clientConfig->setBatchPoolSize($batchPoolSize);
        /** @scrutinizer ignore-deprecated */ $this->clientConfig->setBatchPoolSize($batchPoolSize);

        return $this;
    }

    /**
     * @deprecated
     * @return string
     */
    public function getAdapter()
    {
        return $this->clientConfig->getAdapter();
    }

    /**
     * @deprecated
     * @param string $adapter
     * @return $this
     */
    public function setAdapter($adapter)
    {
        $this->clientConfig->setAdapter($adapter);

        return $this;
    }

    /**
     * @deprecated
     * @return bool
     */
    public function getThrowExceptions()
    {
        return $this->clientConfig->isThrowExceptions();
    }

    /**
     * @deprecated
     * @param bool $throwExceptions
     * @return $this
     */
    public function setThrowExceptions($throwExceptions)
    {
        $this->clientConfig->setThrowExceptions($throwExceptions);

        return $this;
    }

    /**
     * @deprecated
     * @return string
     */
    public function getAcceptEncoding()
    {
        return $this->clientConfig->getAcceptEncoding();
    }

    /**
     * @deprecated
     * @param string $acceptEncoding
     * @return $this
     */
    public function setAcceptEncoding($acceptEncoding)
    {
        $this->clientConfig->setAcceptEncoding($acceptEncoding);

        return $this;
    }

    /**
     * @return Credentials
     */
    public function getCredentials()
    {
        return $this->credentials;
    }

    /**
     * @param Credentials $credentials
     * @return Config
     */
    public function setCredentials(Credentials $credentials)
    {
        $this->credentials = $credentials;
        return $this;
    }

    /**
     * @return ClientConfig
     */
    public function getClientConfig()
    {
        return $this->clientConfig;
    }

    /**
     * @param ClientConfig $clientConfig
     * @return Config
     */
    public function setClientConfig(ClientConfig $clientConfig)
    {
        $this->clientConfig = $clientConfig;
        return $this;
    }

    /**
     * @return ClientConfig
     */
    public function getOauthClientConfig()
    {
        return $this->oauthClientConfig;
    }

    /**
     * @param ClientConfig $oauthClientConfig
     * @return Config
     */
    public function setOauthClientConfig(ClientConfig $oauthClientConfig)
    {
        $this->oauthClientConfig = $oauthClientConfig;
        return $this;
    }
}

commercetools / commercetools-php-sdk

Branch — refactor_config_class (b4bd7c)

Config::isEnableCorrelationId() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like
