Config::getRegion() - Code Metrics - Inspection of "Finished Dynamodb driver" - PHPSocialNetwork/phpfastcache - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — v9 ( 345353...555fde )

by Georges
created 2021-09-18 18:01 UTC
Config::getRegion() A

↳ Parent: Config
Complexity

Conditions	1
Paths	1
Size

Total Lines	3
Code Lines	1
Duplication

Lines	0
Ratio	0 %
Importance

Changes	1
Bugs	0	Features	0
Metric	Value
cc	1
eloc	1
nc	1
nop	0
dl	0
loc	3
rs	10
c	1
b	0
f	0
<?php
/**
 *
 * This file is part of Phpfastcache.
 *
 * @license MIT License (MIT)
 *
 * For full copyright and license information, please see the docs/CREDITS.txt and LICENCE files.
 *
 * @author Georges.L (Geolim4)  <[email protected]>
 * @author Contributors  https://github.com/PHPSocialNetwork/phpfastcache/graphs/contributors
 */

declare(strict_types=1);

namespace Phpfastcache\Drivers\Dynamodb;

use Phpfastcache\Config\ConfigurationOption;
use Phpfastcache\Core\Pool\ExtendedCacheItemPoolInterface;
use Phpfastcache\Exceptions\PhpfastcacheLogicException;

/**
 * @see https://github.com/arangodb/arangodb-php/blob/devel/examples/init.php
 * @SuppressWarnings(PHPMD.TooManyFields)
 */
class Config extends ConfigurationOption
{
    protected ?string $awsAccessKeyId = null;

    protected ?string $awsSecretAccessKey = null;

    protected bool $allowEnvCredentialOverride = false;

    protected ? string $endpoint = null; // List of endpoints here: https://docs.aws.amazon.com/general/latest/gr/ddb.html

    protected string $region;

    protected string $table;

    protected bool $debugEnabled = false;

    protected string $version = 'latest';

    protected string $partitionKey = ExtendedCacheItemPoolInterface::DRIVER_KEY_WRAPPER_INDEX;

    public function __construct(array $parameters = [])
    {
        parent::__construct($parameters);
        $this->awsAccessKeyId = $this->getDefaultSuperGlobalAccessor()('SERVER', 'AWS_ACCESS_KEY_ID');
        $this->awsSecretAccessKey = $this->getDefaultSuperGlobalAccessor()('SERVER', 'AWS_SECRET_ACCESS_KEY');
    }

    /**
     * @return string|null
     */
    public function getAwsAccessKeyId(): ?string
    {
        return $this->awsAccessKeyId;
    }

    /**
     * @param string|null $awsAccessKeyId
     * @return Config
     * @throws PhpfastcacheLogicException
     */
    public function setAwsAccessKeyId(?string $awsAccessKeyId): Config
    {
        $this->enforceLockedProperty(__FUNCTION__);
        if ($awsAccessKeyId !== null) {
            if (!$this->isAllowEnvCredentialOverride()) {
                throw new PhpfastcacheLogicException('You are not allowed to override AWS environment variables.');
            }
            \putenv("AWS_ACCESS_KEY_ID=$awsAccessKeyId");
            $this->awsAccessKeyId = $awsAccessKeyId;
        }
        return $this;
    }

    /**
     * @return string|null
     */
    public function getAwsSecretAccessKey(): ?string
    {
        return $this->awsSecretAccessKey;
    }

    /**
     * @param string|null $awsSecretAccessKey
     * @return Config
     * @throws PhpfastcacheLogicException
     */
    public function setAwsSecretAccessKey(?string $awsSecretAccessKey): Config
    {
        $this->enforceLockedProperty(__FUNCTION__);
        if ($awsSecretAccessKey !== null) {
            if (!$this->isAllowEnvCredentialOverride()) {
                throw new PhpfastcacheLogicException('You are not allowed to override AWS environment variables.');
            }
            \putenv("AWS_SECRET_ACCESS_KEY=$awsSecretAccessKey");
            $this->awsSecretAccessKey = $awsSecretAccessKey;
        }
        return $this;
    }

    /**
     * @return bool
     */
    public function isAllowEnvCredentialOverride(): bool
    {
        return $this->allowEnvCredentialOverride;
    }

    /**
     * @param bool $allowEnvCredentialOverride
     * @return Config
     * @throws PhpfastcacheLogicException
     */
    public function setAllowEnvCredentialOverride(bool $allowEnvCredentialOverride): Config
    {
        $this->enforceLockedProperty(__FUNCTION__);
        $this->allowEnvCredentialOverride = $allowEnvCredentialOverride;
        return $this;
    }

    /**
     * @return ?string
     */
    public function getEndpoint(): ?string
    {
        return $this->endpoint;
    }

    /**
     * @param ?string $endpoint
     * @return Config
     * @throws PhpfastcacheLogicException
     */
    public function setEndpoint(?string $endpoint): Config
    {
        $this->enforceLockedProperty(__FUNCTION__);
        if (!\str_starts_with($endpoint, 'https://') && \str_ends_with($endpoint, 'amazonaws.com')) {
        if (!\str_starts_with($endpoint, 'https://') && \str_ends_with(/** @scrutinizer ignore-type */ $endpoint, 'amazonaws.com')) {
            $endpoint = 'https://' . $endpoint;
        }
        $this->endpoint = $endpoint;
        return $this;
    }

    /**
     * @return string
     */
    public function getRegion(): string
    {
        return $this->region;
    }

    /**
     * @param string $region
     * @return Config
     * @throws PhpfastcacheLogicException
     */
    public function setRegion(string $region): Config
    {
        $this->enforceLockedProperty(__FUNCTION__);
        $this->region = $region;
        return $this;
    }

    /**
     * @return string
     */
    public function getTable(): string
    {
        return $this->table;
    }

    /**
     * @param string $table
     * @return Config
     * @throws PhpfastcacheLogicException
     */
    public function setTable(string $table): Config
    {
        $this->enforceLockedProperty(__FUNCTION__);
        $this->table = $table;
        return $this;
    }

    /**
     * @return bool
     */
    public function isDebugEnabled(): bool
    {
        return $this->debugEnabled;
    }

    /**
     * @param bool $debugEnabled
     * @return Config
     * @throws PhpfastcacheLogicException
     */
    public function setDebugEnabled(bool $debugEnabled): Config
    {
        $this->enforceLockedProperty(__FUNCTION__);
        $this->debugEnabled = $debugEnabled;
        return $this;
    }

    /**
     * @return string
     */
    public function getVersion(): string
    {
        return $this->version;
    }

    /**
     * @param string $version
     * @return Config
     * @throws PhpfastcacheLogicException
     */
    public function setVersion(string $version): Config
    {
        $this->enforceLockedProperty(__FUNCTION__);
        $this->version = $version;
        return $this;
    }

    /**
     * @return string
     */
    public function getPartitionKey(): string
    {
        return $this->partitionKey;
    }

    /**
     * @param string $partitionKey
     * @return Config
     * @throws PhpfastcacheLogicException
     */
    public function setPartitionKey(string $partitionKey): Config
    {
        $this->enforceLockedProperty(__FUNCTION__);
        $this->partitionKey = $partitionKey;
        return $this;
    }
}

PHPSocialNetwork / phpfastcache

Push — v9 ( 345353...555fde )

Config::getRegion() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
