Skautis::getDebugLog() - Code Metrics - Inspection of "Merge pull request #96 from JindrichPilar/PSR-14" - skaut/Skautis - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — 3.x ( 48a2e9...c23789 )

by Jindřich

created 2020-06-21 08:33 UTC

Skautis::getDebugLog() A

↳ Parent: Project

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

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

<?php
declare(strict_types = 1);

namespace Skaut\Skautis;

use Skaut\Skautis\Wsdl\WebServiceAlias;
use Skaut\Skautis\Wsdl\WebServiceAliasNotFoundException;
use Skaut\Skautis\Wsdl\WebServiceInterface;
use Skaut\Skautis\Wsdl\WebServiceName;
use Skaut\Skautis\Wsdl\WebServiceNotFoundException;
use Skaut\Skautis\Wsdl\WsdlException;
use Skaut\Skautis\Wsdl\WsdlManager;

/**
 * Třída pro práci se skautISem
 *
 * Sdružuje všechny komponenty a zprostředkovává jejich komunikaci.
 *
 * @author Hána František <[email protected]>
 *
 * @property-read WebServiceInterface $ApplicationManagement
 * @property-read WebServiceInterface $ContentManagement
 * @property-read WebServiceInterface $Evaluation
 * @property-read WebServiceInterface $Events
 * @property-read WebServiceInterface $Exports
 * @property-read WebServiceInterface $GoogleApps
 * @property-read WebServiceInterface $Journal
 * @property-read WebServiceInterface $Material
 * @property-read WebServiceInterface $Message
 * @property-read WebServiceInterface $OrganizationUnit
 * @property-read WebServiceInterface $Power
 * @property-read WebServiceInterface $Reports
 * @property-read WebServiceInterface $Summary
 * @property-read WebServiceInterface $Task
 * @property-read WebServiceInterface $Telephony
 * @property-read WebServiceInterface $UserManagement
 * @property-read WebServiceInterface $Vivant
 * @property-read WebServiceInterface $Welcome
 */
class Skautis
{

    use HelperTrait;

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

    /**
     * @var User
     */
    private $user;

    /**
     * @param WsdlManager $wsdlManager
     * @param User $user
     */
    public function __construct(WsdlManager $wsdlManager, User $user)
    {
        $this->wsdlManager = $wsdlManager;
        $this->user = $user;
    }

    public function getWsdlManager(): WsdlManager
    {
        return $this->wsdlManager;
    }

    public function getConfig(): Config
    {
        return $this->wsdlManager->getConfig();
    }

    public function getUser(): User
    {
        return $this->user;
    }

    /**
     * Získá objekt webové služby
     */
    public function getWebService(string $name): WebServiceInterface
    {
        $realServiceName = $this->getWebServiceName($name);
        return $this->wsdlManager->getWebService($realServiceName, $this->user->getLoginId());
    }

    /**
     * Trocha magie pro snadnější přístup k webovým službám.
     */
    public function __get(string $name): WebServiceInterface
    {
        return $this->getWebService($name);
    }

  /**
   * NEPOUŽÍVAT - vždy vyhodí výjimku
   *
   * @deprecated
   * @param string $name
   * @param mixed $value
   *
   * @return void
   *
   * @phpstan-return never
   */
    public function __set(
      $name,
      $value
    ) {
      throw new DynamicPropertiesDisabledException();
    }


  /**
     * Vrací URL na přihlášení
     */
    public function getLoginUrl(string $backlink = ''): string
    {
        $query = [];
        $query['appid'] = $this->getConfig()->getAppId();
        if (!empty($backlink)) {
            $query['ReturnUrl'] = $backlink;
        }
        return $this->getConfig()->getBaseUrl() . 'Login/?' . http_build_query($query, '', '&');
    }

    /**
     * Vrací URL na odhlášení
     */
    public function getLogoutUrl(): string
    {
        $query = [];
        $query['appid'] = $this->getConfig()->getAppId();
        $query['token'] = $this->user->getLoginId();
        return $this->getConfig()->getBaseUrl() . 'Login/LogOut.aspx?' . http_build_query($query, '', '&');
    }

    /**
     * Vrací URL k registraci
     */
    public function getRegisterUrl(string $backlink = ''): string
    {
        $query = [];
        $query['appid'] = $this->getConfig()->getAppId();
        if (!empty($backlink)) {
            $query['ReturnUrl'] = $backlink;
        }
        return $this->getConfig()->getBaseUrl() . 'Login/Registration.aspx?' . http_build_query($query, '', '&');
    }

    /**
     * Hromadné nastavení po přihlášení
     *
     * @param array<string, mixed> $data
     */
    public function setLoginData(array $data): void
    {
        $data = Helpers::parseLoginData($data);
        $this->getUser()->setLoginData($data[User::ID_LOGIN], $data[User::ID_ROLE], $data[User::ID_UNIT], $data[User::LOGOUT_DATE]);
    }

    /**
     * Ověřuje, zda je skautIS odstaven pro údržbu
     */
    public function isMaintenance(): bool
    {
        return $this->wsdlManager->isMaintenance();
    }

  /**
   * Vrací celé jméno webové služby
   *
   * @param string $name jméno nebo alias webové služby
   *
   * @throws WsdlException
   */
  protected function getWebServiceName(string $name): string
  {
    if (WebServiceName::isValidServiceName($name)) {
      return $name;
    }

    try {
      return WebServiceAlias::resolveAlias($name);
    }
    catch (WebServiceAliasNotFoundException $ex) {
      throw new WebServiceNotFoundException($name, 0, $ex);
    }
  }
}


1		<?php
2		declare(strict_types = 1);
3
4		namespace Skaut\Skautis;
5
6		use Skaut\Skautis\Wsdl\WebServiceAlias;
7		use Skaut\Skautis\Wsdl\WebServiceAliasNotFoundException;
8		use Skaut\Skautis\Wsdl\WebServiceInterface;
9		use Skaut\Skautis\Wsdl\WebServiceName;
10		use Skaut\Skautis\Wsdl\WebServiceNotFoundException;
11		use Skaut\Skautis\Wsdl\WsdlException;
12		use Skaut\Skautis\Wsdl\WsdlManager;
13
14		/**
15		* Třída pro práci se skautISem
16		*
17		* Sdružuje všechny komponenty a zprostředkovává jejich komunikaci.
18		*
19		* @author Hána František <[email protected]>
20		*
21		* @property-read WebServiceInterface $ApplicationManagement
22		* @property-read WebServiceInterface $ContentManagement
23		* @property-read WebServiceInterface $Evaluation
24		* @property-read WebServiceInterface $Events
25		* @property-read WebServiceInterface $Exports
26		* @property-read WebServiceInterface $GoogleApps
27		* @property-read WebServiceInterface $Journal
28		* @property-read WebServiceInterface $Material
29		* @property-read WebServiceInterface $Message
30		* @property-read WebServiceInterface $OrganizationUnit
31		* @property-read WebServiceInterface $Power
32		* @property-read WebServiceInterface $Reports
33		* @property-read WebServiceInterface $Summary
34		* @property-read WebServiceInterface $Task
35		* @property-read WebServiceInterface $Telephony
36		* @property-read WebServiceInterface $UserManagement
37		* @property-read WebServiceInterface $Vivant
38		* @property-read WebServiceInterface $Welcome
39		*/
40		class Skautis
41		{
42
43		use HelperTrait;
44
45		/**
46		* @var WsdlManager
47		*/
48		private $wsdlManager;
49
50		/**
51		* @var User
52		*/
53		private $user;
54
55		/**
56		* @param WsdlManager $wsdlManager
57		* @param User $user
58		*/
59	4	public function __construct(WsdlManager $wsdlManager, User $user)
60		{
61	4	$this->wsdlManager = $wsdlManager;
62	4	$this->user = $user;
63	4	}
64
65		public function getWsdlManager(): WsdlManager
66		{
67		return $this->wsdlManager;
68		}
69
70	3	public function getConfig(): Config
71		{
72	3	return $this->wsdlManager->getConfig();
73		}
74
75		public function getUser(): User
76		{
77		return $this->user;
78		}
79
80		/**
81		* Získá objekt webové služby
82		*/
83	2	public function getWebService(string $name): WebServiceInterface
84		{
85	2	$realServiceName = $this->getWebServiceName($name);
86	2	return $this->wsdlManager->getWebService($realServiceName, $this->user->getLoginId());
87		}
88
89		/**
90		* Trocha magie pro snadnější přístup k webovým službám.
91		*/
92	2	public function __get(string $name): WebServiceInterface
93		{
94	2	return $this->getWebService($name);
95		}
96
97		/**
98		* NEPOUŽÍVAT - vždy vyhodí výjimku
99		*
100		* @deprecated
101		* @param string $name
102		* @param mixed $value
103		*
104		* @return void
105		*
106		* @phpstan-return never
107		*/
108	1	public function __set(
109		$name,
110		$value
111		) {
112	1	throw new DynamicPropertiesDisabledException();
113		}
114
115
116		/**
117		* Vrací URL na přihlášení
118		*/
119	1	public function getLoginUrl(string $backlink = ''): string
120		{
121	1	$query = [];
122	1	$query['appid'] = $this->getConfig()->getAppId();
123	1	if (!empty($backlink)) {
124	1	$query['ReturnUrl'] = $backlink;
125		}
126	1	return $this->getConfig()->getBaseUrl() . 'Login/?' . http_build_query($query, '', '&');
127		}
128
129		/**
130		* Vrací URL na odhlášení
131		*/
132	1	public function getLogoutUrl(): string
133		{
134	1	$query = [];
135	1	$query['appid'] = $this->getConfig()->getAppId();
136	1	$query['token'] = $this->user->getLoginId();
137	1	return $this->getConfig()->getBaseUrl() . 'Login/LogOut.aspx?' . http_build_query($query, '', '&');
138		}
139
140		/**
141		* Vrací URL k registraci
142		*/
143	1	public function getRegisterUrl(string $backlink = ''): string
144		{
145	1	$query = [];
146	1	$query['appid'] = $this->getConfig()->getAppId();
147	1	if (!empty($backlink)) {
148		$query['ReturnUrl'] = $backlink;
149		}
150	1	return $this->getConfig()->getBaseUrl() . 'Login/Registration.aspx?' . http_build_query($query, '', '&');
151		}
152
153		/**
154		* Hromadné nastavení po přihlášení
155		*
156		* @param array<string, mixed> $data
157		*/
158		public function setLoginData(array $data): void
159		{
160		$data = Helpers::parseLoginData($data);
161		$this->getUser()->setLoginData($data[User::ID_LOGIN], $data[User::ID_ROLE], $data[User::ID_UNIT], $data[User::LOGOUT_DATE]);
162		}
163
164		/**
165		* Ověřuje, zda je skautIS odstaven pro údržbu
166		*/
167		public function isMaintenance(): bool
168		{
169		return $this->wsdlManager->isMaintenance();
170		}
171
172		/**
173		* Vrací celé jméno webové služby
174		*
175		* @param string $name jméno nebo alias webové služby
176		*
177		* @throws WsdlException
178		*/
179	2	protected function getWebServiceName(string $name): string
180		{
181	2	if (WebServiceName::isValidServiceName($name)) {
182	2	return $name;
183		}
184
185		try {
186	1	return WebServiceAlias::resolveAlias($name);
187		}
188		catch (WebServiceAliasNotFoundException $ex) {
189		throw new WebServiceNotFoundException($name, 0, $ex);
190		}
191		}
192		}
193

skaut / Skautis

GitHub Access Token became invalid

Push — 3.x ( 48a2e9...c23789 )

Skautis::getDebugLog() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like