SessionHandler::newSession() - Code Metrics - Inspection of "Merge branch 'release/0.3.0'" - jnjxp/jnjxp.molniya - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( bb2ad6...8d3233 )

by jake

created 2016-02-10 06:51 UTC

SessionHandler::newSession() A

↳ Parent: SessionHandler

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	4
ccs	2
cts	2
cp	1
rs	10
cc	1
eloc	2
nc	1
nop	1
crap	1

<?php
/**
 * Molniya - Flash Messenger
 *
 * PHP version 5
 *
 * This program is free software: you can redistribute it and/or modify it
 * under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or (at your
 * option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 * @category  Middleware
 * @package   Jnjxp\Molniya
 * @author    Jake Johns <[email protected]>
 * @copyright 2016 Jake Johns
 * @license   http://www.gnu.org/licenses/agpl-3.0.txt AGPL V3
 * @link      https://github.com/jnjxp/jnjxp.molniya
 */

namespace Jnjxp\Molniya;

use Aura\Session\SessionFactory;
use Aura\Session\Session;

use Jnjxp\Molniya\FlashMessengerFactory as MessengerFactory;
use Jnjxp\Molniya\FlashMessenger as Messenger;

use Psr\Http\Message\ServerRequestInterface as Request;
use Psr\Http\Message\ResponseInterface as Response;

/**
 * SessionHandler
 *
 * @category Middleware
 * @package  Jnjxp\Molniya
 * @author   Jake Johns <[email protected]>
 * @license  http://www.gnu.org/licenses/agpl-3.0.txt AGPL V3
 * @link     https://github.com/jnjxp/jnjxp.molniya
 */
class SessionHandler
{
    /**
     * Session factory
     *
     * @var SessionFactory
     *
     * @access protected
     */
    protected $sessionFactory;

    /**
     * Flash messenger factory
     *
     * @var MessengerFactory
     *
     * @access protected
     */
    protected $messengerFactory;

    /**
     * Session attribute
     *
     * @var string
     *
     * @access protected
     */
    protected $sessionAttribute = 'aura/session:session';

    /**
     * Messenger attribute
     *
     * @var string
     *
     * @access protected
     */
    protected $messengerAttribute = 'jnjxp/molniya:messenger';

    /**
     * Messenger namespace
     *
     * @var string
     *
     * @access protected
     */
    protected $messengerNamespace = 'Jnjxp\Molniya';

    /**
     * Create a session handler
     *
     * @param SessionFactory   $sessionFactory   Session factory
     * @param MessengerFactory $messengerFactory Flash messenger factory
     *
     * @access public
     */
    public function __construct(
        SessionFactory $sessionFactory = null,
        MessengerFactory $messengerFactory = null
    ) {
        $this->sessionFactory = $sessionFactory ?: new SessionFactory();
        $this->messengerFactory = $messengerFactory ?: new MessengerFactory();
    }

    /**
     * Set session attribute
     *
     * @param string $attr name of attribute for session
     *
     * @return $this
     *
     * @access public
     */
    public function setSessionAttribute($attr)
    {
        $this->sessionAttribute = $attr;
        return $this;
    }

    /**
     * Set messenger attribute
     *
     * @param string $attr name of attribute for messenger
     *
     * @return $this
     *
     * @access public
     */
    public function setMessengerAttribute($attr)
    {
        $this->messengerAttribute = $attr;
        return $this;
    }

    /**
     * Set messenger namespace
     *
     * @param string $name namespace for messenger segment
     *
     * @return $this
     *
     * @access public
     */
    public function setMessengerNamespace($name)
    {
        $this->messengerNamespace = $name;
        return $this;
    }

    /**
     * Create session and messenger and set them as request attributes
     *
     * @param Request  $request  PSR7 Request
     * @param Response $response PSR7 Response
     * @param callable $next     Next callable middleware
     *
     * @return Response
     *
     * @access public
     */
    public function __invoke(Request $request, Response $response, callable $next)
    {
        $session = $this->newSession($request);
        $request = $this->setRequestSession($request, $session);

        $messenger = $this->newMessenger($session);
        $request = $this->setRequestMessenger($request, $messenger);

        return $next($request, $response);
    }

    /**
     * Create a new session from request
     *
     * @param Request $request PSR7 request
     *
     * @return Session
     *
     * @access protected
     */
    protected function newSession(Request $request)
    {
        return $this->sessionFactory->newInstance($request->getCookieParams());
    }

    /**
     * Store session in request attribute if attributes present
     *
     * @param Request $request PSR7 request
     * @param Session $session Session object
     *
     * @return Request
     *
     * @access protected
     */
    protected function setRequestSession(Request $request, Session $session)
    {
        if ($this->sessionAttribute !== null) {
            $request = $request->withAttribute(
                $this->sessionAttribute,
                $session
            );
        }
        return $request;
    }

    /**
     * Create new messenger from session
     *
     * @param Session $session Session object
     *
     * @return Messenger
     *
     * @access protected
     */
    protected function newMessenger(Session $session)
    {
        return $this->messengerFactory
            ->setSession($session)
            ->newInstance($this->messengerNamespace);
    }

    /**
     * Set messenger as request attribute if attribute preesent
     *
     * @param Request   $request   DESCRIPTION
     * @param Messenger $messenger DESCRIPTION
     *
     * @return Request
     *
     * @access protected
     */
    protected function setRequestMessenger(Request $request, Messenger $messenger)
    {
        if ($this->messengerAttribute !== null) {
            $request = $request->withAttribute(
                $this->messengerAttribute,
                $messenger
            );
        }
        return $request;
    }
}


1		<?php
2		/**
3		* Molniya - Flash Messenger
4		*
5		* PHP version 5
6		*
7		* This program is free software: you can redistribute it and/or modify it
8		* under the terms of the GNU Affero General Public License as published by
9		* the Free Software Foundation, either version 3 of the License, or (at your
10		* option) any later version.
11		*
12		* This program is distributed in the hope that it will be useful,
13		* but WITHOUT ANY WARRANTY; without even the implied warranty of
14		* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15		* GNU Affero General Public License for more details.
16		*
17		* You should have received a copy of the GNU Affero General Public License
18		* along with this program. If not, see <http://www.gnu.org/licenses/>.
19		*
20		* @category Middleware
21		* @package Jnjxp\Molniya
22		* @author Jake Johns <[email protected]>
23		* @copyright 2016 Jake Johns
24		* @license http://www.gnu.org/licenses/agpl-3.0.txt AGPL V3
25		* @link https://github.com/jnjxp/jnjxp.molniya
26		*/
27
28		namespace Jnjxp\Molniya;
29
30		use Aura\Session\SessionFactory;
31		use Aura\Session\Session;
32
33		use Jnjxp\Molniya\FlashMessengerFactory as MessengerFactory;
34		use Jnjxp\Molniya\FlashMessenger as Messenger;
35
36		use Psr\Http\Message\ServerRequestInterface as Request;
37		use Psr\Http\Message\ResponseInterface as Response;
38
39		/**
40		* SessionHandler
41		*
42		* @category Middleware
43		* @package Jnjxp\Molniya
44		* @author Jake Johns <[email protected]>
45		* @license http://www.gnu.org/licenses/agpl-3.0.txt AGPL V3
46		* @link https://github.com/jnjxp/jnjxp.molniya
47		*/
48		class SessionHandler
49		{
50		/**
51		* Session factory
52		*
53		* @var SessionFactory
54		*
55		* @access protected
56		*/
57		protected $sessionFactory;
58
59		/**
60		* Flash messenger factory
61		*
62		* @var MessengerFactory
63		*
64		* @access protected
65		*/
66		protected $messengerFactory;
67
68		/**
69		* Session attribute
70		*
71		* @var string
72		*
73		* @access protected
74		*/
75		protected $sessionAttribute = 'aura/session:session';
76
77		/**
78		* Messenger attribute
79		*
80		* @var string
81		*
82		* @access protected
83		*/
84		protected $messengerAttribute = 'jnjxp/molniya:messenger';
85
86		/**
87		* Messenger namespace
88		*
89		* @var string
90		*
91		* @access protected
92		*/
93		protected $messengerNamespace = 'Jnjxp\Molniya';
94
95		/**
96		* Create a session handler
97		*
98		* @param SessionFactory $sessionFactory Session factory
99		* @param MessengerFactory $messengerFactory Flash messenger factory
100		*
101		* @access public
102		*/
103	1	public function __construct(
104		SessionFactory $sessionFactory = null,
105		MessengerFactory $messengerFactory = null
106		) {
107	1	$this->sessionFactory = $sessionFactory ?: new SessionFactory();
108	1	$this->messengerFactory = $messengerFactory ?: new MessengerFactory();
109	1	}
110
111		/**
112		* Set session attribute
113		*
114		* @param string $attr name of attribute for session
115		*
116		* @return $this
117		*
118		* @access public
119		*/
120	1	public function setSessionAttribute($attr)
121		{
122	1	$this->sessionAttribute = $attr;
123	1	return $this;
124		}
125
126		/**
127		* Set messenger attribute
128		*
129		* @param string $attr name of attribute for messenger
130		*
131		* @return $this
132		*
133		* @access public
134		*/
135	1	public function setMessengerAttribute($attr)
136		{
137	1	$this->messengerAttribute = $attr;
138	1	return $this;
139		}
140
141		/**
142		* Set messenger namespace
143		*
144		* @param string $name namespace for messenger segment
145		*
146		* @return $this
147		*
148		* @access public
149		*/
150	1	public function setMessengerNamespace($name)
151		{
152	1	$this->messengerNamespace = $name;
153	1	return $this;
154		}
155
156		/**
157		* Create session and messenger and set them as request attributes
158		*
159		* @param Request $request PSR7 Request
160		* @param Response $response PSR7 Response
161		* @param callable $next Next callable middleware
162		*
163		* @return Response
164		*
165		* @access public
166		*/
167	1	public function __invoke(Request $request, Response $response, callable $next)
168		{
169	1	$session = $this->newSession($request);
170	1	$request = $this->setRequestSession($request, $session);
171
172	1	$messenger = $this->newMessenger($session);
173	1	$request = $this->setRequestMessenger($request, $messenger);
174
175	1	return $next($request, $response);
176		}
177
178		/**
179		* Create a new session from request
180		*
181		* @param Request $request PSR7 request
182		*
183		* @return Session
184		*
185		* @access protected
186		*/
187	1	protected function newSession(Request $request)
188		{
189	1	return $this->sessionFactory->newInstance($request->getCookieParams());
190		}
191
192		/**
193		* Store session in request attribute if attributes present
194		*
195		* @param Request $request PSR7 request
196		* @param Session $session Session object
197		*
198		* @return Request
199		*
200		* @access protected
201		*/
202	1	protected function setRequestSession(Request $request, Session $session)
203		{
204	1	if ($this->sessionAttribute !== null) {
205	1	$request = $request->withAttribute(
206	1	$this->sessionAttribute,
207		$session
208	1	);
209	1	}
210	1	return $request;
211		}
212
213		/**
214		* Create new messenger from session
215		*
216		* @param Session $session Session object
217		*
218		* @return Messenger
219		*
220		* @access protected
221		*/
222	1	protected function newMessenger(Session $session)
223		{
224	1	return $this->messengerFactory
225	1	->setSession($session)
226	1	->newInstance($this->messengerNamespace);
227		}
228
229		/**
230		* Set messenger as request attribute if attribute preesent
231		*
232		* @param Request $request DESCRIPTION
233		* @param Messenger $messenger DESCRIPTION
234		*
235		* @return Request
236		*
237		* @access protected
238		*/
239	1	protected function setRequestMessenger(Request $request, Messenger $messenger)
240		{
241	1	if ($this->messengerAttribute !== null) {
242	1	$request = $request->withAttribute(
243	1	$this->messengerAttribute,
244		$messenger
245	1	);
246	1	}
247	1	return $request;
248		}
249		}
250

jnjxp / jnjxp.molniya

GitHub Access Token became invalid

Push — master ( bb2ad6...8d3233 )

SessionHandler::newSession() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like