AbstractBaseProvider::getBoolOption() - Code Metrics - Inspection of "[Provider] Support passing options to providers :)" - SocialConnect/auth - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( d08c69...d34b48 )

by Дмитрий

created 2018-02-11 05:56 UTC

AbstractBaseProvider::getBoolOption() A

↳ Parent: AbstractBaseProvider

Complexity

Conditions	2
Paths	2

Size

Total Lines	8
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	6

Importance

Changes

Metric	Value
dl	0
loc	8
ccs	0
cts	0
cp	0
rs	9.4285
c	0
b	0
f	0
cc	2
eloc	4
nc	2
nop	2
crap	6

<?php
/**
 * SocialConnect project
 * @author: Patsura Dmitry https://github.com/ovr <[email protected]>
 */

namespace SocialConnect\Provider;

use SocialConnect\Common\Http\Client\ClientInterface;
use SocialConnect\Provider\Session\SessionInterface;

abstract class AbstractBaseProvider
{
    /**
     * @var Consumer
     */
    protected $consumer;

    /**
     * @var array
     */
    protected $scope = [];

    /**
     * @var array
     */
    protected $fields = [];

    /**
     * @var ClientInterface
     */
    protected $httpClient;

    /**
     * @var string
     */
    protected $redirectUri;

    /**
     * @var SessionInterface
     */
    protected $session;

    /**
     * @var array
     */
    protected $options = [];

    /**
     * @param ClientInterface $httpClient
     * @param SessionInterface $session
     * @param array $parameters
     */
    public function __construct(ClientInterface $httpClient, SessionInterface $session, Consumer $consumer, array $parameters)
    {
        $this->httpClient = $httpClient;
        $this->session = $session;
        $this->consumer = $consumer;

        if (isset($parameters['scope'])) {
            $this->setScope($parameters['scope']);
        }

        if (isset($parameters['fields'])) {
            $this->setFields($parameters['fields']);
        }

        if (isset($parameters['redirectUri'])) {
            $this->redirectUri = $parameters['redirectUri'];
        }

        if (isset($parameters['options'])) {
            $this->options = $parameters['options'];
        }
    }

    /**
     * @param string $key
     * @param bool $default
     * @return bool
     */
    public function getBoolOption($key, $default)

    {
        if (array_key_exists($key, $this->options)) {
            return (bool) $this->options[$key];
        }

        return $default;
    }

    /**
     * @return mixed
     */
    protected function getRedirectUri()
    {
        return $this->redirectUri;
    }

    /**
     * @return string
     */
    public function getRedirectUrl()
    {
        return $this->getRedirectUri() . '/' . $this->getName() . '/';
    }

    /**
     * @return string
     */
    abstract public function getBaseUri();

    /**
     * Return Provider's name
     *
     * @return string
     */
    abstract public function getName();

    /**
     * @param array $requestParameters
     * @return \SocialConnect\Provider\AccessTokenInterface
     */
    abstract public function getAccessTokenByRequestParameters(array $requestParameters);

    /**
     * @return string
     */
    abstract public function makeAuthUrl();

    /**
     * Get current user identity from social network by $accessToken
     *
     * @param AccessTokenInterface $accessToken
     * @return \SocialConnect\Common\Entity\User
     *
     * @throws \SocialConnect\Provider\Exception\InvalidResponse
     */
    abstract public function getIdentity(AccessTokenInterface $accessToken);

    /**
     * @return array
     */
    public function getScope()
    {
        return $this->scope;
    }

    /**
     * @param array $scope
     */
    public function setScope(array $scope)
    {
        $this->scope = $scope;
    }

    /**
     * @return string
     */
    public function getScopeInline()
    {
        return implode(',', $this->scope);
    }

    /**
     * @return array
     */
    public function getFields()
    {
        return $this->fields;
    }

    /**
     * @param array $fields
     */
    public function setFields(array $fields)
    {
        $this->fields = $fields;
    }

    /**
     * @return string
     */
    public function getFieldsInline()
    {
        return implode(',', $this->fields);
    }

    /**
     * @return \SocialConnect\Provider\Consumer
     */
    public function getConsumer()
    {
        return $this->consumer;
    }
}


1		<?php
2		/**
3		* SocialConnect project
4		* @author: Patsura Dmitry https://github.com/ovr <[email protected]>
5		*/
6
7		namespace SocialConnect\Provider;
8
9		use SocialConnect\Common\Http\Client\ClientInterface;
10		use SocialConnect\Provider\Session\SessionInterface;
11
12		abstract class AbstractBaseProvider
13		{
14		/**
15		* @var Consumer
16		*/
17		protected $consumer;
18
19		/**
20		* @var array
21		*/
22		protected $scope = [];
23
24		/**
25		* @var array
26		*/
27		protected $fields = [];
28
29		/**
30		* @var ClientInterface
31		*/
32		protected $httpClient;
33
34		/**
35		* @var string
36		*/
37		protected $redirectUri;
38
39		/**
40		* @var SessionInterface
41		*/
42		protected $session;
43
44		/**
45		* @var array
46		*/
47		protected $options = [];
48
49	303	/**
50		* @param ClientInterface $httpClient
51	303	* @param SessionInterface $session
52	303	* @param array $parameters
53	303	*/
54		public function __construct(ClientInterface $httpClient, SessionInterface $session, Consumer $consumer, array $parameters)
55	303	{
56		$this->httpClient = $httpClient;
57		$this->session = $session;
58		$this->consumer = $consumer;
59	303
60		if (isset($parameters['scope'])) {
61		$this->setScope($parameters['scope']);
62		}
63	303
64	299	if (isset($parameters['fields'])) {
65	299	$this->setFields($parameters['fields']);
66	303	}
67
68		if (isset($parameters['redirectUri'])) {
69		$this->redirectUri = $parameters['redirectUri'];
70		}
71	43
72		if (isset($parameters['options'])) {
73	43	$this->options = $parameters['options'];
74		}
75		}
76
77		/**
78		* @param string $key
79	43	* @param bool $default
80		* @return bool
81	43	*/
82		public function getBoolOption($key, $default)
		0 ignored issues – show Coding Style Naming introduced 2018-02-11 06:11 UTC by Report Bug Copy Issue Report The 'getBoolOption()' method which returns a boolean should be named 'is...()' or 'has...()' Loading history...
83		{
84		if (array_key_exists($key, $this->options)) {
85		return (bool) $this->options[$key];
86		}
87
88		return $default;
89		}
90
91		/**
92		* @return mixed
93		*/
94		protected function getRedirectUri()
95		{
96		return $this->redirectUri;
97		}
98
99		/**
100		* @return string
101		*/
102		public function getRedirectUrl()
103		{
104		return $this->getRedirectUri() . '/' . $this->getName() . '/';
105		}
106
107		/**
108		* @return string
109		*/
110		abstract public function getBaseUri();
111
112		/**
113		* Return Provider's name
114		*
115		* @return string
116		*/
117		abstract public function getName();
118
119		/**
120		* @param array $requestParameters
121		* @return \SocialConnect\Provider\AccessTokenInterface
122		*/
123		abstract public function getAccessTokenByRequestParameters(array $requestParameters);
124
125		/**
126		* @return string
127		*/
128		abstract public function makeAuthUrl();
129
130		/**
131		* Get current user identity from social network by $accessToken
132		*
133		* @param AccessTokenInterface $accessToken
134		* @return \SocialConnect\Common\Entity\User
135		*
136		* @throws \SocialConnect\Provider\Exception\InvalidResponse
137		*/
138		abstract public function getIdentity(AccessTokenInterface $accessToken);
139
140		/**
141		* @return array
142		*/
143		public function getScope()
144		{
145		return $this->scope;
146		}
147
148		/**
149		* @param array $scope
150		*/
151		public function setScope(array $scope)
152		{
153		$this->scope = $scope;
154		}
155
156		/**
157		* @return string
158		*/
159		public function getScopeInline()
160	6	{
161		return implode(',', $this->scope);
162	6	}
163
164		/**
165		* @return array
166		*/
167		public function getFields()
168	1	{
169		return $this->fields;
170	1	}
171
172		/**
173		* @param array $fields
174		*/
175		public function setFields(array $fields)
176		{
177		$this->fields = $fields;
178		}
179
180		/**
181		* @return string
182		*/
183		public function getFieldsInline()
184		{
185		return implode(',', $this->fields);
186		}
187
188		/**
189		* @return \SocialConnect\Provider\Consumer
190		*/
191		public function getConsumer()
192		{
193		return $this->consumer;
194		}
195		}
196

SocialConnect / auth

Push — master ( d08c69...d34b48 )

AbstractBaseProvider::getBoolOption() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like