User::setAuthConfirmed() - Code Metrics - skaut/Skautis - Measure and Improve Code Quality continuously with Scrutinizer

User::setAuthConfirmed() A
last analyzed 2019-09-12 12:31 UTC

↳ Parent: User

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	4
CRAP Score	1

Importance

Changes

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

<?php

namespace Skautis;

use Skautis\SessionAdapter\AdapterInterface;
use Skautis\Wsdl\WsdlManager;

/**
 * @author Petr Morávek <[email protected]>
 */
class User
{

    const ID_LOGIN = "ID_Login";
    const ID_ROLE = "ID_Role";
    const ID_UNIT = "ID_Unit";
    const LOGOUT_DATE = "LOGOUT_Date";
    const AUTH_CONFIRMED = "AUTH_Confirmed";
    const SESSION_ID = "skautis_user_data";

    /**
     * @var WsdlManager
     */
    private $wsdlManager;

    /**
     * @var AdapterInterface
     */
    private $session;

    /**
     * Informace o přihlášení uživatele
     *
     * @var array
     */
    protected $loginData = [];


    /**
     * @param WsdlManager $wsdlManager
     * @param AdapterInterface|null $session
     */
    public function __construct(WsdlManager $wsdlManager, AdapterInterface $session = null)
    {
        $this->wsdlManager = $wsdlManager;
        $this->session = $session;

        if ($session !== null && $session->has(self::SESSION_ID)) {
            $this->loginData = (array)$session->get(self::SESSION_ID);
        }
    }

    /**
     * @return string|null
     */
    public function getLoginId()
    {
        return isset($this->loginData[self::ID_LOGIN]) ? $this->loginData[self::ID_LOGIN] : null;
    }

    /**
     * @return int|null
     */
    public function getRoleId()
    {
        return isset($this->loginData[self::ID_ROLE]) ? $this->loginData[self::ID_ROLE] : null;
    }

    /**
     * @return int|null
     */
    public function getUnitId()
    {
        return isset($this->loginData[self::ID_UNIT]) ? $this->loginData[self::ID_UNIT] : null;
    }

    /**
     * Vrací datum a čas automatického odhlášení ze skautISu
     *
     * @return \DateTime
     */
    public function getLogoutDate()
    {
        return isset($this->loginData[self::LOGOUT_DATE]) ? $this->loginData[self::LOGOUT_DATE] : null;
    }

    /**
     * Hromadné nastavení po přihlášení
     *
     * @param string|null $loginId
     * @param int|null $roleId
     * @param int|null $unitId
     * @param \DateTime|null $logoutDate
     * @return self
     */
    public function setLoginData($loginId = null, $roleId = null, $unitId = null, \DateTime $logoutDate = null)
    {
        $this->loginData = [];

        return $this->updateLoginData($loginId, $roleId, $unitId, $logoutDate);
    }
    
    /**
     * Hromadná změna údajů, bez vymazání stávajících
     *
     * @param string|null $loginId
     * @param int|null $roleId
     * @param int|null $unitId
     * @param \DateTime|null $logoutDate
     * @return self
     */
    public function updateLoginData($loginId = null, $roleId = null, $unitId = null, \DateTime $logoutDate = null)
    {
        if ($loginId !== null) {
            $this->loginData[self::ID_LOGIN] = $loginId;
        }

        if ($roleId !== null) {
            $this->loginData[self::ID_ROLE] = (int) $roleId;
        }

        if ($unitId !== null) {
            $this->loginData[self::ID_UNIT] = (int) $unitId;
        }

        if ($logoutDate !== null) {
            $this->loginData[self::LOGOUT_DATE] = $logoutDate;
        }

        $this->saveToSession();

        return $this;
    }

    /**
     * Hromadný reset dat po odhlášení
     *
     * @return self
     */
    public function resetLoginData()
    {
        return $this->setLoginData();
    }

    /**
     * Kontoluje, jestli je přihlášení platné.
     * Pro správné fungování je nezbytně nutné, aby byl na serveru nastaven správný čas.
     *
     * @param bool $hardCheck vynutí kontrolu přihlášení na serveru
     * @return bool
     */
    public function isLoggedIn($hardCheck = false)
    {
        if (empty($this->loginData[self::ID_LOGIN])) {
            return false;
        }

        if ($hardCheck || !$this->isAuthConfirmed()) {
            $this->confirmAuth();
        }

        return $this->isAuthConfirmed() && $this->getLogoutDate()->getTimestamp() > time();
    }

    /**
     * Bylo potvrzeno přihlášení dotazem na skautIS?
     *
     * @return bool
     */
    protected function isAuthConfirmed()
    {
        return !empty($this->loginData[self::AUTH_CONFIRMED]);
    }

    /**
     * @param bool $isConfirmed
     */
    protected function setAuthConfirmed($isConfirmed)
    {
        $this->loginData[self::AUTH_CONFIRMED] = (bool) $isConfirmed;
        $this->saveToSession();
    }

    /**
     * Potvrdí (a prodlouží) přihlášení dotazem na skautIS.
     */
    protected function confirmAuth()
    {
        try {
            $this->updateLogoutTime();
            $this->setAuthConfirmed(true);
        } catch (\Exception $e) {
            $this->setAuthConfirmed(false);
        }
    }

    /**
     * Prodloužení přihlášení o 30 min
     *
     * @return self
     * @throws UnexpectedValueException pokud se nepodaří naparsovat datum
     */
    public function updateLogoutTime()
    {
        $loginId = $this->getLoginId();
        if ($loginId === null) {
            // Nemáme token, uživatel není přihlášen a není, co prodlužovat
            return $this;
        }

        $result = $this->wsdlManager->getWebService('UserManagement', $loginId)->LoginUpdateRefresh(["ID" => $loginId]);

        $logoutDate = preg_replace('/\.(\d*)$/', '', $result->DateLogout); //skautIS vrací sekundy včetně desetinné části
        $tz = new \DateTimeZone('Europe/Prague');
        $logoutDate = \DateTime::createFromFormat('Y-m-d\TH:i:s', $logoutDate, $tz);
        if ($logoutDate === false) {
            throw new UnexpectedValueException("Could not parse logout date '{$result->DateLogout}'.");
        }
        $this->loginData[self::LOGOUT_DATE] = $logoutDate;

        $this->saveToSession();

        return $this;
    }

    /**
     * Uloží nastavení do session
     *
     * @return void
     */
    protected function saveToSession()
    {
        if ($this->session !== null) {
            $this->session->set(self::SESSION_ID, $this->loginData);
        }
    }
}


1		<?php
2
3		namespace Skautis;
4
5		use Skautis\SessionAdapter\AdapterInterface;
6		use Skautis\Wsdl\WsdlManager;
7
8		/**
9		* @author Petr Morávek <[email protected]>
10		*/
11		class User
12		{
13
14		const ID_LOGIN = "ID_Login";
15		const ID_ROLE = "ID_Role";
16		const ID_UNIT = "ID_Unit";
17		const LOGOUT_DATE = "LOGOUT_Date";
18		const AUTH_CONFIRMED = "AUTH_Confirmed";
19		const SESSION_ID = "skautis_user_data";
20
21		/**
22		* @var WsdlManager
23		*/
24		private $wsdlManager;
25
26		/**
27		* @var AdapterInterface
28		*/
29		private $session;
30
31		/**
32		* Informace o přihlášení uživatele
33		*
34		* @var array
35		*/
36		protected $loginData = [];
37
38
39		/**
40		* @param WsdlManager $wsdlManager
41		* @param AdapterInterface\|null $session
42		*/
43	4	public function __construct(WsdlManager $wsdlManager, AdapterInterface $session = null)
44		{
45	4	$this->wsdlManager = $wsdlManager;
46	4	$this->session = $session;
47
48	4	if ($session !== null && $session->has(self::SESSION_ID)) {
49		$this->loginData = (array)$session->get(self::SESSION_ID);
50		}
51	4	}
52
53		/**
54		* @return string\|null
55		*/
56	3	public function getLoginId()
57		{
58	3	return isset($this->loginData[self::ID_LOGIN]) ? $this->loginData[self::ID_LOGIN] : null;
59		}
60
61		/**
62		* @return int\|null
63		*/
64	2	public function getRoleId()
65		{
66	2	return isset($this->loginData[self::ID_ROLE]) ? $this->loginData[self::ID_ROLE] : null;
67		}
68
69		/**
70		* @return int\|null
71		*/
72	2	public function getUnitId()
73		{
74	2	return isset($this->loginData[self::ID_UNIT]) ? $this->loginData[self::ID_UNIT] : null;
75		}
76
77		/**
78		* Vrací datum a čas automatického odhlášení ze skautISu
79		*
80		* @return \DateTime
81		*/
82	3	public function getLogoutDate()
83		{
84	3	return isset($this->loginData[self::LOGOUT_DATE]) ? $this->loginData[self::LOGOUT_DATE] : null;
85		}
86
87		/**
88		* Hromadné nastavení po přihlášení
89		*
90		* @param string\|null $loginId
91		* @param int\|null $roleId
92		* @param int\|null $unitId
93		* @param \DateTime\|null $logoutDate
94		* @return self
95		*/
96	3	public function setLoginData($loginId = null, $roleId = null, $unitId = null, \DateTime $logoutDate = null)
97		{
98	3	$this->loginData = [];
99
100	3	return $this->updateLoginData($loginId, $roleId, $unitId, $logoutDate);
101		}
102
103		/**
104		* Hromadná změna údajů, bez vymazání stávajících
105		*
106		* @param string\|null $loginId
107		* @param int\|null $roleId
108		* @param int\|null $unitId
109		* @param \DateTime\|null $logoutDate
110		* @return self
111		*/
112	3	public function updateLoginData($loginId = null, $roleId = null, $unitId = null, \DateTime $logoutDate = null)
113		{
114	3	if ($loginId !== null) {
115	3	$this->loginData[self::ID_LOGIN] = $loginId;
116	3	}
117
118	3	if ($roleId !== null) {
119	3	$this->loginData[self::ID_ROLE] = (int) $roleId;
120	3	}
121
122	3	if ($unitId !== null) {
123	3	$this->loginData[self::ID_UNIT] = (int) $unitId;
124	3	}
125
126	3	if ($logoutDate !== null) {
127	3	$this->loginData[self::LOGOUT_DATE] = $logoutDate;
128	3	}
129
130	3	$this->saveToSession();
131
132	3	return $this;
133		}
134
135		/**
136		* Hromadný reset dat po odhlášení
137		*
138		* @return self
139		*/
140	1	public function resetLoginData()
141		{
142	1	return $this->setLoginData();
143		}
144
145		/**
146		* Kontoluje, jestli je přihlášení platné.
147		* Pro správné fungování je nezbytně nutné, aby byl na serveru nastaven správný čas.
148		*
149		* @param bool $hardCheck vynutí kontrolu přihlášení na serveru
150		* @return bool
151		*/
152	2	public function isLoggedIn($hardCheck = false)
153		{
154	2	if (empty($this->loginData[self::ID_LOGIN])) {
155	1	return false;
156		}
157
158	1	if ($hardCheck \|\| !$this->isAuthConfirmed()) {
159	1	$this->confirmAuth();
160	1	}
161
162	1	return $this->isAuthConfirmed() && $this->getLogoutDate()->getTimestamp() > time();
163		}
164
165		/**
166		* Bylo potvrzeno přihlášení dotazem na skautIS?
167		*
168		* @return bool
169		*/
170	1	protected function isAuthConfirmed()
171		{
172	1	return !empty($this->loginData[self::AUTH_CONFIRMED]);
173		}
174
175		/**
176		* @param bool $isConfirmed
177		*/
178	1	protected function setAuthConfirmed($isConfirmed)
179		{
180	1	$this->loginData[self::AUTH_CONFIRMED] = (bool) $isConfirmed;
181	1	$this->saveToSession();
182	1	}
183
184		/**
185		* Potvrdí (a prodlouží) přihlášení dotazem na skautIS.
186		*/
187	1	protected function confirmAuth()
188		{
189		try {
190	1	$this->updateLogoutTime();
191	1	$this->setAuthConfirmed(true);
192	1	} catch (\Exception $e) {
193		$this->setAuthConfirmed(false);
194		}
195	1	}
196
197		/**
198		* Prodloužení přihlášení o 30 min
199		*
200		* @return self
201		* @throws UnexpectedValueException pokud se nepodaří naparsovat datum
202		*/
203	1	public function updateLogoutTime()
204		{
205	1	$loginId = $this->getLoginId();
206	1	if ($loginId === null) {
207		// Nemáme token, uživatel není přihlášen a není, co prodlužovat
208		return $this;
209		}
210
211	1	$result = $this->wsdlManager->getWebService('UserManagement', $loginId)->LoginUpdateRefresh(["ID" => $loginId]);
212
213	1	$logoutDate = preg_replace('/\.(\d*)$/', '', $result->DateLogout); //skautIS vrací sekundy včetně desetinné části
214	1	$tz = new \DateTimeZone('Europe/Prague');
215	1	$logoutDate = \DateTime::createFromFormat('Y-m-d\TH:i:s', $logoutDate, $tz);
216	1	if ($logoutDate === false) {
217		throw new UnexpectedValueException("Could not parse logout date '{$result->DateLogout}'.");
218		}
219	1	$this->loginData[self::LOGOUT_DATE] = $logoutDate;
220
221	1	$this->saveToSession();
222
223	1	return $this;
224		}
225
226		/**
227		* Uloží nastavení do session
228		*
229		* @return void
230		*/
231	3	protected function saveToSession()
232		{
233	3	if ($this->session !== null) {
234		$this->session->set(self::SESSION_ID, $this->loginData);
235		}
236	3	}
237		}
238

skaut / Skautis

GitHub Access Token became invalid

User::setAuthConfirmed() A last analyzed 2019-09-12 12:31 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

User::setAuthConfirmed() A
last analyzed 2019-09-12 12:31 UTC