Inheritance diagram for Timezone:

Public Member Functions
	__construct (ScopeResolverInterface $scopeResolver, ResolverInterface $localeResolver, \Magento\Framework\Stdlib\DateTime $dateTime, ScopeConfigInterface $scopeConfig, $scopeType, $defaultTimezonePath)

	getDefaultTimezonePath ()

	getDefaultTimezone ()

	getConfigTimezone ($scopeType=null, $scopeCode=null)

	getDateFormat ($type=\IntlDateFormatter::SHORT)

	getDateFormatWithLongYear ()

	getTimeFormat ($type=\IntlDateFormatter::SHORT)

	getDateTimeFormat ($type)

	date ($date=null, $locale=null, $useTimezone=true, $includeTime=true)

	scopeDate ($scope=null, $date=null, $includeTime=false)

	formatDate ($date=null, $format=\IntlDateFormatter::SHORT, $showTime=false)

	scopeTimeStamp ($scope=null)

	isScopeDateInInterval ($scope, $dateFrom=null, $dateTo=null)

	formatDateTime ( $date, $dateType=\IntlDateFormatter::SHORT, $timeType=\IntlDateFormatter::SHORT, $locale=null, $timezone=null, $pattern=null)

	convertConfigTimeToUtc ($date, $format='Y-m-d H:i:s')

Protected Attributes
	$_allowedFormats

	$_scopeType

	$_scopeResolver

	$_dateTime

	$_defaultTimezonePath

	$_scopeConfig

	$_localeResolver

Detailed Description

Timezone library

@SuppressWarnings(PHPMD.CouplingBetweenObjects)

Definition at line 21 of file Timezone.php.

Constructor & Destructor Documentation

◆ __construct()

__construct	(	ScopeResolverInterface	$scopeResolver,
		ResolverInterface	$localeResolver,
		\Magento\Framework\Stdlib\DateTime	$dateTime,
		ScopeConfigInterface	$scopeConfig,
			$scopeType,
			$defaultTimezonePath
	)

Parameters

ScopeResolverInterface	$scopeResolver
ResolverInterface	$localeResolver
\Magento\Framework\Stdlib\DateTime	$dateTime
ScopeConfigInterface	$scopeConfig
string	$scopeType
string	$defaultTimezonePath

Definition at line 71 of file Timezone.php.

       {
         $this->_scopeResolver = $scopeResolver;
         $this->_localeResolver = $localeResolver;
         $this->_dateTime = $dateTime;
         $this->_defaultTimezonePath = $defaultTimezonePath;
         $this->_scopeConfig = $scopeConfig;
         $this->_scopeType = $scopeType;
     }

Member Function Documentation

◆ convertConfigTimeToUtc()

convertConfigTimeToUtc	(	$date,
		$format = `'Y-m-d H:i:s'`
	)

Convert date from config timezone to Utc. If pass \DateTime object as argument be sure that timezone is the same with config timezone

Parameters

string \| \DateTimeInterface	$date
string	$format

Exceptions

LocalizedException

Returns: string

Implements TimezoneInterface.

Definition at line 310 of file Timezone.php.

                                                                     :i:s')
     {
         if (!($date instanceof \DateTimeInterface)) {
             if ($date instanceof \DateTimeImmutable) {
                 $date = new \DateTime($date->format('Y-m-d H:i:s'), new \DateTimeZone($this->getConfigTimezone()));
             } else {
                 $date = new \DateTime($date, new \DateTimeZone($this->getConfigTimezone()));
             }
         } else {
             if ($date->getTimezone()->getName() !== $this->getConfigTimezone()) {
                 throw new LocalizedException(
                     new Phrase(
                         'The DateTime object timezone needs to be the same as the "%1" timezone in config.',
                         $this->getConfigTimezone()
                     )
                 );
             }
         }
 
         $date->setTimezone(new \DateTimeZone('UTC'));
 
         return $date->format($format);
     }

◆ date()

date	(	$date = `null`,
		$locale = `null`,
		$useTimezone = `true`,
		$includeTime = `true`
	)

{Create \DateTime object for current locale

Parameters

mixed	$date
string	$locale
bool	$useTimezone
bool	$includeTime

Returns: \DateTime

}

Implements TimezoneInterface.

Definition at line 162 of file Timezone.php.

     {
         $locale = $locale ?: $this->_localeResolver->getLocale();
         $timezone = $useTimezone
             ? $this->getConfigTimezone()
             : date_default_timezone_get();
 
         switch (true) {
             case (empty($date)):
                 return new \DateTime('now', new \DateTimeZone($timezone));
             case ($date instanceof \DateTime):
                 return $date->setTimezone(new \DateTimeZone($timezone));
             case ($date instanceof \DateTimeImmutable):
                 return new \DateTime($date->format('Y-m-d H:i:s'), $date->getTimezone());
             case (!is_numeric($date)):
                 $timeType = $includeTime ? \IntlDateFormatter::SHORT : \IntlDateFormatter::NONE;
                 $formatter = new \IntlDateFormatter(
                     $locale,
                     \IntlDateFormatter::SHORT,
                     $timeType,
                     new \DateTimeZone($timezone)
                 );
 
                 $date = $this->appendTimeIfNeeded($date, $includeTime);
                 $date = $formatter->parse($date) ?: (new \DateTime($date))->getTimestamp();
                 break;
         }
 
         return (new \DateTime(null, new \DateTimeZone($timezone)))->setTimestamp($date);
     }

◆ formatDate()

formatDate	(	$date = `null`,
		$format = `\IntlDateFormatter::SHORT`,
		$showTime = `false`
	)

{Format date using current locale options and time zone.

Parameters

\DateTime \| null	$date
int	$format
bool	$showTime

Returns: string

}

Implements TimezoneInterface.

Definition at line 209 of file Timezone.php.

     {
         $formatTime = $showTime ? $format : \IntlDateFormatter::NONE;
 
         if (!($date instanceof \DateTimeInterface)) {
             $date = new \DateTime($date);
         }
 
         return $this->formatDateTime($date, $format, $formatTime);
     }

◆ formatDateTime()

formatDateTime	(	$date,
		$dateType = `\IntlDateFormatter::SHORT`,
		$timeType = `\IntlDateFormatter::SHORT`,
		$locale = `null`,
		$timezone = `null`,
		$pattern = `null`
	)

Parameters

string \| \DateTimeInterface	$date
int	$dateType
int	$timeType
string \| null	$locale
string \| null	$timezone
string \| null	$pattern

Returns: string

Implements TimezoneInterface.

Definition at line 268 of file Timezone.php.

       {
         if (!($date instanceof \DateTimeInterface)) {
             $date = new \DateTime($date);
         }
 
         if ($timezone === null) {
             if ($date->getTimezone() == null || $date->getTimezone()->getName() == 'UTC'
                 || $date->getTimezone()->getName() == '+00:00'
             ) {
                 $timezone = $this->getConfigTimezone();
             } else {
                 $timezone = $date->getTimezone();
             }
         }
 
         $formatter = new \IntlDateFormatter(
             $locale ?: $this->_localeResolver->getLocale(),
             $dateType,
             $timeType,
             $timezone,
             null,
             $pattern
         );
         return $formatter->format($date);
     }

◆ getConfigTimezone()

getConfigTimezone	(	$scopeType = `null`,
		$scopeCode = `null`
	)

{Gets the scope config timezone

Parameters

string	$scopeType
string	$scopeCode

Returns: string

}

Implements TimezoneInterface.

Definition at line 106 of file Timezone.php.

     {
         return $this->_scopeConfig->getValue(
             $this->getDefaultTimezonePath(),
             $scopeType ?: $this->_scopeType,
             $scopeCode
         );
     }

◆ getDateFormat()

getDateFormat ( $type = \IntlDateFormatter::SHORT )

{Retrieve ISO date format

Parameters

int $type

Returns: string

}

Implements TimezoneInterface.

Definition at line 118 of file Timezone.php.

     {
         return (new \IntlDateFormatter(
             $this->_localeResolver->getLocale(),
             $type,
             \IntlDateFormatter::NONE
         ))->getPattern();
     }

◆ getDateFormatWithLongYear()

getDateFormatWithLongYear ( )

{Retrieve short date format with 4-digit year

Returns: string

}

Implements TimezoneInterface.

Definition at line 130 of file Timezone.php.

     {
         return preg_replace(
             '/(?<!y)yy(?!y)/',
             'Y',
             $this->getDateFormat()
         );
     }

◆ getDateTimeFormat()

getDateTimeFormat ( $type )

{Retrieve ISO datetime format

Parameters

string $type

Returns: string

}

Implements TimezoneInterface.

Definition at line 154 of file Timezone.php.

     {
         return $this->getDateFormat($type) . ' ' . $this->getTimeFormat($type);
     }

◆ getDefaultTimezone()

getDefaultTimezone ( )

{Retrieve timezone code

Returns: string

}

Implements TimezoneInterface.

Definition at line 98 of file Timezone.php.

     {
         return 'UTC';
     }

◆ getDefaultTimezonePath()

getDefaultTimezonePath ( )

{Return path to default timezone

Returns: string

}

Implements TimezoneInterface.

Definition at line 90 of file Timezone.php.

     {
         return $this->_defaultTimezonePath;
     }

◆ getTimeFormat()

getTimeFormat ( $type = \IntlDateFormatter::SHORT )

{Retrieve ISO time format

Parameters

string $type

Returns: string

}

Implements TimezoneInterface.

Definition at line 142 of file Timezone.php.

     {
         return (new \IntlDateFormatter(
             $this->_localeResolver->getLocale(),
             \IntlDateFormatter::NONE,
             $type
         ))->getPattern();
     }

◆ isScopeDateInInterval()

isScopeDateInInterval	(	$scope,
		$dateFrom = `null`,
		$dateTo = `null`
	)

{Checks if current date of the given scope (in the scope timezone) is within the range

Parameters

int \| string \| \Magento\Framework\App\ScopeInterface	$scope
string \| null	$dateFrom
string \| null	$dateTo

Returns: bool

}

Implements TimezoneInterface.

Definition at line 236 of file Timezone.php.

     {
         if (!$scope instanceof ScopeInterface) {
             $scope = $this->_scopeResolver->getScope($scope);
         }
 
         $scopeTimeStamp = $this->scopeTimeStamp($scope);
         $fromTimeStamp = strtotime($dateFrom);
         $toTimeStamp = strtotime($dateTo);
         if ($dateTo) {
             // fix date YYYY-MM-DD 00:00:00 to YYYY-MM-DD 23:59:59
             $toTimeStamp += 86400;
         }
 
         $result = false;
         if (!$this->_dateTime->isEmptyDate($dateFrom) && $scopeTimeStamp < $fromTimeStamp) {
         } elseif (!$this->_dateTime->isEmptyDate($dateTo) && $scopeTimeStamp > $toTimeStamp) {
         } else {
             $result = true;
         }
         return $result;
     }

◆ scopeDate()

scopeDate	(	$scope = `null`,
		$date = `null`,
		$includeTime = `false`
	)

{Create \DateTime object with date converted to scope timezone and scope Locale

Parameters

mixed	$scope	Information about scope
string \| integer \| \DateTime \| array \| null	$date	date in UTC
boolean	$includeTime	flag for including time to date

Returns: \DateTime

}

Implements TimezoneInterface.

Definition at line 196 of file Timezone.php.

     {
         $timezone = $this->_scopeConfig->getValue($this->getDefaultTimezonePath(), $this->_scopeType, $scope);
         $date = new \DateTime(is_numeric($date) ? '@' . $date : $date, new \DateTimeZone($timezone));
         if (!$includeTime) {
             $date->setTime(0, 0, 0);
         }
         return $date;
     }

◆ scopeTimeStamp()

scopeTimeStamp ( $scope = null )

{Get scope timestamp Timestamp will be built with scope timezone settings

Parameters

mixed $scope

Returns: int

}

Implements TimezoneInterface.

Definition at line 223 of file Timezone.php.

     {
         $timezone = $this->_scopeConfig->getValue($this->getDefaultTimezonePath(), $this->_scopeType, $scope);
         $currentTimezone = @date_default_timezone_get();
         @date_default_timezone_set($timezone);
         $date = date('Y-m-d H:i:s');
         @date_default_timezone_set($currentTimezone);
         return strtotime($date);
     }

Field Documentation

◆ $_allowedFormats

$_allowedFormats

protected

Initial value:

= [
        \IntlDateFormatter::FULL,
        \IntlDateFormatter::LONG,
        \IntlDateFormatter::MEDIUM,
        \IntlDateFormatter::SHORT,
    ]

Definition at line 26 of file Timezone.php.

◆ $_dateTime

$_dateTime

protected

Definition at line 46 of file Timezone.php.

◆ $_defaultTimezonePath

$_defaultTimezonePath

protected

Definition at line 51 of file Timezone.php.

◆ $_localeResolver

$_localeResolver

protected

Definition at line 61 of file Timezone.php.

◆ $_scopeConfig

$_scopeConfig

protected

Definition at line 56 of file Timezone.php.

◆ $_scopeResolver

$_scopeResolver

protected

Definition at line 41 of file Timezone.php.

◆ $_scopeType

$_scopeType

protected

Definition at line 36 of file Timezone.php.

The documentation for this class was generated from the following file:

vendor/magento/framework/Stdlib/DateTime/Timezone.php

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ convertConfigTimeToUtc()

◆ date()

◆ formatDate()

◆ formatDateTime()

◆ getConfigTimezone()

◆ getDateFormat()

◆ getDateFormatWithLongYear()

◆ getDateTimeFormat()

◆ getDefaultTimezone()

◆ getDefaultTimezonePath()

◆ getTimeFormat()

◆ isScopeDateInInterval()

◆ scopeDate()

◆ scopeTimeStamp()

Field Documentation

◆ $_allowedFormats

◆ $_dateTime

◆ $_defaultTimezonePath

◆ $_localeResolver

◆ $_scopeConfig

◆ $_scopeResolver

◆ $_scopeType