Token::setOnline() - Code Metrics - alxmsl/GoogleClient - Measure and Improve Code Quality continuously with Scrutinizer

Token::setOnline() A
last analyzed 2016-05-16 12:50 UTC

↳ Parent: Token

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	3
CRAP Score	1

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

<?php
/*
 * Copyright 2015 Alexey Maslov <[email protected]>
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

namespace alxmsl\Google\OAuth2\Response;

use alxmsl\Google\InitializationInterface;
use OutOfBoundsException;

/**
 * Authorized token object
 * @author alxmsl
 * @date 2/4/13
 */ 
final class Token implements InitializationInterface {
    /**
     * Token type constants
     */
    const TYPE_UNKNOWN = 0,
          TYPE_BEARER  = 1;

    /**
     * @var string access token
     */
    private $accessToken = '';

    /**
     * @var int token type
     */
    private $tokenType = self::TYPE_BEARER;

    /**
     * @var int access token expires in
     */
    private $expiresIn = 0;

    /**
     * @var string id token
     */
    private $idToken = '';

    /**
     * @var string refresh token
     */
    private $refreshToken = '';

    /**
     * @var bool online or offline access token
     */
    private $online = false;

    private function __construct() {}

    /**
     * Setter for access token
     * @param string $accessToken access token
     * @return Token self
     */
    private function setAccessToken($accessToken) {
        $this->accessToken = (string) $accessToken;
        return $this;
    }

    /**
     * Getter for access token
     * @return string access token
     */
    public function getAccessToken() {
        return $this->accessToken;
    }

    /**
     * Setter for access token expires in
     * @param int $expiresIn access token expires in
     * @return Token self
     */
    public function setExpiresIn($expiresIn) {
        $this->expiresIn = (int) $expiresIn;
        return $this;
    }

    /**
     * Getter for access token expires in
     * @return int access token expires in
     */
    public function getExpiresIn() {
        return $this->expiresIn;
    }

    /**
     * Setter for id token
     * @param string $idToken id token
     * @return Token self
     */
    public function setIdToken($idToken) {
        $this->idToken = (string) $idToken;
        return $this;
    }

    /**
     * Getter for id token
     * @return string id token
     */
    public function getIdToken() {
        return $this->idToken;
    }

    /**
     * Setter for refresh token
     * @param string $refreshToken refresh token
     * @return Token self
     */
    public function setRefreshToken($refreshToken) {
        $this->refreshToken = (string) $refreshToken;
        return $this;
    }

    /**
     * Getter for refresh token
     * @return string refresh token
     * @throws OutOfBoundsException for online access tokens
     */
    public function getRefreshToken() {
        if ($this->isOnline()) {
            throw new OutOfBoundsException('online tokens has not refresh tokens');
        }
        return $this->refreshToken;
    }

    /**
     * Setter for token type
     * @param string $tokenType token type string
     * @return Token self
     */
    public function setTokenType($tokenType) {
        switch ($tokenType) {
            case 'Bearer':
                $this->tokenType = self::TYPE_BEARER;
                break;
            default:
                $this->tokenType = self::TYPE_UNKNOWN;
        }
        return $this;
    }

    /**
     * Getter for token type code
     * @return int token type code
     */
    public function getTokenType() {
        return $this->tokenType;
    }

    /**
     * Setter for online flag value
     * @param bool $online online flag value
     */
    private function setOnline($online) {
        $this->online = !!$online;
    }

    /**
     * Getter for online flag
     * @return bool online flag value
     */
    public function isOnline() {
        return $this->online;
    }

    /**
     * Method for object initialization by the string
     * @param string $string response string
     * @return Token response object
     */
    public static function initializeByString($string) {
        $object = json_decode($string);
        $Response = new self();
        $Response->setAccessToken($object->access_token)
            ->setExpiresIn($object->expires_in)
            ->setTokenType($object->token_type);

        if (isset($object->id_token)) {
            $Response->setIdToken($object->id_token);
        }

        $Response->setOnline(!isset($object->refresh_token));
        if (!$Response->isOnline()) {
            $Response->setRefreshToken($object->refresh_token);
        }
        return $Response;
    }

    /**
     * @inheritdoc
     */
    public function __toString() {
        $format = <<<'EOD'
    access token:  %s
    expires in:    %s
    id token:      %s
    refresh token: %s
    token type:    %s
EOD;
        try {
            $refreshToken = $this->getRefreshToken();
        } catch (OutOfBoundsException $Ex) {
            $refreshToken = 'not available for online type';
        }
        return sprintf($format
            , $this->getAccessToken()
            , $this->getExpiresIn()
            , $this->getIdToken() ?: '-'
            , $refreshToken
            , $this->getTokenType());
    }
}


1		<?php
2		/*
3		* Copyright 2015 Alexey Maslov <[email protected]>
4		*
5		* Licensed under the Apache License, Version 2.0 (the "License");
6		* you may not use this file except in compliance with the License.
7		* You may obtain a copy of the License at
8		*
9		* http://www.apache.org/licenses/LICENSE-2.0
10		*
11		* Unless required by applicable law or agreed to in writing, software
12		* distributed under the License is distributed on an "AS IS" BASIS,
13		* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14		* See the License for the specific language governing permissions and
15		* limitations under the License.
16		*/
17
18		namespace alxmsl\Google\OAuth2\Response;
19
20		use alxmsl\Google\InitializationInterface;
21		use OutOfBoundsException;
22
23		/**
24		* Authorized token object
25		* @author alxmsl
26		* @date 2/4/13
27		*/
28		final class Token implements InitializationInterface {
29		/**
30		* Token type constants
31		*/
32		const TYPE_UNKNOWN = 0,
33		TYPE_BEARER = 1;
34
35		/**
36		* @var string access token
37		*/
38		private $accessToken = '';
39
40		/**
41		* @var int token type
42		*/
43		private $tokenType = self::TYPE_BEARER;
44
45		/**
46		* @var int access token expires in
47		*/
48		private $expiresIn = 0;
49
50		/**
51		* @var string id token
52		*/
53		private $idToken = '';
54
55		/**
56		* @var string refresh token
57		*/
58		private $refreshToken = '';
59
60		/**
61		* @var bool online or offline access token
62		*/
63		private $online = false;
64
65		private function __construct() {}
66
67		/**
68		* Setter for access token
69		* @param string $accessToken access token
70		* @return Token self
71		*/
72	5	private function setAccessToken($accessToken) {
73	5	$this->accessToken = (string) $accessToken;
74	5	return $this;
75		}
76
77		/**
78		* Getter for access token
79		* @return string access token
80		*/
81	3	public function getAccessToken() {
82	3	return $this->accessToken;
83		}
84
85		/**
86		* Setter for access token expires in
87		* @param int $expiresIn access token expires in
88		* @return Token self
89		*/
90	5	public function setExpiresIn($expiresIn) {
91	5	$this->expiresIn = (int) $expiresIn;
92	5	return $this;
93		}
94
95		/**
96		* Getter for access token expires in
97		* @return int access token expires in
98		*/
99	2	public function getExpiresIn() {
100	2	return $this->expiresIn;
101		}
102
103		/**
104		* Setter for id token
105		* @param string $idToken id token
106		* @return Token self
107		*/
108	1	public function setIdToken($idToken) {
109	1	$this->idToken = (string) $idToken;
110	1	return $this;
111		}
112
113		/**
114		* Getter for id token
115		* @return string id token
116		*/
117	3	public function getIdToken() {
118	3	return $this->idToken;
119		}
120
121		/**
122		* Setter for refresh token
123		* @param string $refreshToken refresh token
124		* @return Token self
125		*/
126	1	public function setRefreshToken($refreshToken) {
127	1	$this->refreshToken = (string) $refreshToken;
128	1	return $this;
129		}
130
131		/**
132		* Getter for refresh token
133		* @return string refresh token
134		* @throws OutOfBoundsException for online access tokens
135		*/
136	2	public function getRefreshToken() {
137	2	if ($this->isOnline()) {
138	1	throw new OutOfBoundsException('online tokens has not refresh tokens');
139		}
140	1	return $this->refreshToken;
141		}
142
143		/**
144		* Setter for token type
145		* @param string $tokenType token type string
146		* @return Token self
147		*/
148	5	public function setTokenType($tokenType) {
149		switch ($tokenType) {
150	5	case 'Bearer':
151	4	$this->tokenType = self::TYPE_BEARER;
152	4	break;
153	1	default:
154	1	$this->tokenType = self::TYPE_UNKNOWN;
155	1	}
156	5	return $this;
157		}
158
159		/**
160		* Getter for token type code
161		* @return int token type code
162		*/
163	3	public function getTokenType() {
164	3	return $this->tokenType;
165		}
166
167		/**
168		* Setter for online flag value
169		* @param bool $online online flag value
170		*/
171	5	private function setOnline($online) {
172	5	$this->online = !!$online;
173	5	}
174
175		/**
176		* Getter for online flag
177		* @return bool online flag value
178		*/
179	5	public function isOnline() {
180	5	return $this->online;
181		}
182
183		/**
184		* Method for object initialization by the string
185		* @param string $string response string
186		* @return Token response object
187		*/
188	5	public static function initializeByString($string) {
189	5	$object = json_decode($string);
190	5	$Response = new self();
191	5	$Response->setAccessToken($object->access_token)
192	5	->setExpiresIn($object->expires_in)
193	5	->setTokenType($object->token_type);
194
195	5	if (isset($object->id_token)) {
196	1	$Response->setIdToken($object->id_token);
197	1	}
198
199	5	$Response->setOnline(!isset($object->refresh_token));
200	5	if (!$Response->isOnline()) {
201	1	$Response->setRefreshToken($object->refresh_token);
202	1	}
203	5	return $Response;
204		}
205
206		/**
207		* @inheritdoc
208		*/
209	2	public function __toString() {
210		$format = <<<'EOD'
211		access token: %s
212		expires in: %s
213		id token: %s
214		refresh token: %s
215		token type: %s
216	2	EOD;
217		try {
218	2	$refreshToken = $this->getRefreshToken();
219	2	} catch (OutOfBoundsException $Ex) {
220	1	$refreshToken = 'not available for online type';
221		}
222	2	return sprintf($format
223	2	, $this->getAccessToken()
224	2	, $this->getExpiresIn()
225	2	, $this->getIdToken() ?: '-'
226	2	, $refreshToken
227	2	, $this->getTokenType());
228		}
229		}
230

alxmsl / GoogleClient

Token::setOnline() A last analyzed 2016-05-16 12:50 UTC

Complexity

Size

Duplication

Code Coverage

Duplication Side-by-Side

Filter issues like

Token::setOnline() A
last analyzed 2016-05-16 12:50 UTC