TGravatar::getEmail() - Code Metrics - Inspection of "Adds TGravatar and TPageService::onAdditionalPageP..." - pradosoft/prado - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( d20083...d26eb3 )

by Fabio

created 2021-05-20 09:37 UTC

TGravatar::getEmail() A

↳ Parent: TGravatar

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	1
eloc	1
c	1
b	0
f	0
nc	1
nop	0
dl	0
loc	3
rs	10

<?php
/**
 * TGravatar class file.
 *
 * @author Brad Anderson <[email protected]>
 * @link https://github.com/pradosoft/prado
 * @license https://github.com/pradosoft/prado/blob/master/LICENSE
 * @package Prado\Web\UI\WebControls
 */

namespace Prado\Web\UI\WebControls;

use Prado\TPropertyValue;
use Prado\Exceptions\TInvalidDataValueException;

/**
 * TGravatar class.
 *
 * TGravatar extends TImage and outputs a gravatar ImageUrl based
 * upon an email address, size, rating, and default style of the gravatar.
 *
 * {@link setDefault} allows for various styles of gravatar:
 *		• mp - Mystery Person
 *		• identicon - identicon style
 *		• monsterid - monster style
 *		• wavatar - wavatar style
 *		• retro - Retra style
 *		• robohash - Robohash style
 *		• blank - a blank space
 *		• 404 - not found page error
 *		• _url - provide your own default URL (to be url encoded for you)
 *
 * A rating of the gravatar can be provided as g, pg, r, and x.
 *
 * The size must be between 1 and 512, inclusive.
 *
 * {@link TParameterizeBehavior} can be attached to TGravatar to give
 * default values for various properties like Default and Rating.
 *
 * See {@link https://gravatar.com} for more information.
 *
 * @author Brad Anderson <[email protected]>
 * @package Prado\Web\UI\WebControls
 * @since 4.2.0
 */
class TGravatar extends TImage
{
	public const HTTP_URL = 'http://www.gravatar.com/avatar/';
	public const HTTPS_URL = 'https://secure.gravatar.com/avatar/';
	
	/**
	 * @return string the URL to the gravatar
	 */
	public function getImageUrl()
	{
		$params = [];
		$params['s'] = $this->getSize();
		$params['r'] = $this->getRating();
		$params['d'] = $this->getDefaultImageStyle();
		
		return ($this->getUseSecureUrl() ? self::HTTPS_URL : self::HTTP_URL) . md5(strtolower(trim($this->getEmail()))) . '?' . http_build_query($params, '', '&', PHP_QUERY_RFC3986);
	}
	
	/**
	 * @return null|string one of: mp, identicon, monsterid, wavatar, retro, robohash, blank, 404, _url_;
	 * this defaults to null
	 */
	public function getDefaultImageStyle()
	{
		return $this->getViewState('default');
	}
	
	/**
	 * @param null|string $default one of: mp, identicon, monsterid, wavatar, retro, robohash, blank, 404, _url_
	 */
	public function setDefaultImageStyle($default)
	{
		$default = TPropertyValue::ensureString($default);
		$lowerDefault = strtolower($default);
		if ($valid = in_array($lowerDefault, ['mp', 'identicon', 'monsterid', 'wavatar', 'retro', 'robohash', 'blank', '404', ''])) {
			$default = $lowerDefault;
		}
		if (!$valid && !preg_match('/^https?:\/\//i', $default)) {
			throw new TInvalidDataValueException('gravatar_bad_default', $default);
		}
		if (!$default) {
			$default = null;
		}
		$this->setViewState('default', $default);
	}
	
	/**
	 * When the Size is not set or is null, the default size of a gravatar
	 * from the gravatar website is 80.
	 * @return null|int the pixel size of the gravatar, [1..512], default null (results in 80)
	 */
	public function getSize()
	{
		return $this->getViewState('size');
	}
	
	/**
	 * @param null|int $size the pixel size of the gravatar, [1..512]
	 */
	public function setSize($size)
	{
		$_size = TPropertyValue::ensureInteger($size);
		if (($_size > 512 || $_size < 1) && $size !== null && $size !== '') {
			throw new TInvalidDataValueException('gravatar_bad_size', $size);
		}
		if (!$size) {
0   == false // true
0   == null  // true
123 == false // false
123 == null  // false

// It is often better to use strict comparison
0 === false // false
0 === null  // false
			$_size = null;
		}
		$this->setViewState('size', $_size);
	}
	
	/**
	 * @return null|string the rating of the icon ['g', 'pg', 'r', 'x', ''], default null
	 */
	public function getRating()
	{
		return $this->getViewState('rating');
	}
	
	/**
	 * @param null|string $rating the rating of the icon ['g', 'pg', 'r', 'x', '']
	 */
	public function setRating($rating)
	{
		$rating = strtolower(TPropertyValue::ensureString($rating));
		$rating = TPropertyValue::ensureEnum($rating, ['g', 'pg', 'r', 'x', '']);
		if (!$rating) {
			$rating = null;
		}
		$this->setViewState('rating', $rating);
	}
	
	/**
	 * @return string the email address associated with the gravatar icon
	 */
	public function getEmail()
	{
		return $this->getViewState('email', '');
	}
	
	/**
	 * @param $email string the email address associated with the gravatar icon
	 */
	public function setEmail($email)
	{
		$this->setViewState('email', TPropertyValue::ensureString($email), '');
	}
	
	/**
	 * @return bool whether or not to use the secure HTTPS url, defaults to the connection being used
	 */
	public function getUseSecureUrl()
	{
		return $this->getViewState('use_secure_url', $this->getRequest()->getIsSecureConnection());
	}
	
	/**
	 * @param bool $useSecureUrl whether or not to use the secure HTTPS url
	 */
	public function setUseSecureUrl($useSecureUrl)
	{
		$this->setViewState('use_secure_url', TPropertyValue::ensureBoolean($useSecureUrl));
	}
}


1			<?php
2			/**
3			* TGravatar class file.
4			*
5			* @author Brad Anderson <[email protected]>
6			* @link https://github.com/pradosoft/prado
7			* @license https://github.com/pradosoft/prado/blob/master/LICENSE
8			* @package Prado\Web\UI\WebControls
9			*/
10
11			namespace Prado\Web\UI\WebControls;
12
13			use Prado\TPropertyValue;
14			use Prado\Exceptions\TInvalidDataValueException;
15
16			/**
17			* TGravatar class.
18			*
19			* TGravatar extends TImage and outputs a gravatar ImageUrl based
20			* upon an email address, size, rating, and default style of the gravatar.
21			*
22			* {@link setDefault} allows for various styles of gravatar:
23			* • mp - Mystery Person
24			* • identicon - identicon style
25			* • monsterid - monster style
26			* • wavatar - wavatar style
27			* • retro - Retra style
28			* • robohash - Robohash style
29			* • blank - a blank space
30			* • 404 - not found page error
31			* • _url - provide your own default URL (to be url encoded for you)
32			*
33			* A rating of the gravatar can be provided as g, pg, r, and x.
34			*
35			* The size must be between 1 and 512, inclusive.
36			*
37			* {@link TParameterizeBehavior} can be attached to TGravatar to give
38			* default values for various properties like Default and Rating.
39			*
40			* See {@link https://gravatar.com} for more information.
41			*
42			* @author Brad Anderson <[email protected]>
43			* @package Prado\Web\UI\WebControls
44			* @since 4.2.0
45			*/
46			class TGravatar extends TImage
47			{
48			public const HTTP_URL = 'http://www.gravatar.com/avatar/';
49			public const HTTPS_URL = 'https://secure.gravatar.com/avatar/';
50
51			/**
52			* @return string the URL to the gravatar
53			*/
54			public function getImageUrl()
55			{
56			$params = [];
57			$params['s'] = $this->getSize();
58			$params['r'] = $this->getRating();
59			$params['d'] = $this->getDefaultImageStyle();
60
61			return ($this->getUseSecureUrl() ? self::HTTPS_URL : self::HTTP_URL) . md5(strtolower(trim($this->getEmail()))) . '?' . http_build_query($params, '', '&', PHP_QUERY_RFC3986);
62			}
63
64			/**
65			* @return null\|string one of: mp, identicon, monsterid, wavatar, retro, robohash, blank, 404, _url_;
66			* this defaults to null
67			*/
68			public function getDefaultImageStyle()
69			{
70			return $this->getViewState('default');
71			}
72
73			/**
74			* @param null\|string $default one of: mp, identicon, monsterid, wavatar, retro, robohash, blank, 404, _url_
75			*/
76			public function setDefaultImageStyle($default)
77			{
78			$default = TPropertyValue::ensureString($default);
79			$lowerDefault = strtolower($default);
80			if ($valid = in_array($lowerDefault, ['mp', 'identicon', 'monsterid', 'wavatar', 'retro', 'robohash', 'blank', '404', ''])) {
81			$default = $lowerDefault;
82			}
83			if (!$valid && !preg_match('/^https?:\/\//i', $default)) {
84			throw new TInvalidDataValueException('gravatar_bad_default', $default);
85			}
86			if (!$default) {
87			$default = null;
88			}
89			$this->setViewState('default', $default);
90			}
91
92			/**
93			* When the Size is not set or is null, the default size of a gravatar
94			* from the gravatar website is 80.
95			* @return null\|int the pixel size of the gravatar, [1..512], default null (results in 80)
96			*/
97			public function getSize()
98			{
99			return $this->getViewState('size');
100			}
101
102			/**
103			* @param null\|int $size the pixel size of the gravatar, [1..512]
104			*/
105			public function setSize($size)
106			{
107			$_size = TPropertyValue::ensureInteger($size);
108			if (($_size > 512 \|\| $_size < 1) && $size !== null && $size !== '') {
109			throw new TInvalidDataValueException('gravatar_bad_size', $size);
110			}
111			if (!$size) {
			0 ignored issues – show Bug Best Practice introduced 2021-05-20 08:29 UTC by Report Bug Copy Issue Report The expression `$size` of type `integer\|null` is loosely compared to `false`; this is ambiguous if the integer can be 0. You might want to explicitly use `=== null` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `integer` values, zero is a special case, in particular the following results might be unexpected: 0 == false // true 0 == null // true 123 == false // false 123 == null // false // It is often better to use strict comparison 0 === false // false 0 === null // false Loading history...
112			$_size = null;
113			}
114			$this->setViewState('size', $_size);
115			}
116
117			/**
118			* @return null\|string the rating of the icon ['g', 'pg', 'r', 'x', ''], default null
119			*/
120			public function getRating()
121			{
122			return $this->getViewState('rating');
123			}
124
125			/**
126			* @param null\|string $rating the rating of the icon ['g', 'pg', 'r', 'x', '']
127			*/
128			public function setRating($rating)
129			{
130			$rating = strtolower(TPropertyValue::ensureString($rating));
131			$rating = TPropertyValue::ensureEnum($rating, ['g', 'pg', 'r', 'x', '']);
132			if (!$rating) {
133			$rating = null;
134			}
135			$this->setViewState('rating', $rating);
136			}
137
138			/**
139			* @return string the email address associated with the gravatar icon
140			*/
141			public function getEmail()
142			{
143			return $this->getViewState('email', '');
144			}
145
146			/**
147			* @param $email string the email address associated with the gravatar icon
148			*/
149			public function setEmail($email)
150			{
151			$this->setViewState('email', TPropertyValue::ensureString($email), '');
152			}
153
154			/**
155			* @return bool whether or not to use the secure HTTPS url, defaults to the connection being used
156			*/
157			public function getUseSecureUrl()
158			{
159			return $this->getViewState('use_secure_url', $this->getRequest()->getIsSecureConnection());
160			}
161
162			/**
163			* @param bool $useSecureUrl whether or not to use the secure HTTPS url
164			*/
165			public function setUseSecureUrl($useSecureUrl)
166			{
167			$this->setViewState('use_secure_url', TPropertyValue::ensureBoolean($useSecureUrl));
168			}
169			}
170

pradosoft / prado

Push — master ( d20083...d26eb3 )

TGravatar::getEmail() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like