AliAlharthi\SaudiAddress\Config

Complexity

Total Complexity

13

Size/Duplication

Total Lines	142
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	0

Importance

Changes

0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	6	2
A	getEnvVariable()	0	12	4
A	getVersion()	0	4	1
A	getApiKey()	0	4	1
A	setApiKey()	0	6	1
A	getApiSubscription()	0	4	1
A	setApiSubscription()	0	6	1
A	getCache()	0	4	1
A	setCache()	0	6	1

<?php

/*
 * Part of the Saudi Address API PHP package.
 *
 * NOTICE OF LICENSE
 *
 * Licensed under the MIT.
 *
 * This source file is subject to the MIT License that is
 * bundled with this package in the LICENSE file.
 *
 * @package    Saudi Address
 * @version    1.3
 * @author     Ali Alharthi
 * @license    MIT
 * @copyright  (c) 2020, Ali Alharthi
 * @link       https://aalharthi.sa
 */

namespace AliAlharthi\SaudiAddress;

class Config implements ConfigInterface
{
    /**
     * The current package version.
     *
     * @var string
     */
    protected $version = 1.3;

    /**
     * The Saudi National Address API key.
     *
     * @var string
     */
    protected $apiKey;

    /**
     * The Saudi National Address API subscription.
     *
     * @var string
     */
    protected $apiSubscription;

    /**
     * Enabling Cache
     *
     * @var bool
     */
    protected $cache = true;

    /**
     * Constructor.
     *
     * @param   string  $apiKey
     * @param   string  $apiSubscription
     */
    public function __construct($apiKey, $apiSubscription = 'Development', $cache = false)
    {
        $this->setApiKey($apiKey ?: self::getEnvVariable('SNA_API_KEY', ''));
        $this->setApiSubscription($apiSubscription);
        $this->setCache($cache);
    }

    /**
     * Get env Variable.
     *
     * @param   string      $name
     * @param   string|null $default
     * @return string|null
     */
    private static function getEnvVariable($name, $default = null)
    {
        if (isset($_SERVER[$name])) {
            return (string) $_SERVER[$name];
        }

        if (PHP_SAPI === 'cli' && ($value = getenv($name)) !== false) {
            return (string) $value;
        }

        return $default;
    }

    /**
     * Returns the package version.
     *
     * @return  string
     */
    public function getVersion()
    {
        return $this->version;
    }

    /**
     * Returns the Saudi National Address API key.
     *
     * @return  string
     */
    public function getApiKey()
    {
        return $this->apiKey;
    }

    /**
     * Sets the Saudi National Address API key.
     *
     * @param   string  $apiKey
     * @return  Config
     */
    public function setApiKey($apiKey)
    {
        $this->apiKey = $apiKey;

        return $this;
    }

    /**
     * Returns the Saudi National Address API subscription type.
     *
     * @return  string
     */
    public function getApiSubscription()
    {
        return $this->apiSubscription;
    }

    /**
     * Sets the Saudi National Address API subscription type.
     *
     * @param   string  $apiSubscription
     * @return  Config
     */
    public function setApiSubscription($apiSubscription)
    {
        $this->apiSubscription = $apiSubscription;

        return $this;
    }

    /**
     * Returns the cache status.
     *
     * @return  bool
     */
    public function getCache()
    {
        return $this->cache;
    }

    /**
     * Sets the cache status.
     *
     * @param   bool  $cache
     * @return  Config
     */
    public function setCache($cache)
    {
        $this->cache = $cache;

        return $this;
    }
}