PersonalSettingsManager::getActiveProfiles() - Code Metrics - Inspection of "[WIP] Refactoring front end" - ongr-io/SettingsBundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#168)

unknown

created 2016-04-14 12:10 UTC

PersonalSettingsManager::getActiveProfiles() A

↳ Parent: PersonalSettingsManager

Complexity

Conditions	4
Paths	3

Size

Total Lines	12
Code Lines	8

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	12
rs	9.2
cc	4
eloc	8
nc	3
nop	0

<?php

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

namespace ONGR\SettingsBundle\Settings\Personal;

use Stash\Pool;
use ONGR\SettingsBundle\Settings\Personal\SettingsStructure;
use Symfony\Component\Security\Core\Authorization\AuthorizationChecker;
use Symfony\Component\Security\Core\Authentication\Token\Storage\TokenStorage;
use Symfony\Component\EventDispatcher\EventDispatcherInterface;
use ONGR\SettingsBundle\Event\SettingChangeEvent;

/**
 * Service responsible as a gateway to user settings.
 */
class PersonalSettingsManager
{
    /**
     * @var string
     */
    const ROLE_GRANTED = 'ROLE_ADMIN';

    /**
     * @var string
     */
    const STASH_NAME = 'ongr_settings';

    /**
     * @var EventDispatcherInterface
     */
    protected $eventDispatcher;

    /**
     * @var string
     */
    private $userParam;

    /**
     * Stash name for the current user
     *
     * @var string
     */
    private $stash;

    /**
     * @var AuthorizationChecker
     */
    private $securityContext;

    /**
     * @var TokenStorage
     */
    private $token;

    /**
     * @var SettingsStructure
     */
    private $settingsStructure;

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

    /**
     * Stash for storing personal settings
     *
     * @var \Pool
     */
    private $pool;

    /**
     * @param String                   $userParam
     * @param SettingsStructure        $settingsStructure
     * @param EventDispatcherInterface $eventDispatcher
     * @param AuthorizationChecker     $authorization
     * @param TokenStorage             $token
     * @param Pool                     $pool
     */
    public function __construct($userParam, $settingsStructure, $eventDispatcher, $authorization, $token, $pool)
    {
        $this->settingsStructure = $settingsStructure;
        $this->eventDispatcher = $eventDispatcher;
        $this->securityContext = $authorization;
        $this->token = $token;
        $this->pool = $pool;

        $this->userParam = $userParam;
    }

    /**
     * Sets settings for the current user from stash
     */
    public function setSettingsFromStash()
    {
        $this->stash = $this->getStashName($this->token->getToken()->getUser());
        $stashedSettings = $this->pool->getItem($this->stash)->get();
        if (is_array($stashedSettings)) {
            $this->userSettings = $stashedSettings;
        }
    }

    /**
     * @param array $settings
     */
    public function setSettings(array $settings)
    {
        $this->userSettings = $settings;
    }

    /**
     * If user logged in, returns setting value from cookie. Else, returns false.
     *
     * @param string $settingName
     * @param bool   $mustAuthorize
     *
     * @return bool
     */
    public function getSettingEnabled($settingName, $mustAuthorize = true)
    {
        if ($mustAuthorize && !$this->isAuthenticated()) {
            return false;
        }
        $this->setSettingsFromStash();
        if (isset($this->userSettings[$settingName])) {
            return $this->userSettings[$settingName];
        }

        return false;
    }

    /**
     * Saves the current settings to stash
     *
     * @throws \BadMethodCallException
     */
    public function save()
    {
        $stashedSettings = $this->pool->getItem($this->stash);
        $stashedSettings->set($this->userSettings);
        $this->pool->save($stashedSettings);

        $this->eventDispatcher->dispatch('ongr_settings.setting_change', new SettingChangeEvent('save'));
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
    }

    /**
     * Clears the stash
     */
    public function stashClear()
    {
        $this->pool->deleteItem($this->stash);
    }

    /**
     * @return bool
     */
    public function isAuthenticated()
    {
        return $this->securityContext->isGranted(self::ROLE_GRANTED);
    }

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

    /**
     * Gets active profiles
     *
     * @return array
     */
    public function getActiveProfiles()
    {
        $profiles = [];
        $this->setSettingsFromStash();
        foreach ($this->userSettings as $name => $userSetting) {
            if (preg_match('/^ongr_settings_profile_.*/', $name) && $userSetting) {
                $escapedProfile = mb_substr($name, 22, null, 'UTF-8');
                $profiles[] = UnderscoreEscaper::unescape($escapedProfile);
            }
        }
        return $profiles;
    }

    /**
     * @return array
     */
    public function getSettingsMap()
    {
        return $this->settingsStructure->getStructure();
    }

    /**
     * @return array
     */
    public function getCategoryMap()
    {
        return $this->settingsStructure->getCategoriesStructure();
    }

    /**
     * Returns the full name of the stash for the current
     * User. If the unique user property value cant be determined
     * returns false.
     *
     * @param $user
     *
     * @return string
     * @throws \BadMethodCallException
     */
    private function getStashName($user)
    {
        $property = $this->guessPropertyOrMethodName($user);
        $stashName =  self::STASH_NAME.'_';
        try {
            if ($property[0] == 'public') {
                $stashName = $stashName . $user->$property[1];
            } else {
                $method = $property[1];
                $stashName = $stashName . $user->$method();
            }
            $this->stash = $stashName;
            return $stashName;
        } catch (\Exception $e) {
            throw new \BadMethodCallException(
                'Ongr could not guess the getter method for your defined user property.'
            );
        }
    }

    /**
     * Returns the property visibility and if its
     * private, guesses the name of the getter
     *
     * @param $user
     *
     * @return array
     */
    private function guessPropertyOrMethodName($user)
    {
        $property = $this->userParam;
        if (isset($user->$property)) {
            return ['public', $this->userParam];
        } else {
            return ['private', $this->toCamelCase($this->userParam)];
        }
    }

    /**
     * Converts a string to camel case
     *
     * @param string $name
     *
     * @return string
     */
    private function toCamelCase($name)
    {
        $return = explode('_', $name);
        foreach ($return as $key => $item) {
            $return[$key] = ucfirst($item);
        }
        return 'get'.implode('', $return);
    }
}


1			<?php
2
3			/*
4			* This file is part of the ONGR package.
5			*
6			* (c) NFQ Technologies UAB <[email protected]>
7			*
8			* For the full copyright and license information, please view the LICENSE
9			* file that was distributed with this source code.
10			*/
11
12			namespace ONGR\SettingsBundle\Settings\Personal;
13
14			use Stash\Pool;
15			use ONGR\SettingsBundle\Settings\Personal\SettingsStructure;
16			use Symfony\Component\Security\Core\Authorization\AuthorizationChecker;
17			use Symfony\Component\Security\Core\Authentication\Token\Storage\TokenStorage;
18			use Symfony\Component\EventDispatcher\EventDispatcherInterface;
19			use ONGR\SettingsBundle\Event\SettingChangeEvent;
20
21			/**
22			* Service responsible as a gateway to user settings.
23			*/
24			class PersonalSettingsManager
25			{
26			/**
27			* @var string
28			*/
29			const ROLE_GRANTED = 'ROLE_ADMIN';
30
31			/**
32			* @var string
33			*/
34			const STASH_NAME = 'ongr_settings';
35
36			/**
37			* @var EventDispatcherInterface
38			*/
39			protected $eventDispatcher;
40
41			/**
42			* @var string
43			*/
44			private $userParam;
45
46			/**
47			* Stash name for the current user
48			*
49			* @var string
50			*/
51			private $stash;
52
53			/**
54			* @var AuthorizationChecker
55			*/
56			private $securityContext;
57
58			/**
59			* @var TokenStorage
60			*/
61			private $token;
62
63			/**
64			* @var SettingsStructure
65			*/
66			private $settingsStructure;
67
68			/**
69			* @var array;
70			*/
71			private $userSettings = [];
72
73			/**
74			* Stash for storing personal settings
75			*
76			* @var \Pool
77			*/
78			private $pool;
79
80			/**
81			* @param String $userParam
82			* @param SettingsStructure $settingsStructure
83			* @param EventDispatcherInterface $eventDispatcher
84			* @param AuthorizationChecker $authorization
85			* @param TokenStorage $token
86			* @param Pool $pool
87			*/
88			public function __construct($userParam, $settingsStructure, $eventDispatcher, $authorization, $token, $pool)
89			{
90			$this->settingsStructure = $settingsStructure;
91			$this->eventDispatcher = $eventDispatcher;
92			$this->securityContext = $authorization;
93			$this->token = $token;
94			$this->pool = $pool;
			0 ignored issues – show Documentation Bug introduced 2016-04-14 12:12 UTC by Report Bug Copy Issue Report It seems like `$pool` of type `object<Stash\Pool>` is incompatible with the declared type `object<Pool>` of property `$pool`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
95			$this->userParam = $userParam;
96			}
97
98			/**
99			* Sets settings for the current user from stash
100			*/
101			public function setSettingsFromStash()
102			{
103			$this->stash = $this->getStashName($this->token->getToken()->getUser());
104			$stashedSettings = $this->pool->getItem($this->stash)->get();
105			if (is_array($stashedSettings)) {
106			$this->userSettings = $stashedSettings;
107			}
108			}
109
110			/**
111			* @param array $settings
112			*/
113			public function setSettings(array $settings)
114			{
115			$this->userSettings = $settings;
116			}
117
118			/**
119			* If user logged in, returns setting value from cookie. Else, returns false.
120			*
121			* @param string $settingName
122			* @param bool $mustAuthorize
123			*
124			* @return bool
125			*/
126			public function getSettingEnabled($settingName, $mustAuthorize = true)
127			{
128			if ($mustAuthorize && !$this->isAuthenticated()) {
129			return false;
130			}
131			$this->setSettingsFromStash();
132			if (isset($this->userSettings[$settingName])) {
133			return $this->userSettings[$settingName];
134			}
135
136			return false;
137			}
138
139			/**
140			* Saves the current settings to stash
141			*
142			* @throws \BadMethodCallException
143			*/
144			public function save()
145			{
146			$stashedSettings = $this->pool->getItem($this->stash);
147			$stashedSettings->set($this->userSettings);
148			$this->pool->save($stashedSettings);
149
150			$this->eventDispatcher->dispatch('ongr_settings.setting_change', new SettingChangeEvent('save'));
			0 ignored issues – show Documentation introduced 2016-04-14 12:12 UTC by Report Bug Copy Issue Report `'save'` is of type `string`, but the function expects a `object<ONGR\SettingsBundle\Event\Action>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
151			}
152
153			/**
154			* Clears the stash
155			*/
156			public function stashClear()
157			{
158			$this->pool->deleteItem($this->stash);
159			}
160
161			/**
162			* @return bool
163			*/
164			public function isAuthenticated()
165			{
166			return $this->securityContext->isGranted(self::ROLE_GRANTED);
167			}
168
169			/**
170			* @return array
171			*/
172			public function getSettings()
173			{
174			return $this->userSettings;
175			}
176
177			/**
178			* Gets active profiles
179			*
180			* @return array
181			*/
182			public function getActiveProfiles()
183			{
184			$profiles = [];
185			$this->setSettingsFromStash();
186			foreach ($this->userSettings as $name => $userSetting) {
187			if (preg_match('/^ongr_settings_profile_.*/', $name) && $userSetting) {
188			$escapedProfile = mb_substr($name, 22, null, 'UTF-8');
189			$profiles[] = UnderscoreEscaper::unescape($escapedProfile);
190			}
191			}
192			return $profiles;
193			}
194
195			/**
196			* @return array
197			*/
198			public function getSettingsMap()
199			{
200			return $this->settingsStructure->getStructure();
201			}
202
203			/**
204			* @return array
205			*/
206			public function getCategoryMap()
207			{
208			return $this->settingsStructure->getCategoriesStructure();
209			}
210
211			/**
212			* Returns the full name of the stash for the current
213			* User. If the unique user property value cant be determined
214			* returns false.
215			*
216			* @param $user
217			*
218			* @return string
219			* @throws \BadMethodCallException
220			*/
221			private function getStashName($user)
222			{
223			$property = $this->guessPropertyOrMethodName($user);
224			$stashName = self::STASH_NAME.'_';
225			try {
226			if ($property[0] == 'public') {
227			$stashName = $stashName . $user->$property[1];
228			} else {
229			$method = $property[1];
230			$stashName = $stashName . $user->$method();
231			}
232			$this->stash = $stashName;
233			return $stashName;
234			} catch (\Exception $e) {
235			throw new \BadMethodCallException(
236			'Ongr could not guess the getter method for your defined user property.'
237			);
238			}
239			}
240
241			/**
242			* Returns the property visibility and if its
243			* private, guesses the name of the getter
244			*
245			* @param $user
246			*
247			* @return array
248			*/
249			private function guessPropertyOrMethodName($user)
250			{
251			$property = $this->userParam;
252			if (isset($user->$property)) {
253			return ['public', $this->userParam];
254			} else {
255			return ['private', $this->toCamelCase($this->userParam)];
256			}
257			}
258
259			/**
260			* Converts a string to camel case
261			*
262			* @param string $name
263			*
264			* @return string
265			*/
266			private function toCamelCase($name)
267			{
268			$return = explode('_', $name);
269			foreach ($return as $key => $item) {
270			$return[$key] = ucfirst($item);
271			}
272			return 'get'.implode('', $return);
273			}
274			}
275

ongr-io / SettingsBundle

Pull Request — master (#168)

PersonalSettingsManager::getActiveProfiles() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like