SS_Datetimezone::getCurrentCachedUser() - Code Metrics - Inspection of "Cache the current user" - silverstripe/deploynaut - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#807)

by Stig

created 2016-11-10 05:21 UTC

SS_Datetimezone::getCurrentCachedUser() A

↳ Parent: SS_Datetimezone

Complexity

Conditions	3
Paths	3

Size

Total Lines	10
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?php
/**
 * Class SS_Datetimezone
 *
 * Adds customisable timezones to the nice method on {@link SS_Datetime}.
 */
class SS_Datetimezone extends SS_Datetime {
namespace YourVendor;

class YourClass { }

	/**
	 * @var \Member[]
	 */
	protected static $_cache_members = [];

	/**
	* Returns the date in the raw SQL-format specific to a given timezone passed from the Member class, e.g. “2006-01-18 16:32:04”

	*/
	public function Format($format) {
		if($this->value){
			$date = new DateTime($this->value);
			//if the current user has set a timezone that is not the default then use that
			$member = $this->getCurrentCachedUser();
			if ($member && $member->exists() && $member->Timezone && $member->Timezone != date_default_timezone_get()) {
				$date->setTimezone(new DateTimeZone($member->Timezone));
			}
			return $date->Format($format);
		}
	}

	/**
	 * Format can be called a lot of time in tight loops, so we cache the current user
	 * per request
	 *
	 * @return \Member|null
	 */
	protected function getCurrentCachedUser() {
		$memberID = \Member::currentUserID();
		if(!$memberID) {
			return null;
		}
		if(!isset(self::$_cache_members[$memberID])) {
			self::$_cache_members[$memberID] = Member::get()->byId($memberID);
		}
		return self::$_cache_members[$memberID];
	}
}


1			<?php
2			/**
3			* Class SS_Datetimezone
4			*
5			* Adds customisable timezones to the nice method on {@link SS_Datetime}.
6			*/
7			class SS_Datetimezone extends SS_Datetime {
			0 ignored issues – show Coding Style Compatibility introduced 2016-09-26 02:16 UTC by Report Bug Copy Issue Report PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions. You can fix this by adding a namespace to your class: namespace YourVendor; class YourClass { } When choosing a vendor namespace, try to pick something that is not too generic to avoid conflicts with other libraries. Loading history... Coding Style introduced 2016-11-10 05:25 UTC by Report Bug Copy Issue Report The property $_cache_members is not named in camelCase. This check marks property names that have not been written in camelCase. In camelCase names are written without any punctuation, the start of each new word being marked by a capital letter. Thus the name database connection string becomes `databaseConnectionString`. Loading history...
8
9			/**
10			* @var \Member[]
11			*/
12			protected static $_cache_members = [];
13
14			/**
15			* Returns the date in the raw SQL-format specific to a given timezone passed from the Member class, e.g. “2006-01-18 16:32:04”
			0 ignored issues – show Coding Style introduced 2016-09-26 02:16 UTC by Report Bug Copy Issue Report This line exceeds maximum limit of 120 characters; contains 127 characters Overly long lines are hard to read on any screen. Most code styles therefor impose a maximum limit on the number of characters in a line. Loading history...
16			*/
17			public function Format($format) {
18			if($this->value){
19			$date = new DateTime($this->value);
20			//if the current user has set a timezone that is not the default then use that
21			$member = $this->getCurrentCachedUser();
22			if ($member && $member->exists() && $member->Timezone && $member->Timezone != date_default_timezone_get()) {
23			$date->setTimezone(new DateTimeZone($member->Timezone));
24			}
25			return $date->Format($format);
26			}
27			}
28
29			/**
30			* Format can be called a lot of time in tight loops, so we cache the current user
31			* per request
32			*
33			* @return \Member\|null
34			*/
35			protected function getCurrentCachedUser() {
36			$memberID = \Member::currentUserID();
37			if(!$memberID) {
38			return null;
39			}
40			if(!isset(self::$_cache_members[$memberID])) {
41			self::$_cache_members[$memberID] = Member::get()->byId($memberID);
42			}
43			return self::$_cache_members[$memberID];
44			}
45			}
46

silverstripe / deploynaut

Pull Request — master (#807)

SS_Datetimezone::getCurrentCachedUser() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like