DateTime Class Reference

Public Member Functions
	__construct (TimezoneInterface $localeDate)
	calculateOffset ($timezone=null)
	gmtDate ($format=null, $input=null)
	date ($format=null, $input=null)
	gmtTimestamp ($input=null)
	timestamp ($input=null)
	getGmtOffset ($type='seconds')

Protected Attributes
	$_localeDate

Detailed Description

Date conversion model

@api

Since

100.0.2

Definition at line 15 of file DateTime.php.

Constructor & Destructor Documentation

__construct()

__construct

(

TimezoneInterface

$localeDate

)

Parameters

TimezoneInterface

$localeDate

Definition at line 32 of file DateTime.php.

    {
        $this->_localeDate = $localeDate;
        $this->_offset = $this->calculateOffset($this->_localeDate->getConfigTimezone());
    }

Member Function Documentation

calculateOffset()

calculateOffset

(

$timezone = null

)

Calculates timezone offset

Parameters

string | null

$timezone

Returns

int offset between timezone and gmt

Definition at line 44 of file DateTime.php.

    {
        $result = true;
        $offset = 0;
        if ($timezone !== null) {
            $oldZone = @date_default_timezone_get();
            $result = date_default_timezone_set($timezone);
        }
        if ($result === true) {
            $offset = (int)date('Z');
        }
        if ($timezone !== null) {
            date_default_timezone_set($oldZone);
        }
        return $offset;
    }

date()

date	(		$format = null,
			$input = null
	)

Converts input date into date with timezone offset Input date must be in GMT timezone

Parameters

string	$format
int | string	$input	date in GMT timezone

Returns

string

Definition at line 89 of file DateTime.php.

    {
        if ($format === null) {
            $format = 'Y-m-d H:i:s';
        }
        $result = date($format, $this->timestamp($input));
        return $result;
    }

getGmtOffset()

getGmtOffset

(

$type = 'seconds'

)

Get current timezone offset in seconds/minutes/hours

Parameters

string

$type

Returns

int

Definition at line 159 of file DateTime.php.

    {
        $result = $this->_offset;
        switch ($type) {
            case 'seconds':
            default:
                break;
            case 'minutes':
                $result = $result / 60;
                break;
            case 'hours':
                $result = $result / 60 / 60;
                break;
        }
        return $result;
    }

gmtDate()

gmtDate	(		$format = null,
			$input = null
	)

Forms GMT date

Parameters

string	$format
int | string	$input	date in current timezone

Returns

string

Definition at line 68 of file DateTime.php.

    {
        if ($format === null) {
            $format = 'Y-m-d H:i:s';
        }
        $date = $this->gmtTimestamp($input);
        if ($date === false) {
            return false;
        }
        $result = date($format, $date);
        return $result;
    }

gmtTimestamp()

gmtTimestamp

(

$input = null

)

Forms GMT timestamp

Parameters

int | string | \DateTimeInterface

$input

date in current timezone

Returns

int

Definition at line 104 of file DateTime.php.

    {
        if ($input === null) {
            return (int)gmdate('U');
        } elseif (is_numeric($input)) {
            $result = $input;
        } elseif ($input instanceof \DateTimeInterface) {
            $result = $input->getTimestamp();
        } else {
            $result = strtotime($input);
        }
        if ($result === false) {
            // strtotime() unable to parse string (it's not a date or has incorrect format)
            return false;
        }
        $date = $this->_localeDate->date($result);
        $timestamp = $date->getTimestamp();
        unset($date);
        return $timestamp;
    }

timestamp()

timestamp

(

$input = null

)

Converts input date into timestamp with timezone offset Input date must be in GMT timezone

Parameters

int | string

$input

date in GMT timezone

Returns

int

Definition at line 132 of file DateTime.php.

    {
        switch (true) {
            case ($input === null):
                $result = $this->gmtTimestamp();
                break;
            case (is_numeric($input)):
                $result = $input;
                break;
            case ($input instanceof \DateTimeInterface):
                $result = $input->getTimestamp();
                break;
            default:
                $result = strtotime($input);
        }

        $date = $this->_localeDate->date($result);

        return $date->getTimestamp();
    }

Field Documentation

$_localeDate

$_localeDate

protected

Definition at line 27 of file DateTime.php.

---

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

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