SessionConfigNode::toArray() - Code Metrics - appserver-io/appserver - Measure and Improve Code Quality continuously with Scrutinizer

SessionConfigNode::toArray() F
last analyzed 2020-01-15 18:03 UTC

↳ Parent: SessionConfigNode

Complexity

Conditions	12
Paths	2048

Size

Total Lines	43
Code Lines	24

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	156

Importance

Changes

Metric	Value
cc	12
eloc	24
nc	2048
nop	0
dl	0
loc	43
ccs	0
cts	37
cp	0
crap	156
rs	2.8
c	0
b	0
f	0

How to fix Complexity

<?php

/**
 * \AppserverIo\Appserver\Core\Api\Node\SessionConfigNode
 *
 * NOTICE OF LICENSE
 *
 * This source file is subject to the Open Software License (OSL 3.0)
 * that is available through the world-wide-web at this URL:
 * http://opensource.org/licenses/osl-3.0.php
 *
 * PHP version 5
 *
 * @author    Tim Wagner <[email protected]>
 * @copyright 2015 TechDivision GmbH <[email protected]>
 * @license   http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
 * @link      https://github.com/appserver-io/appserver
 * @link      http://www.appserver.io
 */

namespace AppserverIo\Appserver\Core\Api\Node;

use AppserverIo\Description\Annotations as DI;
use AppserverIo\Description\Api\Node\AbstractNode;
use AppserverIo\Psr\Servlet\ServletSessionInterface;

/**
 * DTO to transfer a session configuration.
 *
 * @author    Tim Wagner <[email protected]>
 * @copyright 2015 TechDivision GmbH <[email protected]>
 * @license   http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
 * @link      https://github.com/appserver-io/appserver
 * @link      http://www.appserver.io
 */
class SessionConfigNode extends AbstractNode implements SessionConfigNodeInterface
{

    /**
     * The session name information.
     *
     * @var \AppserverIo\Appserver\Core\Api\Node\SessionNameNode
     * @DI\Mapping(nodeName="session-name", nodeType="AppserverIo\Appserver\Core\Api\Node\SessionNameNode")
     */
    protected $sessionName;

    /**
     * The session file prefix information.
     *
     * @var \AppserverIo\Appserver\Core\Api\Node\SessionFilePrefixNode
     * @DI\Mapping(nodeName="session-file-prefix", nodeType="AppserverIo\Appserver\Core\Api\Node\SessionFilePrefixNode")
     */
    protected $sessionFilePrefix;

    /**
     * The session save path information.
     *
     * @var \AppserverIo\Appserver\Core\Api\Node\SessionSavePathNode
     * @DI\Mapping(nodeName="session-save-path", nodeType="AppserverIo\Appserver\Core\Api\Node\SessionSavePathNode")
     */
    protected $sessionSavePath;

    /**
     * The garbage collection probability information.
     *
     * @var \AppserverIo\Appserver\Core\Api\Node\GarbageCollectionProbabilityNode
     * @DI\Mapping(nodeName="garbage-collection-probability", nodeType="AppserverIo\Appserver\Core\Api\Node\GarbageCollectionProbabilityNode")
     */
    protected $garbageCollectionProbability;

    /**
     * The session maximum age information.
     *
     * @var \AppserverIo\Appserver\Core\Api\Node\SessionMaximumAgeNode
     * @DI\Mapping(nodeName="session-maximum-age", nodeType="AppserverIo\Appserver\Core\Api\Node\SessionMaximumAgeNode")
     */
    protected $sessionMaximumAge;

    /**
     * The session inactivity timeout information.
     *
     * @var \AppserverIo\Appserver\Core\Api\Node\SessionInactivityTimeoutNode
     * @DI\Mapping(nodeName="session-inactivity-timeout", nodeType="AppserverIo\Appserver\Core\Api\Node\SessionInactivityTimeoutNode")
     */
    protected $sessionInactivityTimeout;

    /**
     * The session cookie lifetime information.
     *
     * @var \AppserverIo\Appserver\Core\Api\Node\SessionCookieLifetimeNode
     * @DI\Mapping(nodeName="session-cookie-lifetime", nodeType="AppserverIo\Appserver\Core\Api\Node\SessionCookieLifetimeNode")
     */
    protected $sessionCookieLifetime;

    /**
     * The session cookie domain information.
     *
     * @var \AppserverIo\Appserver\Core\Api\Node\SessionCookieDomainNode
     * @DI\Mapping(nodeName="session-cookie-domain", nodeType="AppserverIo\Appserver\Core\Api\Node\SessionCookieDomainNode")
     */
    protected $sessionCookieDomain;

    /**
     * The session cookie path information.
     *
     * @var \AppserverIo\Appserver\Core\Api\Node\SessionCookiePathNode
     * @DI\Mapping(nodeName="session-cookie-path", nodeType="AppserverIo\Appserver\Core\Api\Node\SessionCookiePathNode")
     */
    protected $sessionCookiePath;

    /**
     * The session cookie secure information.
     *
     * @var \AppserverIo\Appserver\Core\Api\Node\SessionCookieSecureNode
     * @DI\Mapping(nodeName="session-cookie-secure", nodeType="AppserverIo\Appserver\Core\Api\Node\SessionCookieSecureNode")
     */
    protected $sessionCookieSecure;

    /**
     * The session HTTP only information.
     *
     * @var \AppserverIo\Appserver\Core\Api\Node\SessionCookieHttpOnlyNode
     * @DI\Mapping(nodeName="session-cookie-http-only", nodeType="AppserverIo\Appserver\Core\Api\Node\SessionCookieHttpOnlyNode")
     */
    protected $sessionCookieHttpOnly;

    /**
     * Return's the session name information.
     *
     * @return \AppserverIo\Appserver\Core\Api\Node\SessionNameNode The session name information
     */
    public function getSessionName()
    {
        return $this->sessionName;
    }

    /**
     * Return's the session file prefix information.
     *
     * @return \AppserverIo\Appserver\Core\Api\Node\SessionFilePrefixNode The session file prefix information
     */
    public function getSessionFilePrefix()
    {
        return $this->sessionFilePrefix;
    }

    /**
     * Return's the session save path information.
     *
     * @return \AppserverIo\Appserver\Core\Api\Node\SessionSavePathNode The session save path information
     */
    public function getSessionSavePath()
    {
        return $this->sessionSavePath;
    }

    /**
     * Return's the garbage collection probability information.
     *
     * @return \AppserverIo\Appserver\Core\Api\Node\GarbageCollectionProbabilityNode The garbage collection probability information
     */
    public function getGarbageCollectionProbability()
    {
        return $this->garbageCollectionProbability;
    }

    /**
     * Return's the session maixmum age information.
     *
     * @return \AppserverIo\Appserver\Core\Api\Node\SessionMaximumAgeNode The session maximum age information
     */
    public function getSessionMaximumAge()
    {
        return $this->sessionMaximumAge;
    }

    /**
     * Return's the session inactivity timeout information.
     *
     * @return \AppserverIo\Appserver\Core\Api\Node\SessionInactivityTimeoutNode The session inativity timeout information
     */
    public function getSessionInactivityTimeout()
    {
        return $this->sessionInactivityTimeout;
    }

    /**
     * Return's the session cookie lifetime information.
     *
     * @return \AppserverIo\Appserver\Core\Api\Node\SessionCookieLifetimeNode The session cookie lifetime information
     */
    public function getSessionCookieLifetime()
    {
        return $this->sessionCookieLifetime;
    }

    /**
     * Return's the session cookie domain information.
     *
     * @return \AppserverIo\Appserver\Core\Api\Node\SessionCookieDomainNode The session cookie domain information
     */
    public function getSessionCookieDomain()
    {
        return $this->sessionCookieDomain;
    }

    /**
     * Return's the session cookie path information.
     *
     * @return \AppserverIo\Appserver\Core\Api\Node\SessionCookiePathNode The session cookie path information
     */
    public function getSessionCookiePath()
    {
        return $this->sessionCookiePath;
    }

    /**
     * Return's the session cookie secure information.
     *
     * @return \AppserverIo\Appserver\Core\Api\Node\SessionCookieSecureNode The session cookie secure information
     */
    public function getSessionCookieSecure()
    {
        return $this->sessionCookieSecure;
    }

    /**
     * Return's the session cookie HTTP only information.
     *
     * @return \AppserverIo\Appserver\Core\Api\Node\SessionCookieHttpOnlyNode The session cookie HTTP only information
     */
    public function getSessionCookieHttpOnly()
    {
        return $this->sessionHttpOnly;

    }

    /**
     * Returns the session configuration as associative array.
     *
     * @return array The array with the session configuration
     */
    public function toArray()
    {

        // initialize the array with the session configuration
        $sessionConfiguration = array();

        // query whether or not a value has been available in the deployment descriptor
        if ($sessionName = $this->getSessionName()) {
            $sessionConfiguration[ServletSessionInterface::SESSION_NAME] = (string) $sessionName;
        }
        if ($sessionSavePath = $this->getSessionSavePath()) {
            $sessionConfiguration[ServletSessionInterface::SESSION_SAVE_PATH] = (string) $sessionSavePath;
        }
        if ($sessionMaximumAge = $this->getSessionMaximumAge()) {
            $sessionConfiguration[ServletSessionInterface::SESSION_MAXIMUM_AGE] = (string) $sessionMaximumAge;
        }
        if ($sessionInactivityTimeout = $this->getSessionInactivityTimeout()) {
            $sessionConfiguration[ServletSessionInterface::SESSION_INACTIVITY_TIMEOUT] = (string) $sessionInactivityTimeout;
        }
        if ($sessionFilePrefix = $this->getSessionFilePrefix()) {
            $sessionConfiguration[ServletSessionInterface::SESSION_FILE_PREFIX] = (string) $sessionFilePrefix;
        }
        if ($sessionCookieSecure = $this->getSessionCookieSecure()) {
            $sessionConfiguration[ServletSessionInterface::SESSION_COOKIE_SECURE] = (string) $sessionCookieSecure;
        }
        if ($sessionCookiePath = $this->getSessionCookiePath()) {
            $sessionConfiguration[ServletSessionInterface::SESSION_COOKIE_PATH] = (string) $sessionCookiePath;
        }
        if ($sessionCookieLifetime = $this->getSessionCookieLifetime()) {
            $sessionConfiguration[ServletSessionInterface::SESSION_COOKIE_LIFETIME] = (string) $sessionCookieLifetime;
        }
        if ($sessionCookieHttpOnly = $this->getSessionCookieHttpOnly()) {
            $sessionConfiguration[ServletSessionInterface::SESSION_COOKIE_HTTP_ONLY] = (string) $sessionCookieHttpOnly;
        }
        if ($sessionCookieDomain = $this->getSessionCookieDomain()) {
            $sessionConfiguration[ServletSessionInterface::SESSION_COOKIE_DOMAIN] = (string) $sessionCookieDomain;
        }
        if ($garbageCollectionProbability = $this->getGarbageCollectionProbability()) {
            $sessionConfiguration[ServletSessionInterface::GARBAGE_COLLECTION_PROBABILITY] = (string) $garbageCollectionProbability;
        }

        // return the array with the session configuration
        return $sessionConfiguration;
    }
}


1			<?php
2
3			/**
4			* \AppserverIo\Appserver\Core\Api\Node\SessionConfigNode
5			*
6			* NOTICE OF LICENSE
7			*
8			* This source file is subject to the Open Software License (OSL 3.0)
9			* that is available through the world-wide-web at this URL:
10			* http://opensource.org/licenses/osl-3.0.php
11			*
12			* PHP version 5
13			*
14			* @author Tim Wagner <[email protected]>
15			* @copyright 2015 TechDivision GmbH <[email protected]>
16			* @license http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
17			* @link https://github.com/appserver-io/appserver
18			* @link http://www.appserver.io
19			*/
20
21			namespace AppserverIo\Appserver\Core\Api\Node;
22
23			use AppserverIo\Description\Annotations as DI;
24			use AppserverIo\Description\Api\Node\AbstractNode;
25			use AppserverIo\Psr\Servlet\ServletSessionInterface;
26
27			/**
28			* DTO to transfer a session configuration.
29			*
30			* @author Tim Wagner <[email protected]>
31			* @copyright 2015 TechDivision GmbH <[email protected]>
32			* @license http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
33			* @link https://github.com/appserver-io/appserver
34			* @link http://www.appserver.io
35			*/
36			class SessionConfigNode extends AbstractNode implements SessionConfigNodeInterface
37			{
38
39			/**
40			* The session name information.
41			*
42			* @var \AppserverIo\Appserver\Core\Api\Node\SessionNameNode
43			* @DI\Mapping(nodeName="session-name", nodeType="AppserverIo\Appserver\Core\Api\Node\SessionNameNode")
44			*/
45			protected $sessionName;
46
47			/**
48			* The session file prefix information.
49			*
50			* @var \AppserverIo\Appserver\Core\Api\Node\SessionFilePrefixNode
51			* @DI\Mapping(nodeName="session-file-prefix", nodeType="AppserverIo\Appserver\Core\Api\Node\SessionFilePrefixNode")
52			*/
53			protected $sessionFilePrefix;
54
55			/**
56			* The session save path information.
57			*
58			* @var \AppserverIo\Appserver\Core\Api\Node\SessionSavePathNode
59			* @DI\Mapping(nodeName="session-save-path", nodeType="AppserverIo\Appserver\Core\Api\Node\SessionSavePathNode")
60			*/
61			protected $sessionSavePath;
62
63			/**
64			* The garbage collection probability information.
65			*
66			* @var \AppserverIo\Appserver\Core\Api\Node\GarbageCollectionProbabilityNode
67			* @DI\Mapping(nodeName="garbage-collection-probability", nodeType="AppserverIo\Appserver\Core\Api\Node\GarbageCollectionProbabilityNode")
68			*/
69			protected $garbageCollectionProbability;
70
71			/**
72			* The session maximum age information.
73			*
74			* @var \AppserverIo\Appserver\Core\Api\Node\SessionMaximumAgeNode
75			* @DI\Mapping(nodeName="session-maximum-age", nodeType="AppserverIo\Appserver\Core\Api\Node\SessionMaximumAgeNode")
76			*/
77			protected $sessionMaximumAge;
78
79			/**
80			* The session inactivity timeout information.
81			*
82			* @var \AppserverIo\Appserver\Core\Api\Node\SessionInactivityTimeoutNode
83			* @DI\Mapping(nodeName="session-inactivity-timeout", nodeType="AppserverIo\Appserver\Core\Api\Node\SessionInactivityTimeoutNode")
84			*/
85			protected $sessionInactivityTimeout;
86
87			/**
88			* The session cookie lifetime information.
89			*
90			* @var \AppserverIo\Appserver\Core\Api\Node\SessionCookieLifetimeNode
91			* @DI\Mapping(nodeName="session-cookie-lifetime", nodeType="AppserverIo\Appserver\Core\Api\Node\SessionCookieLifetimeNode")
92			*/
93			protected $sessionCookieLifetime;
94
95			/**
96			* The session cookie domain information.
97			*
98			* @var \AppserverIo\Appserver\Core\Api\Node\SessionCookieDomainNode
99			* @DI\Mapping(nodeName="session-cookie-domain", nodeType="AppserverIo\Appserver\Core\Api\Node\SessionCookieDomainNode")
100			*/
101			protected $sessionCookieDomain;
102
103			/**
104			* The session cookie path information.
105			*
106			* @var \AppserverIo\Appserver\Core\Api\Node\SessionCookiePathNode
107			* @DI\Mapping(nodeName="session-cookie-path", nodeType="AppserverIo\Appserver\Core\Api\Node\SessionCookiePathNode")
108			*/
109			protected $sessionCookiePath;
110
111			/**
112			* The session cookie secure information.
113			*
114			* @var \AppserverIo\Appserver\Core\Api\Node\SessionCookieSecureNode
115			* @DI\Mapping(nodeName="session-cookie-secure", nodeType="AppserverIo\Appserver\Core\Api\Node\SessionCookieSecureNode")
116			*/
117			protected $sessionCookieSecure;
118
119			/**
120			* The session HTTP only information.
121			*
122			* @var \AppserverIo\Appserver\Core\Api\Node\SessionCookieHttpOnlyNode
123			* @DI\Mapping(nodeName="session-cookie-http-only", nodeType="AppserverIo\Appserver\Core\Api\Node\SessionCookieHttpOnlyNode")
124			*/
125			protected $sessionCookieHttpOnly;
126
127			/**
128			* Return's the session name information.
129			*
130			* @return \AppserverIo\Appserver\Core\Api\Node\SessionNameNode The session name information
131			*/
132			public function getSessionName()
133			{
134			return $this->sessionName;
135			}
136
137			/**
138			* Return's the session file prefix information.
139			*
140			* @return \AppserverIo\Appserver\Core\Api\Node\SessionFilePrefixNode The session file prefix information
141			*/
142			public function getSessionFilePrefix()
143			{
144			return $this->sessionFilePrefix;
145			}
146
147			/**
148			* Return's the session save path information.
149			*
150			* @return \AppserverIo\Appserver\Core\Api\Node\SessionSavePathNode The session save path information
151			*/
152			public function getSessionSavePath()
153			{
154			return $this->sessionSavePath;
155			}
156
157			/**
158			* Return's the garbage collection probability information.
159			*
160			* @return \AppserverIo\Appserver\Core\Api\Node\GarbageCollectionProbabilityNode The garbage collection probability information
161			*/
162			public function getGarbageCollectionProbability()
163			{
164			return $this->garbageCollectionProbability;
165			}
166
167			/**
168			* Return's the session maixmum age information.
169			*
170			* @return \AppserverIo\Appserver\Core\Api\Node\SessionMaximumAgeNode The session maximum age information
171			*/
172			public function getSessionMaximumAge()
173			{
174			return $this->sessionMaximumAge;
175			}
176
177			/**
178			* Return's the session inactivity timeout information.
179			*
180			* @return \AppserverIo\Appserver\Core\Api\Node\SessionInactivityTimeoutNode The session inativity timeout information
181			*/
182			public function getSessionInactivityTimeout()
183			{
184			return $this->sessionInactivityTimeout;
185			}
186
187			/**
188			* Return's the session cookie lifetime information.
189			*
190			* @return \AppserverIo\Appserver\Core\Api\Node\SessionCookieLifetimeNode The session cookie lifetime information
191			*/
192			public function getSessionCookieLifetime()
193			{
194			return $this->sessionCookieLifetime;
195			}
196
197			/**
198			* Return's the session cookie domain information.
199			*
200			* @return \AppserverIo\Appserver\Core\Api\Node\SessionCookieDomainNode The session cookie domain information
201			*/
202			public function getSessionCookieDomain()
203			{
204			return $this->sessionCookieDomain;
205			}
206
207			/**
208			* Return's the session cookie path information.
209			*
210			* @return \AppserverIo\Appserver\Core\Api\Node\SessionCookiePathNode The session cookie path information
211			*/
212			public function getSessionCookiePath()
213			{
214			return $this->sessionCookiePath;
215			}
216
217			/**
218			* Return's the session cookie secure information.
219			*
220			* @return \AppserverIo\Appserver\Core\Api\Node\SessionCookieSecureNode The session cookie secure information
221			*/
222			public function getSessionCookieSecure()
223			{
224			return $this->sessionCookieSecure;
225			}
226
227			/**
228			* Return's the session cookie HTTP only information.
229			*
230			* @return \AppserverIo\Appserver\Core\Api\Node\SessionCookieHttpOnlyNode The session cookie HTTP only information
231			*/
232			public function getSessionCookieHttpOnly()
233			{
234			return $this->sessionHttpOnly;
			0 ignored issues – show Bug introduced 2018-08-04 09:40 UTC by Report Bug Copy Issue Report The property `sessionHttpOnly` does not exist on `AppserverIo\Appserver\Co...\Node\SessionConfigNode`. Did you mean `sessionCookieHttpOnly`? Loading history...
235			}
236
237			/**
238			* Returns the session configuration as associative array.
239			*
240			* @return array The array with the session configuration
241			*/
242			public function toArray()
243			{
244
245			// initialize the array with the session configuration
246			$sessionConfiguration = array();
247
248			// query whether or not a value has been available in the deployment descriptor
249			if ($sessionName = $this->getSessionName()) {
250			$sessionConfiguration[ServletSessionInterface::SESSION_NAME] = (string) $sessionName;
251			}
252			if ($sessionSavePath = $this->getSessionSavePath()) {
253			$sessionConfiguration[ServletSessionInterface::SESSION_SAVE_PATH] = (string) $sessionSavePath;
254			}
255			if ($sessionMaximumAge = $this->getSessionMaximumAge()) {
256			$sessionConfiguration[ServletSessionInterface::SESSION_MAXIMUM_AGE] = (string) $sessionMaximumAge;
257			}
258			if ($sessionInactivityTimeout = $this->getSessionInactivityTimeout()) {
259			$sessionConfiguration[ServletSessionInterface::SESSION_INACTIVITY_TIMEOUT] = (string) $sessionInactivityTimeout;
260			}
261			if ($sessionFilePrefix = $this->getSessionFilePrefix()) {
262			$sessionConfiguration[ServletSessionInterface::SESSION_FILE_PREFIX] = (string) $sessionFilePrefix;
263			}
264			if ($sessionCookieSecure = $this->getSessionCookieSecure()) {
265			$sessionConfiguration[ServletSessionInterface::SESSION_COOKIE_SECURE] = (string) $sessionCookieSecure;
266			}
267			if ($sessionCookiePath = $this->getSessionCookiePath()) {
268			$sessionConfiguration[ServletSessionInterface::SESSION_COOKIE_PATH] = (string) $sessionCookiePath;
269			}
270			if ($sessionCookieLifetime = $this->getSessionCookieLifetime()) {
271			$sessionConfiguration[ServletSessionInterface::SESSION_COOKIE_LIFETIME] = (string) $sessionCookieLifetime;
272			}
273			if ($sessionCookieHttpOnly = $this->getSessionCookieHttpOnly()) {
274			$sessionConfiguration[ServletSessionInterface::SESSION_COOKIE_HTTP_ONLY] = (string) $sessionCookieHttpOnly;
275			}
276			if ($sessionCookieDomain = $this->getSessionCookieDomain()) {
277			$sessionConfiguration[ServletSessionInterface::SESSION_COOKIE_DOMAIN] = (string) $sessionCookieDomain;
278			}
279			if ($garbageCollectionProbability = $this->getGarbageCollectionProbability()) {
280			$sessionConfiguration[ServletSessionInterface::GARBAGE_COLLECTION_PROBABILITY] = (string) $garbageCollectionProbability;
281			}
282
283			// return the array with the session configuration
284			return $sessionConfiguration;
285			}
286			}
287

appserver-io / appserver

SessionConfigNode::toArray() F last analyzed 2020-01-15 18:03 UTC

Complexity

Size

Duplication

Code Coverage

Importance

How to fix Complexity

Long Method

Duplication Side-by-Side

Filter issues like

SessionConfigNode::toArray() F
last analyzed 2020-01-15 18:03 UTC