ONGR\SettingsBundle\Settings\General\SettingsContainer

Complexity

Total Complexity

19

Size/Duplication

Total Lines	190
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	6

Importance

Changes	4
Bugs	2	Features	0

10 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	10	1
A	addProvider()	0	4	1
C	get()	0	40	8
A	onSettingChange()	0	6	1
A	getProfiles()	0	4	1
A	setProfiles()	0	4	1
A	addProfile()	0	4	1
A	getCache()	0	4	1
A	getSetting()	0	10	3
A	buildProvider()	0	7	1

<?php

/*
 * This file is part of the ONGR package.
 *
 * (c) NFQ Technologies UAB <info@nfq.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace ONGR\SettingsBundle\Settings\General;

use ONGR\SettingsBundle\Event\SettingChangeEvent;
use ONGR\SettingsBundle\Exception\SettingNotFoundException;
use ONGR\SettingsBundle\Settings\Personal\PersonalSettingsManager;
use ONGR\SettingsBundle\Settings\General\Provider\SettingsProviderInterface;
use ONGR\SettingsBundle\Settings\General\Provider\ManagerAwareSettingProvider;
use Stash\Interfaces\ItemInterface;
use Stash\Interfaces\PoolInterface;
use ONGR\ElasticsearchBundle\Service\Manager;

/**
 * This class provides access to application settings.
 */
class SettingsContainer implements SettingsContainerInterface
{
    /**
     * @var PoolInterface
     */
    private $pool;

    /**
     * Personal settings manager for handling
     * selected profiles
     *
     * @var PersonalSettingsManager
     */
    private $manager;

    /**
     * Elasticsearch manager for building profiders
     * @var Manager
     */
    private $esManager;

    /**
     * @var array
     */
    private $profiles = [];

    /**
     * @var SettingsProviderInterface[]
     */
    private $providers = [];

    /**
     * @var array
     */
    private $settings = [];

    /**
     * Constructor.
     *
     * @param PoolInterface              $pool
     * @param PersonalSettingsManager    $manager
     * @param Manager    $esManager
     */
    public function __construct(
        PoolInterface $pool,
        PersonalSettingsManager $manager,
        Manager $esManager
    )
    {
        $this->pool = $pool;
        $this->manager = $manager;
        $this->esManager = $esManager;
    }

    /**
     * {@inheritdoc}
     */
    public function addProvider(SettingsProviderInterface $provider)
    {
        $this->providers[] = $provider;
    }

    /**
     * {@inheritdoc}
     */
    public function get($setting)
    {
        $result = $this->getSetting($setting, false);

        if ($result !== null) {
            return $result;
        }
        $this->profiles = $this->manager->getActiveProfiles();

        foreach ($this->profiles as $profile) {
            if ($profile != 'default') {
                $this->addProvider($this->buildProvider($profile));
            }
        }
        $user = $this->manager->getUsername();
        $cachedSetting = $this->getCache($user);

        if (!$cachedSetting->isMiss()) {
            $cacheSettings = $cachedSetting->get();
            if (key($cacheSettings) == $user) {
                $this->settings = json_decode($cacheSettings[$user], true);

It seems like json_decode($cacheSettings[$user], true) of type * is incompatible with the declared type array of property $settings.

            }

            return $this->getSetting($setting);
        }

        $settings = [];

        foreach ($this->providers as $provider) {
            if (in_array($provider->getProfile(), $this->profiles)) {
                $settings = array_merge($settings, $provider->getSettings());
            }
        }

        $cachedSetting->set([$user => json_encode($settings)]);
        $this->pool->save($cachedSetting);
        $this->settings = array_merge($this->settings, $settings);

        return $this->getSetting($setting);
    }

    /**
     * Handles setting change event.
     *
     * @param SettingChangeEvent $event
     */
    public function onSettingChange(
        SettingChangeEvent $event

The parameter $event is not used and could be removed.

    ) {
        $user = $this->manager->getUsername();
        $this->pool->getItem('ongr_settings.settings_cache_'.$user)->clear();
    }

    /**
     * @return array
     */
    public function getProfiles()
    {
        return $this->profiles;
    }

    /**
     * @param array $profiles
     */
    public function setProfiles($profiles)
    {
        $this->profiles = $profiles;
    }

    /**
     * @param string $profile
     */
    public function addProfile($profile)
    {
        $this->profiles[] = $profile;
    }

    /**
     * Returns settings cache item.
     *
     * @param string $user
     *
     * @return ItemInterface
     */
    protected function getCache($user)
    {
        return $this->pool->getItem('ongr_settings.settings_cache_'.$user);
    }

    /**
     * Returns setting value.
     *
     * @param string $setting
     * @param bool   $throwException
     *
     * @return mixed
     *
     * @throws SettingNotFoundException
     */
    protected function getSetting($setting, $throwException = true)
    {
        if (array_key_exists($setting, $this->settings)) {
            return $this->settings[$setting];
        } elseif ($throwException) {
            throw new SettingNotFoundException("Setting '{$setting}' does not exist.");
        }

        return null;
    }

    /**
     * BuildProvider.
     *
     * @param string $profile
     *
     * @return ManagerAwareSettingProvider
     */
    private function buildProvider($profile)
    {
        $provider = new ManagerAwareSettingProvider($profile);
        $provider->setManager($this->esManager);

        return $provider;
    }
}