PWWEB\Localisation\LocalisationRegistrar

Complexity

Total Complexity

24

Size/Duplication

Total Lines	331
Duplicated Lines	0 %

Importance

Changes

0

17 Methods

Rating	Name	Duplication	Size	Complexity
A	getAddressTypeClass()	0	3	1
A	getLanguageClass()	0	3	1
A	initializeCache()	0	8	1
A	setLanguageClass()	0	5	1
A	getLanguages()	0	21	3
A	forgetCachedLanguages()	0	5	1
A	getAddressClass()	0	3	1
A	getCacheStoreFromConfig()	0	16	3
A	getCacheStore()	0	3	1
A	setAddressClass()	0	5	1
A	__construct()	0	10	1
A	getCurrencyClass()	0	3	1
A	getAddresses()	0	22	4
A	forgetCachedAddresses()	0	5	1
A	registerLanguages()	0	3	1
A	clearClassLanguages()	0	3	1
A	getCountryClass()	0	3	1

<?php

/**
 * PWWEB\Localisation.
 *
 * Localisation Registrar.
 *
 * @author    Frank Pillukeit <clients@pw-websolutions.com>
 * @copyright 2020 pw-websolutions.com
 * @license   http://www.opensource.org/licenses/mit-license.html  MIT License
 */

namespace PWWEB\Localisation;

use Illuminate\Cache\CacheManager;
use Illuminate\Contracts\Cache\Repository;
use Illuminate\Support\Collection;
use PWWeb\Localisation\Contracts\Address;
use PWWeb\Localisation\Contracts\Address\Type as AddressType;
use PWWeb\Localisation\Contracts\Country;
use PWWeb\Localisation\Contracts\Currency;
use PWWeb\Localisation\Contracts\Language;

class LocalisationRegistrar
{
    /**
     * The cache repository.
     *
     * @var Repository
     */
    protected $cache;

    /**
     * The cache manager object.
     *
     * @var \Illuminate\Cache\CacheManager
     */
    protected $cacheManager;

    /**
     * The address class used for the package.
     * Can be either original value or overwritten for custom use.
     *
     * @var string
     */
    protected $addressClass;

    /**
     * The country class used for the package.
     * Can be either original value or overwritten for custom use.
     *
     * @var string
     */
    protected $countryClass;

    /**
     * The currency class used for the package.
     * Can be either original value or overwritten for custom use.
     *
     * @var string
     */
    protected $currencyClass;

    /**
     * The language class used for the package.
     * Can be either original value or overwritten for custom use.
     *
     * @var string
     */
    protected $languageClass;

    /**
     * The set of addresses available in the cache.
     *
     * @var \Illuminate\Support\Collection
     */
    protected $addresses;

    /**
     * The set of languages available in the cache.
     *
     * @var \Illuminate\Support\Collection
     */
    protected $languages;

    /**
     * The cache expiration time.
     *
     * @var DateInterval|integer

The type PWWEB\Localisation\DateInterval was not found. Did you mean DateInterval? If so, make sure to prefix the type with \.

     */
    public static $cacheExpirationTime;

    /**
     * The cache key.
     *
     * @var string
     */
    public static $cacheKey;

    /**
     * The cache model key.
     *
     * @var string
     */
    public static $cacheModelKey;

    /**
     * PermissionRegistrar constructor.
     *
     * @param \Illuminate\Cache\CacheManager $cacheManager The cache manager object
     */
    public function __construct(CacheManager $cacheManager)
    {
        $this->addressClass = config('pwweb.localisation.models.address');
        $this->addressTypeClass = config('pwweb.localisation.models.address_type');

The property addressTypeClass does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

        $this->countryClass = config('pwweb.localisation.models.country');
        $this->currencyClass = config('pwweb.localisation.models.currency');
        $this->languageClass = config('pwweb.localisation.models.language');

        $this->cacheManager = $cacheManager;
        $this->initializeCache();
    }

    /**
     * Initialize the cache for the package.
     *
     * @return void
     */
    protected function initializeCache()
    {
        self::$cacheExpirationTime = config('pwweb.localisation.cache.expiration_time', config('pwweb.localisation.cache_expiration_time'));

        self::$cacheKey = config('pwweb.localisation.cache.key');
        self::$cacheModelKey = config('pwweb.localisation.cache.model_key');

        $this->cache = $this->getCacheStoreFromConfig();
    }

    /**
     * Retrieve the cache store from the configuration of the package.
     *
     * @return Repository Cache store
     */
    protected function getCacheStoreFromConfig(): Repository
    {
        // the 'default' fallback here is from the localisation.php config file, where 'default' means to use config(cache.default)
        $cacheDriver = config('pwweb.localisation.cache.store', 'default');

        // when 'default' is specified, no action is required since we already have the default instance
        if ('default' === $cacheDriver) {
            return $this->cacheManager->store();
        }

        // if an undefined cache store is specified, fallback to 'array' which is Laravel's closest equiv to 'none'
        if (false === \array_key_exists($cacheDriver, config('cache.stores'))) {
            $cacheDriver = 'array';
        }

        return $this->cacheManager->store($cacheDriver);
    }

    /**
     * Register the languages check method.
     *
     * @return bool
     */
    public function registerLanguages(): bool
    {
        return true;
    }

    /**
     * Flush the cache.
     *
     * @return bool
     */
    public function forgetCachedAddresses()
    {
        $this->addresses = null;

        return $this->cache->forget(self::$cacheKey);
    }

    /**
     * Flush the cache.
     *
     * @return bool
     */
    public function forgetCachedLanguages()
    {
        $this->languages = null;

        return $this->cache->forget(self::$cacheKey);
    }

    /**
     * Clear class languages.
     * This is only intended to be called by the LocalisationServiceProvider on boot,
     * so that long-running instances like Swoole don't keep old data in memory.
     *
     * @return void
     */
    public function clearClassLanguages()
    {
        $this->languages = null;
    }

    /**
     * Get the addresses based on the passed params.
     *
     * @param array $params additional parameters for query
     *
     * @return \Illuminate\Support\Collection
     */
    public function getAddresses(array $params = []): Collection
    {
        if (null === $this->addresses) {
            $this->addresses = $this->cache->remember(
                self::$cacheKey . '.addresses',
                self::$cacheExpirationTime,
                function () {
                    return $this->getAddressClass()
                        //->with('system_address_types')
                        ->get();

The method get() does not exist on PWWEB\Localisation\Contracts\Address. Since it exists in all sub-types, consider adding an abstract or default implementation to PWWEB\Localisation\Contracts\Address.

                }
            );
        }

        $addresses = clone $this->addresses;

        foreach ($params as $attr => $value) {
            $attr = 'type' === $attr ? 'type.name' : $attr;
            $addresses = $addresses->where($attr, $value);
        }

        return $addresses;
    }

    /**
     * Get the languages based on the passed params.
     *
     * @param array $params additional parameters for query
     *
     * @return \Illuminate\Support\Collection
     */
    public function getLanguages(array $params = []): Collection
    {
        if (null === $this->languages) {
            $this->languages = $this->cache->remember(
                self::$cacheKey,
                self::$cacheExpirationTime,
                function () {
                    return $this->getLanguageClass()
                    //->with('countries')
                        ->get();

The method get() does not exist on PWWEB\Localisation\Contracts\Language. Since it exists in all sub-types, consider adding an abstract or default implementation to PWWEB\Localisation\Contracts\Language.

                }
            );
        }

        $languages = clone $this->languages;

        foreach ($params as $attr => $value) {
            $languages = $languages->where($attr, $value);
        }

        return $languages;
    }

    /**
     * Get an instance of the address class.
     *
     * @return PWWeb\Localisation\Contract\Address

The type PWWEB\Localisation\PWWeb\Localisation\Contract\Address was not found. Maybe you did not declare it correctly or list all dependencies?

     */
    public function getAddressClass(): Address
    {
        return app($this->addressClass);

The expression return app($this->addressClass) could return the type Illuminate\Contracts\Foundation\Application which is incompatible with the type-hinted return PWWeb\Localisation\Contracts\Address. Consider adding an additional type-check to rule them out.

    }

    /**
     * Get an instance of the address class.
     *
     * @return PWWeb\Localisation\Contract\Address\Type

The type PWWEB\Localisation\PWWeb\Localisation\Contract\Address\Type was not found. Maybe you did not declare it correctly or list all dependencies?

     */
    public function getAddressTypeClass(): AddressType
    {
        return app($this->addressTypeClass);

The expression return app($this->addressTypeClass) could return the type Illuminate\Contracts\Foundation\Application which is incompatible with the type-hinted return PWWeb\Localisation\Contracts\Address\Type. Consider adding an additional type-check to rule them out.

    }

    /**
     * Get an instance of the country class.
     *
     * @return PWWeb\Localisation\Contract\Country

The type PWWEB\Localisation\PWWeb\Localisation\Contract\Country was not found. Maybe you did not declare it correctly or list all dependencies?

     */
    public function getCountryClass(): Country
    {
        return app($this->countryClass);

The expression return app($this->countryClass) could return the type Illuminate\Contracts\Foundation\Application which is incompatible with the type-hinted return PWWeb\Localisation\Contracts\Country. Consider adding an additional type-check to rule them out.

    }

    /**
     * Get an instance of the currency class.
     *
     * @return PWWeb\Localisation\Contract\Currency

The type PWWEB\Localisation\PWWeb\Localisation\Contract\Currency was not found. Maybe you did not declare it correctly or list all dependencies?

     */
    public function getCurrencyClass(): Currency
    {
        return app($this->currencyClass);

The expression return app($this->currencyClass) could return the type Illuminate\Contracts\Foundation\Application which is incompatible with the type-hinted return PWWeb\Localisation\Contracts\Currency. Consider adding an additional type-check to rule them out.

    }

    /**
     * Get an instance of the language class.
     *
     * @return PWWeb\Localisation\Contract\Language

The type PWWEB\Localisation\PWWeb\Localisation\Contract\Language was not found. Maybe you did not declare it correctly or list all dependencies?

     */
    public function getLanguageClass(): Language
    {
        return app($this->languageClass);

The expression return app($this->languageClass) could return the type Illuminate\Contracts\Foundation\Application which is incompatible with the type-hinted return PWWeb\Localisation\Contracts\Language. Consider adding an additional type-check to rule them out.

    }

    /**
     * Set the instance of the address class.
     *
     * @param string $addressClass the address class to be used
     *
     * @return object
     */
    public function setAddressClass(string $addressClass)
    {
        $this->addressClass = $addressClass;

        return $this;
    }

    /**
     * Set the instance of the language class.
     *
     * @param string $languageClass the language class to be used
     *
     * @return object
     */
    public function setLanguageClass(string $languageClass)
    {
        $this->languageClass = $languageClass;

        return $this;
    }

    /**
     * Get the instance of the Cache Store.
     *
     * @return \Illuminate\Contracts\Cache\Store
     */
    public function getCacheStore(): \Illuminate\Contracts\Cache\Store
    {
        return $this->cache->getStore();
    }
}