midcom_services_session::get_session_data() - Code Metrics - Inspection of "Remove unused code" - flack/openpsa - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( be6fbd...8a140a )

by Andreas

created 2021-05-24 12:40 UTC

midcom_services_session::get_session_data() A

↳ Parent: Project

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

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

<?php
/**
 * @package midcom.services
 * @author The Midgard Project, http://www.midgard-project.org
 * @copyright The Midgard Project, http://www.midgard-project.org
 * @license http://www.gnu.org/licenses/lgpl.html GNU Lesser General Public License
 */

/**
 * Provides sessioning for components.
 *
 * Use get, set and exists to access the sessioning data within your component.
 *
 * <b>Example:</b>
 *
 * <code>
 * <?php
 * $session = new midcom_services_session();
 * if ($session->exists("mykey")) {
 *     echo "found session value: " . $session->get ("mykey") . ", removing it.";
 *     $value = $session->remove("mykey");
 * } else {
 *     echo "setting session value...";
 *     $session->set("mykey", "hello world");
 * }
 * </code>
 *
 * You should keep in mind, that the isolation level by default is per-component,
 * not per-request. If you, for example, have the same component active twice
 * (through dynamic_load) you have to manually ensure, that each request is
 * treated separately. Unfortunately MidCOM cannot help you here.
 *
 * <b>Implementation Notes:</b>
 *
 * This is a simple wrapper that provides access to the sessioning singleton.
 * It has the same public member functions as midcom_services__sessioning, refer
 * to this class for a detailed documentation.
 *
 * Basically this wrapper ensures the singleton pattern is maintained and provides
 * you with an easy way of lock the domain you're working in.
 *
 * @package midcom.services
 * @see midcom_services__sessioning
 */
class midcom_services_session
{
    /**
     * @var midcom_services__sessioning
     */
    private $_sessioning;

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

    /**
     * Constructs a session object.
     *
     * The default constructor will create a sessioning object within the domain
     * of the current context's component. This will be sufficient for almost all
     * actual uses of the sessions.
     *
     * If passed a string argument, this value is used as a domain. This
     * is useful for components that need sessioning while under dynamic_load
     * conditions or while used as a library.
     */
    public function __construct(string $domain = null)
    {
        $this->_domain = $domain ?? midcom_core_context::get()->get_key(MIDCOM_CONTEXT_COMPONENT);
class Id
{
    public $id;

    public function __construct($id)
    {
        $this->id = $id;
    }

}

class Account
{
    /** @var  Id $id */
    public $id;
}

$account_id = false;

if (starsAreRight()) {
    $account_id = new Id(42);
}

$account = new Account();
if ($account instanceof Id)
{
    $account->id = $account_id;
}

        $this->_sessioning = midcom::get()->session;
    }

    /**
     * Returns a value from the session.
     *
     * Returns null if the key
     * is non-existent. Note, that this is not necessarily a valid non-existence
     * check, as the sessioning system does allow null values. Use the exists function
     * if unsure.
     */
    public function get(string $key)
    {
        return $this->_sessioning->get($this->_domain . '/' . $key);
    }

    /**
     * This will store the value to the specified key.
     *
     * Note, that a _copy_ is stored,
     * the actual object is not referenced in the session data. You will have to update
     * it manually in case of changes.
     */
    public function set(string $key, $value)
    {
        $this->_sessioning->set($this->_domain . '/' . $key, $value);
    }

    /**
     * Checks, if the specified key has been added to the session store.
     *
     * This is often used in conjunction with get to verify a keys existence.
     */
    public function exists(string $key) : bool
    {
        return $this->_sessioning->has($this->_domain . '/' . $key);
    }

    /**
     * Removes the value associated with the specified key. Returns null if the key
     * is non-existent or the value of the key just removed otherwise. Note, that
     * this is not necessarily a valid non-existence check, as the sessioning
     * system does allow null values. Use the exists function if unsure.
     */
    public function remove(string $key)
    {
        return $this->_sessioning->remove($this->_domain . '/' . $key);
    }
}


1		<?php
2		/**
3		* @package midcom.services
4		* @author The Midgard Project, http://www.midgard-project.org
5		* @copyright The Midgard Project, http://www.midgard-project.org
6		* @license http://www.gnu.org/licenses/lgpl.html GNU Lesser General Public License
7		*/
8
9		/**
10		* Provides sessioning for components.
11		*
12		* Use get, set and exists to access the sessioning data within your component.
13		*
14		* <b>Example:</b>
15		*
16		* <code>
17		* <?php
18		* $session = new midcom_services_session();
19		* if ($session->exists("mykey")) {
20		* echo "found session value: " . $session->get ("mykey") . ", removing it.";
21		* $value = $session->remove("mykey");
22		* } else {
23		* echo "setting session value...";
24		* $session->set("mykey", "hello world");
25		* }
26		* </code>
27		*
28		* You should keep in mind, that the isolation level by default is per-component,
29		* not per-request. If you, for example, have the same component active twice
30		* (through dynamic_load) you have to manually ensure, that each request is
31		* treated separately. Unfortunately MidCOM cannot help you here.
32		*
33		* <b>Implementation Notes:</b>
34		*
35		* This is a simple wrapper that provides access to the sessioning singleton.
36		* It has the same public member functions as midcom_services__sessioning, refer
37		* to this class for a detailed documentation.
38		*
39		* Basically this wrapper ensures the singleton pattern is maintained and provides
40		* you with an easy way of lock the domain you're working in.
41		*
42		* @package midcom.services
43		* @see midcom_services__sessioning
44		*/
45		class midcom_services_session
46		{
47		/**
48		* @var midcom_services__sessioning
49		*/
50		private $_sessioning;
51
52		/**
53		* @var string
54		*/
55		private $_domain;
56
57		/**
58		* Constructs a session object.
59		*
60		* The default constructor will create a sessioning object within the domain
61		* of the current context's component. This will be sufficient for almost all
62		* actual uses of the sessions.
63		*
64		* If passed a string argument, this value is used as a domain. This
65		* is useful for components that need sessioning while under dynamic_load
66		* conditions or while used as a library.
67		*/
68	89	public function __construct(string $domain = null)
69		{
70	89	$this->_domain = $domain ?? midcom_core_context::get()->get_key(MIDCOM_CONTEXT_COMPONENT);
		0 ignored issues – show Documentation Bug introduced 2020-09-18 19:09 UTC by Report Bug Copy Issue Report It seems like `$domain ?? midcom_core_c...DCOM_CONTEXT_COMPONENT)` can also be of type `false`. However, the property `$_domain` is declared as type `string`. Maybe add an additional type check? Our type inference engine has found a suspicous assignment of a value to a property. This check raises an issue when a value that can be of a mixed type is assigned to a property that is type hinted more strictly. For example, imagine you have a variable `$accountId` that can either hold an Id object or false (if there is no account id yet). Your code now assigns that value to the `id` property of an instance of the `Account` class. This class holds a proper account, so the id value must no longer be false. Either this assignment is in error or a type check should be added for that assignment. class Id { public $id; public function __construct($id) { $this->id = $id; } } class Account { /** @var Id $id */ public $id; } $account_id = false; if (starsAreRight()) { $account_id = new Id(42); } $account = new Account(); if ($account instanceof Id) { $account->id = $account_id; } Loading history...
71
72	89	$this->_sessioning = midcom::get()->session;
73	89	}
74
75		/**
76		* Returns a value from the session.
77		*
78		* Returns null if the key
79		* is non-existent. Note, that this is not necessarily a valid non-existence
80		* check, as the sessioning system does allow null values. Use the exists function
81		* if unsure.
82		*/
83		public function get(string $key)
84		{
85		return $this->_sessioning->get($this->_domain . '/' . $key);
86		}
87
88		/**
89		* This will store the value to the specified key.
90		*
91		* Note, that a _copy_ is stored,
92		* the actual object is not referenced in the session data. You will have to update
93		* it manually in case of changes.
94		*/
95	65	public function set(string $key, $value)
96		{
97	65	$this->_sessioning->set($this->_domain . '/' . $key, $value);
98	65	}
99
100		/**
101		* Checks, if the specified key has been added to the session store.
102		*
103		* This is often used in conjunction with get to verify a keys existence.
104		*/
105	31	public function exists(string $key) : bool
106		{
107	31	return $this->_sessioning->has($this->_domain . '/' . $key);
108		}
109
110		/**
111		* Removes the value associated with the specified key. Returns null if the key
112		* is non-existent or the value of the key just removed otherwise. Note, that
113		* this is not necessarily a valid non-existence check, as the sessioning
114		* system does allow null values. Use the exists function if unsure.
115		*/
116		public function remove(string $key)
117		{
118		return $this->_sessioning->remove($this->_domain . '/' . $key);
119		}
120		}
121

flack / openpsa

Push — master ( be6fbd...8a140a )

midcom_services_session::get_session_data() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like