Граф наследования:Date:

Открытые члены
	__construct ($date=null, $format=null)

	format ($format)
	Formats date value to string. Подробнее...

	__clone ()
	Produces the copy of the object. Подробнее...

	add ($interval)
	Performs dates arithmetic. Подробнее...

	setDate ($year, $month, $day)
	Sets the current date of the DateTime object to a different date. Подробнее...

	getTimestamp ()
	Returns Unix timestamp from date. Подробнее...

	getDiff (DateTime $time)
	Returns difference between dates. Подробнее...

	toString (Context\Culture $culture=null)
	Converts a date to the string. Подробнее...

	__toString ()
	Converts a date to the string with default culture format setting. Подробнее...

Открытые статические члены
static	getFormat (Context\Culture $culture=null)
	Returns a date format from the culture in the php format. Подробнее...

static	convertFormatToPhp ($format)
	Converts date format from culture to php format. Подробнее...

static	isCorrect ($time, $format=null)
	Checks the string for correct date (by trying to create Date object). Подробнее...

static	createFromPhp (\DateTime $datetime)
	Creates Date object from PHP \DateTime object. Подробнее...

static	createFromTimestamp ($timestamp)
	Creates Date object from Unix timestamp. Подробнее...

static	createFromText ($text)
	Creates Date object from Text (return array of result object) Examples: "end of next week", "tomorrow morning", "friday 25.10". Подробнее...

Защищенные статические члены
static	getCultureFormat (Context\Culture $culture)
	Returns short date culture format. Подробнее...

Защищенные данные
	$value

Подробное описание

См. определение в файле main/lib/type/date.php строка 7

Конструктор(ы)

◆ __construct()

__construct	(	$date = `null`,
		$format = `null`
	)

Аргументы

string	$date	String representation of date.
string	$format	PHP date format. If not specified, the format is got from the current culture.

Исключения

Main

См. определение в файле main/lib/type/date.php строка 18

     {
         $this->value = new \DateTime();
         if ($date !== null && $date !== "")
         {
             if ($format === null)
             {
                 $format = static::getFormat();
             }
  
             $parsedValue = date_parse_from_format($format, $date);
             //Ignore errors when format is longer than date
             //or date string is longer than format
             if ($parsedValue['error_count'] > 1)
             {
                 if (
                     current($parsedValue['errors']) !== 'Trailing data'
                     && current($parsedValue['errors']) !== 'Data missing'
                 )
                 {
                     throw new Main\ObjectException("Incorrect date: ".$date);
                 }
             }
  
             $this->value->setDate($parsedValue['year'], $parsedValue['month'], $parsedValue['day']);
  
             if (
                 isset($parsedValue["relative"])
                 && isset($parsedValue["relative"]["second"])
                 && $parsedValue["relative"]["second"] != 0
             )
             {
                 $this->value->add(new \DateInterval("PT".$parsedValue["relative"]["second"]."S"));
             }
         }
         $this->value->setTime(0, 0, 0);
     }

Методы

◆ __clone()

__clone ( )

Produces the copy of the object.

Возвращает: void

См. определение в файле main/lib/type/date.php строка 73

     {
         $this->value = clone $this->value;
     }

◆ __toString()

__toString ( )

Converts a date to the string with default culture format setting.

Возвращает: string

См. определение в файле main/lib/type/date.php строка 202

     {
         return $this->toString();
     }

◆ add()

add ( $interval )

Performs dates arithmetic.

Each duration period is represented by an integer value followed by a period designator. If the duration contains time elements, that portion of the specification is preceded by the letter T. Period Designators: Y - years, M - months, D - days, W - weeks, H - hours, M - minutes, S - seconds. Examples: two days - 2D, two seconds - T2S, six years and five minutes - 6YT5M. The unit types must be entered from the largest scale unit on the left to the smallest scale unit on the right. Use first "-" char for negative periods. OR Relative period. Examples: "+5 weeks", "12 day", "-7 weekdays", '3 months - 5 days'

Аргументы

string $interval Time interval to add.

Возвращает: $this

См. определение в файле main/lib/type/date.php строка 98

     {
         $i = $this->tryToCreateIntervalByDesignators($interval);
         if ($i == null)
         {
             $i = \DateInterval::createFromDateString($interval);
         }
  
         $this->value->add($i);
  
         return $this;
     }

◆ convertFormatToPhp()

static convertFormatToPhp ( $format )

static

Converts date format from culture to php format.

Аргументы

string $format Format string.

Возвращает: mixed

См. определение в файле main/lib/type/date.php строка 252

     {
         static $from = array(
             "YYYY", // 1999
             "MMMM", // January - December
             "MM", // 01 - 12
             "DD", // 01 - 31
             "TT", // AM - PM
             "T", // am - pm
             "MI", // 00 - 59
             "SS", // 00 - 59
         );
         static $to = array(
             "Y", // 1999
             "F", // January - December
             "m", // 01 - 12
             "d", // 01 - 31
             "A", // AM - PM
             "a", // am - pm
             "i", // 00 - 59
             "s", // 00 - 59
         );
  
         $format = str_replace($from, $to, $format);
  
         $tempFormat = $format;
         $format = str_replace("HH", "H", $format); // 00 - 24
         if ($tempFormat === $format)
         {
             $format = str_replace("H", "h", $format); // 01 - 12
         }
  
         $tempFormat = $format;
         $format = str_replace("GG", "G", $format); // 0 - 24
         if ($tempFormat === $format)
         {
             $format = str_replace("G", "g", $format); // 1 - 12
         }
  
         return $format;
     }

◆ createFromPhp()

static createFromPhp ( \DateTime $datetime )

static

Creates Date object from PHP \DateTime object.

Аргументы

\DateTime $datetime Source object.

Возвращает: static

Переопределяется в DateTime.

См. определение в файле main/lib/type/date.php строка 330

     {
         /** @var Date $d */
         $d = new static();
         $d->value = clone $datetime;
         $d->value->setTime(0, 0, 0);
         return $d;
     }

◆ createFromText()

static createFromText ( $text )

static

Creates Date object from Text (return array of result object) Examples: "end of next week", "tomorrow morning", "friday 25.10".

Аргументы

string $text

Возвращает: \Bitrix\Main\Type\DateTime|null

См. определение в файле main/lib/type/date.php строка 362

     {
         $result = Main\Text\DateConverter::decode($text);
         if (empty($result))
         {
             return null;
         }
         
         return $result[0]->getDate();
     }

◆ createFromTimestamp()

static createFromTimestamp ( $timestamp )

static

Creates Date object from Unix timestamp.

Аргументы

int $timestamp Source timestamp.

Возвращает: static

Переопределяется в DateTime.

См. определение в файле main/lib/type/date.php строка 346

     {
         /** @var Date $d */
         $d = new static();
         $d->value->setTimestamp($timestamp);
         $d->value->setTime(0, 0, 0);
         return $d;
     }

◆ format()

format ( $format )

Formats date value to string.

Аргументы

string $format PHP date format.

Возвращает: string

См. определение в файле main/lib/type/date.php строка 63

     {
         return $this->value->format($format);
     }

◆ getCultureFormat()

static getCultureFormat ( Context\Culture $culture )

staticprotected

Returns short date culture format.

Аргументы

Context\Culture $culture Culture.

Возвращает: string

Переопределяется в DateTime.

См. определение в файле main/lib/type/date.php строка 240

     {
         return $culture->getDateFormat();
     }

◆ getDiff()

getDiff ( DateTime $time )

Returns difference between dates.

Аргументы

DateTime $time

Возвращает: \DateInterval

См. определение в файле main/lib/type/date.php строка 179

     {
         return $this->value->diff($time->value);
     }

◆ getFormat()

static getFormat ( Context\Culture $culture = null )

static

Returns a date format from the culture in the php format.

Аргументы

Context\Culture $culture Optional culture.

Возвращает: string

См. определение в файле main/lib/type/date.php строка 214

     {
         static $defaultCulture = null;
  
         if($culture === null)
         {
             if($defaultCulture === null)
             {
                 $context = Context::getCurrent();
                 $defaultCulture = $context->getCulture();
             }
             $culture = $defaultCulture;
         }
  
         $format = static::getCultureFormat($culture);
  
         return static::convertFormatToPhp($format);
     }

◆ getTimestamp()

getTimestamp ( )

Returns Unix timestamp from date.

Возвращает: int

См. определение в файле main/lib/type/date.php строка 168

     {
         return $this->value->getTimestamp();
     }

◆ isCorrect()

static isCorrect	(	$time,
		$format = `null`
	)

static

Checks the string for correct date (by trying to create Date object).

Аргументы

string	$time	String representation of date.
string	$format	PHP date format. If not specified, the format is got from the current culture.

Возвращает: bool

См. определение в файле main/lib/type/date.php строка 302

     {
         if (empty($time))
         {
             return false;
         }
  
         $result = true;
  
         try
         {
             new static($time, $format);
         }
         catch (Main\ObjectException $ex)
         {
             $result = false;
         }
  
         return $result;
     }

◆ setDate()

setDate	(	$year,
		$month,
		$day
	)

Sets the current date of the DateTime object to a different date.

Аргументы

int	$year
int	$month
int	$day

Возвращает: $this

См. определение в файле main/lib/type/date.php строка 119

     {
         $this->value->setDate($year, $month, $day);
  
         return $this;
     }

◆ toString()

toString ( Context\Culture $culture = null )

Converts a date to the string.

Аргументы

Context\Culture $culture Culture contains date format.

Возвращает: string

Переопределяется в DateTime.

См. определение в файле main/lib/type/date.php строка 191

     {
         $format = static::getFormat($culture);
         return $this->format($format);
     }

Поля

◆ $value

$value

protected

См. определение в файле main/lib/type/date.php строка 10

Объявления и описания членов класса находятся в файле:

main/lib/type/date.php

Открытые члены

Открытые статические члены

Защищенные статические члены

Защищенные данные

Подробное описание

Конструктор(ы)

◆ __construct()

Методы

◆ __clone()

◆ __toString()

◆ add()

◆ convertFormatToPhp()

◆ createFromPhp()

◆ createFromText()

◆ createFromTimestamp()

◆ format()

◆ getCultureFormat()

◆ getDiff()

◆ getFormat()

◆ getTimestamp()

◆ isCorrect()

◆ setDate()

◆ toString()

Поля

◆ $value