Pomm::getSession() - Code Metrics - Inspection of "enable telemetry extension on CI builds" - pomm-project/Foundation - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — 2.0 (#75)

by Julien

created 2016-07-01 16:47 UTC

Pomm::getSession() A

↳ Parent: Pomm

Complexity

Conditions	2
Paths	2

Size

Total Lines	8
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	8
c	0
b	0
f	0
rs	9.4285
cc	2
eloc	4
nc	2
nop	1

<?php
/*
 * This file is part of the PommProject/Foundation package.
 *
 * (c) 2014 - 2015 Grégoire HUBERT <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */
namespace PommProject\Foundation;

use PommProject\Foundation\Exception\FoundationException;
use PommProject\Foundation\Session\SessionBuilder as VanillaSessionBuilder;
use PommProject\Foundation\Session\Session as BaseSession;
use Psr\Log\LoggerAwareInterface;
use Psr\Log\LoggerAwareTrait;

/**
 * Pomm
 *
 * The Pomm service manager.
 *
 * @package     Foundation
 * @copyright   2014 - 2015 Grégoire HUBERT
 * @author      Grégoire HUBERT
 * @license     X11 {@link http://opensource.org/licenses/mit-license.php}
 */
class Pomm implements \ArrayAccess, LoggerAwareInterface
{
    protected $builders = [];
    protected $post_configurations = [];
    protected $sessions = [];
    protected $default;

    use LoggerAwareTrait;

    /**
     * __construct
     *
     * Instantiate a new Pomm Service class. It takes an array of
     * configurations as parameter. Following configuration settings are
     * supported by this service for each configuration:
     *
     * class_name   name of the DatabaseConfiguration class to instantiate.
     *
     * @access  public
     * @param   array $configurations
     */
    public function __construct(array $configurations = [])
    {
        foreach ($configurations as $name => $configuration) {
            $builder_class = '\PommProject\Foundation\SessionBuilder';
            if (isset($configuration['class:session_builder'])) {
                $builder_class = $this->checkSessionBuilderClass($configuration['class:session_builder']);
            }

            $this->addBuilder($name, new $builder_class($configuration));

            if (isset($configuration['pomm:default']) && $configuration['pomm:default'] === true) {
                $this->setDefaultBuilder($name);
            }
        }
    }

    /**
     * checkSessionBuilderClass
     *
     * Check if the given builder class is valid.
     *
     * @access  private
     * @param   string              $builder_class
     * @throws  FoundationException if not valid
     * @return  string              $builder_class
     */
    private function checkSessionBuilderClass($builder_class)
    {
        try {
            $reflection = new \ReflectionClass($builder_class);

            if (!$reflection->isSubclassOf('\PommProject\Foundation\Session\SessionBuilder')) {
                throw new FoundationException(
                    sprintf(
                        "Class '%s' is not a subclass of \PommProject\Foundation\Session\SessionBuilder.",
                        $builder_class
                    )
                );
            }
        } catch (\ReflectionException $e) {
            throw new FoundationException(
                sprintf(
                    "Could not instantiate class '%s'.",
                    $builder_class
                ),
                null,
                $e
            );
        }

        return $builder_class;
    }

    /**
     * setDefaultBuilder
     *
     * Set the name for the default session builder.
     *
     * @access  public
     * @param   string  $name
     * @return  Pomm    $this
     * @throws FoundationException
     */
    public function setDefaultBuilder($name)
    {
        if (!$this->hasBuilder($name)) {
            throw new FoundationException(
                sprintf(
                    "No such builder '%s'.",
                    $name
                )
            );
        }

        $this->default = $name;

        return $this;
    }

    /**
     * getDefaultSession
     *
     * Return a session built by the default session builder.
     *
     * @access  public
     * @return  BaseSession
     * @throws FoundationException
     */
    public function getDefaultSession()
    {
        if ($this->default === null) {
            throw new FoundationException(
                "No default session builder set."
            )
            ;
        }

        return $this->getSession($this->default);
    }

    /**
     * isDefaultSession
     *
     * Check if $name is a default session builder
     *
     * @param   string $name
     * @return  bool
     */
    public function isDefaultSession($name)
    {
        return (bool) ($this->default == $name);
    }

    /**
     * addBuilder
     *
     * Add a new session builder. Override any previously existing builder with
     * the same name.
     *
     * @access  public
     * @param   string                   $builder_name
     * @param   VanillaSessionBuilder    $builder
     * @return  Pomm                     $this
     */
    public function addBuilder($builder_name, VanillaSessionBuilder $builder)
    {
        $this->builders[$builder_name] = $builder;
        $this->post_configurations[$builder_name] = [];

        if ($this->default === null) {
            $this->setDefaultBuilder($builder_name);
        }

        return $this;
    }

    /**
     * addPostConfiguration
     *
     * Add a environment dependent post configuration callable that will be run
     * once after the session creation.
     *
     * @access  public
     * @param   string   $name
     * @param   callable $callable
     * @return  Pomm     $this
     */
    public function addPostConfiguration($name, callable $callable)
    {
        $this
            ->builderMustExist($name)
            ->post_configurations[$name][] = $callable
            ;

        return $this;
    }

    /**
     * hasBuilder
     *
     * Return if true or false the given builder exists.
     *
     * @access  public
     * @param   string $name
     * @return  bool
     */
    public function hasBuilder($name)
    {
        return (bool) (isset($this->builders[$name]));
    }

    /**
     * removeBuilder
     *
     * Remove the builder with the given name.
     *
     * @access  public
     * @param   string   $name
     * @throws  FoundationException if name does not exist.
     * @return  Pomm     $this
     */
    public function removeBuilder($name)
    {
        unset(
            $this->builderMustExist($name)->builders[$name],
            $this->post_configurations[$name]
        );

        return $this;
    }

    /**
     * getBuilder
     *
     * Return the given builder.
     *
     * @access  public
     * @param   string $name
     * @return  VanillaSessionBuilder
     */
    public function getBuilder($name)
    {
        return $this->builderMustExist($name)->builders[$name];
    }

    /**
     * getSession
     *
     * Return a session from the pool. If no session exists, an attempt is made
     * to create one.
     *
     * @access  public
     * @param   string  $name
     * @return  BaseSession
     */
    public function getSession($name)
    {
        if (!$this->hasSession($name)) {
            $this->createSession($name);
        }

        return $this->sessions[$name];
    }

    /**
     * createSession
     *
     * Create a new session using a session_builder and set it to the pool. Any
     * previous session for this name is overrided.
     *
     * @access  public
     * @param   string  $name
     * @throws  FoundationException if builder does not exist.
     * @return  BaseSession
     */
    public function createSession($name)
    {
        $this->sessions[$name] = $this
            ->builderMustExist($name)
            ->builders[$name]
            ->buildSession($name)
            ;

        $session = $this->sessions[$name];

        foreach ($this->post_configurations[$name] as $callable) {
            call_user_func($callable, $session);
        }

        if ($this->logger !== null) {
            $session->setLogger($this->logger);
        }

        return $session;
    }

    /**
     * hasSession
     *
     * Does a given session exist in the pool ?
     *
     * @access  public
     * @param   string $name
     * @return  bool
     */
    public function hasSession($name)
    {
        return (bool) isset($this->sessions[$name]);
    }

    /**
     * removeSession
     *
     * Remove a session from the pool if it exists.
     *
     * @access  public
     * @param   string              $name
     * @throws  FoundationException if no builders with that name exist
     * @return  Pomm                $this
     */
    public function removeSession($name)
    {
        if ($this->builderMustExist($name)->hasSession($name)) {
            unset($this->sessions[$name]);
        }

        return $this;
    }

    /**
     * getSessionBuilders
     *
     * Return the builders. This is mainly done for testing
     * purposes.
     *
     * @access  public
     * @return  array
     */
    public function getSessionBuilders()
    {
        return $this->builders;
    }

    /**
     * @see ArrayAccess
     */
    public function offsetGet($offset)
    {
        return $this->getSession($offset);
    }

    /**
     * @see ArrayAccess
     */
    public function offsetSet($offset, $value)
    {
        $this->addBuilder($offset, $value);
    }

    /**
     * @see ArrayAccess
     */
    public function offsetUnset($offset)
    {
        $this->removeBuilder($offset);
    }

    /**
     * @see ArrayAccess
     */
    public function offsetExists($offset)
    {
        return $this->hasBuilder($offset);
    }

    /**
     * shutdown
     *
     * Shutdown and remove sessions from the service. If no arguments are
     * given, all the instantiated sessions are shutdown. Otherwise, only given
     * sessions are shutdown.
     *
     * @access public
     * @param  array $session_names
     * @return Pomm  $this
     */
    public function shutdown(array $session_names = [])
    {
        if (empty($session_names)) {
            $sessions = array_keys($this->sessions);
        } else {
            array_map([ $this, 'builderMustExist' ], $session_names);
            $sessions = array_intersect(
                array_keys($this->sessions),
                $session_names
            );
        }

        foreach ($sessions as $session_name) {
            $this->getSession($session_name)->shutdown();
            $this->removeSession($session_name);
        }

        return $this;
    }

    /**
     * builderMustExist
     *
     * Throw a FoundationException if the given builder does not exist.
     *
     * @access  private
     * @param   string   $name
     * @throws  FoundationException
     * @return  Pomm      $this
     */
    private function builderMustExist($name)
    {
        if (!$this->hasBuilder($name)) {
            throw new FoundationException(
                sprintf(
                    "No such builder '%s'. Available builders are {%s}.",
                    $name,
                    join(
                        ', ',
                        array_map(
                            function ($val) {
                                return sprintf("'%s'", $val);
                            },
                            array_keys($this->getSessionBuilders())
                        )
                    )
                )
            );
        }

        return $this;
    }
}


1			<?php
2			/*
3			* This file is part of the PommProject/Foundation package.
4			*
5			* (c) 2014 - 2015 Grégoire HUBERT <[email protected]>
6			*
7			* For the full copyright and license information, please view the LICENSE
8			* file that was distributed with this source code.
9			*/
10			namespace PommProject\Foundation;
11
12			use PommProject\Foundation\Exception\FoundationException;
13			use PommProject\Foundation\Session\SessionBuilder as VanillaSessionBuilder;
14			use PommProject\Foundation\Session\Session as BaseSession;
15			use Psr\Log\LoggerAwareInterface;
16			use Psr\Log\LoggerAwareTrait;
17
18			/**
19			* Pomm
20			*
21			* The Pomm service manager.
22			*
23			* @package Foundation
24			* @copyright 2014 - 2015 Grégoire HUBERT
25			* @author Grégoire HUBERT
26			* @license X11 {@link http://opensource.org/licenses/mit-license.php}
27			*/
28			class Pomm implements \ArrayAccess, LoggerAwareInterface
29			{
30			protected $builders = [];
31			protected $post_configurations = [];
32			protected $sessions = [];
33			protected $default;
34
35			use LoggerAwareTrait;
36
37			/**
38			* __construct
39			*
40			* Instantiate a new Pomm Service class. It takes an array of
41			* configurations as parameter. Following configuration settings are
42			* supported by this service for each configuration:
43			*
44			* class_name name of the DatabaseConfiguration class to instantiate.
45			*
46			* @access public
47			* @param array $configurations
48			*/
49			public function __construct(array $configurations = [])
50			{
51			foreach ($configurations as $name => $configuration) {
52			$builder_class = '\PommProject\Foundation\SessionBuilder';
53			if (isset($configuration['class:session_builder'])) {
54			$builder_class = $this->checkSessionBuilderClass($configuration['class:session_builder']);
55			}
56
57			$this->addBuilder($name, new $builder_class($configuration));
58
59			if (isset($configuration['pomm:default']) && $configuration['pomm:default'] === true) {
60			$this->setDefaultBuilder($name);
61			}
62			}
63			}
64
65			/**
66			* checkSessionBuilderClass
67			*
68			* Check if the given builder class is valid.
69			*
70			* @access private
71			* @param string $builder_class
72			* @throws FoundationException if not valid
73			* @return string $builder_class
74			*/
75			private function checkSessionBuilderClass($builder_class)
76			{
77			try {
78			$reflection = new \ReflectionClass($builder_class);
79
80			if (!$reflection->isSubclassOf('\PommProject\Foundation\Session\SessionBuilder')) {
81			throw new FoundationException(
82			sprintf(
83			"Class '%s' is not a subclass of \PommProject\Foundation\Session\SessionBuilder.",
84			$builder_class
85			)
86			);
87			}
88			} catch (\ReflectionException $e) {
89			throw new FoundationException(
90			sprintf(
91			"Could not instantiate class '%s'.",
92			$builder_class
93			),
94			null,
95			$e
96			);
97			}
98
99			return $builder_class;
100			}
101
102			/**
103			* setDefaultBuilder
104			*
105			* Set the name for the default session builder.
106			*
107			* @access public
108			* @param string $name
109			* @return Pomm $this
110			* @throws FoundationException
111			*/
112			public function setDefaultBuilder($name)
113			{
114			if (!$this->hasBuilder($name)) {
115			throw new FoundationException(
116			sprintf(
117			"No such builder '%s'.",
118			$name
119			)
120			);
121			}
122
123			$this->default = $name;
124
125			return $this;
126			}
127
128			/**
129			* getDefaultSession
130			*
131			* Return a session built by the default session builder.
132			*
133			* @access public
134			* @return BaseSession
135			* @throws FoundationException
136			*/
137			public function getDefaultSession()
138			{
139			if ($this->default === null) {
140			throw new FoundationException(
141			"No default session builder set."
142			)
143			;
144			}
145
146			return $this->getSession($this->default);
147			}
148
149			/**
150			* isDefaultSession
151			*
152			* Check if $name is a default session builder
153			*
154			* @param string $name
155			* @return bool
156			*/
157			public function isDefaultSession($name)
158			{
159			return (bool) ($this->default == $name);
160			}
161
162			/**
163			* addBuilder
164			*
165			* Add a new session builder. Override any previously existing builder with
166			* the same name.
167			*
168			* @access public
169			* @param string $builder_name
170			* @param VanillaSessionBuilder $builder
171			* @return Pomm $this
172			*/
173			public function addBuilder($builder_name, VanillaSessionBuilder $builder)
174			{
175			$this->builders[$builder_name] = $builder;
176			$this->post_configurations[$builder_name] = [];
177
178			if ($this->default === null) {
179			$this->setDefaultBuilder($builder_name);
180			}
181
182			return $this;
183			}
184
185			/**
186			* addPostConfiguration
187			*
188			* Add a environment dependent post configuration callable that will be run
189			* once after the session creation.
190			*
191			* @access public
192			* @param string $name
193			* @param callable $callable
194			* @return Pomm $this
195			*/
196			public function addPostConfiguration($name, callable $callable)
197			{
198			$this
199			->builderMustExist($name)
200			->post_configurations[$name][] = $callable
201			;
202
203			return $this;
204			}
205
206			/**
207			* hasBuilder
208			*
209			* Return if true or false the given builder exists.
210			*
211			* @access public
212			* @param string $name
213			* @return bool
214			*/
215			public function hasBuilder($name)
216			{
217			return (bool) (isset($this->builders[$name]));
218			}
219
220			/**
221			* removeBuilder
222			*
223			* Remove the builder with the given name.
224			*
225			* @access public
226			* @param string $name
227			* @throws FoundationException if name does not exist.
228			* @return Pomm $this
229			*/
230			public function removeBuilder($name)
231			{
232			unset(
233			$this->builderMustExist($name)->builders[$name],
234			$this->post_configurations[$name]
235			);
236
237			return $this;
238			}
239
240			/**
241			* getBuilder
242			*
243			* Return the given builder.
244			*
245			* @access public
246			* @param string $name
247			* @return VanillaSessionBuilder
248			*/
249			public function getBuilder($name)
250			{
251			return $this->builderMustExist($name)->builders[$name];
252			}
253
254			/**
255			* getSession
256			*
257			* Return a session from the pool. If no session exists, an attempt is made
258			* to create one.
259			*
260			* @access public
261			* @param string $name
262			* @return BaseSession
263			*/
264			public function getSession($name)
265			{
266			if (!$this->hasSession($name)) {
267			$this->createSession($name);
268			}
269
270			return $this->sessions[$name];
271			}
272
273			/**
274			* createSession
275			*
276			* Create a new session using a session_builder and set it to the pool. Any
277			* previous session for this name is overrided.
278			*
279			* @access public
280			* @param string $name
281			* @throws FoundationException if builder does not exist.
282			* @return BaseSession
283			*/
284			public function createSession($name)
285			{
286			$this->sessions[$name] = $this
287			->builderMustExist($name)
288			->builders[$name]
289			->buildSession($name)
290			;
291
292			$session = $this->sessions[$name];
293
294			foreach ($this->post_configurations[$name] as $callable) {
295			call_user_func($callable, $session);
296			}
297
298			if ($this->logger !== null) {
299			$session->setLogger($this->logger);
300			}
301
302			return $session;
303			}
304
305			/**
306			* hasSession
307			*
308			* Does a given session exist in the pool ?
309			*
310			* @access public
311			* @param string $name
312			* @return bool
313			*/
314			public function hasSession($name)
315			{
316			return (bool) isset($this->sessions[$name]);
317			}
318
319			/**
320			* removeSession
321			*
322			* Remove a session from the pool if it exists.
323			*
324			* @access public
325			* @param string $name
326			* @throws FoundationException if no builders with that name exist
327			* @return Pomm $this
328			*/
329			public function removeSession($name)
330			{
331			if ($this->builderMustExist($name)->hasSession($name)) {
332			unset($this->sessions[$name]);
333			}
334
335			return $this;
336			}
337
338			/**
339			* getSessionBuilders
340			*
341			* Return the builders. This is mainly done for testing
342			* purposes.
343			*
344			* @access public
345			* @return array
346			*/
347			public function getSessionBuilders()
348			{
349			return $this->builders;
350			}
351
352			/**
353			* @see ArrayAccess
354			*/
355			public function offsetGet($offset)
356			{
357			return $this->getSession($offset);
358			}
359
360			/**
361			* @see ArrayAccess
362			*/
363			public function offsetSet($offset, $value)
364			{
365			$this->addBuilder($offset, $value);
366			}
367
368			/**
369			* @see ArrayAccess
370			*/
371			public function offsetUnset($offset)
372			{
373			$this->removeBuilder($offset);
374			}
375
376			/**
377			* @see ArrayAccess
378			*/
379			public function offsetExists($offset)
380			{
381			return $this->hasBuilder($offset);
382			}
383
384			/**
385			* shutdown
386			*
387			* Shutdown and remove sessions from the service. If no arguments are
388			* given, all the instantiated sessions are shutdown. Otherwise, only given
389			* sessions are shutdown.
390			*
391			* @access public
392			* @param array $session_names
393			* @return Pomm $this
394			*/
395			public function shutdown(array $session_names = [])
396			{
397			if (empty($session_names)) {
398			$sessions = array_keys($this->sessions);
399			} else {
400			array_map([ $this, 'builderMustExist' ], $session_names);
401			$sessions = array_intersect(
402			array_keys($this->sessions),
403			$session_names
404			);
405			}
406
407			foreach ($sessions as $session_name) {
408			$this->getSession($session_name)->shutdown();
409			$this->removeSession($session_name);
410			}
411
412			return $this;
413			}
414
415			/**
416			* builderMustExist
417			*
418			* Throw a FoundationException if the given builder does not exist.
419			*
420			* @access private
421			* @param string $name
422			* @throws FoundationException
423			* @return Pomm $this
424			*/
425			private function builderMustExist($name)
426			{
427			if (!$this->hasBuilder($name)) {
428			throw new FoundationException(
429			sprintf(
430			"No such builder '%s'. Available builders are {%s}.",
431			$name,
432			join(
433			', ',
434			array_map(
435			function ($val) {
436			return sprintf("'%s'", $val);
437			},
438			array_keys($this->getSessionBuilders())
439			)
440			)
441			)
442			);
443			}
444
445			return $this;
446			}
447			}
448

pomm-project / Foundation

Pull Request — 2.0 (#75)

Pomm::getSession() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like