Spec-Zone.ru › Symfony 3.4

IntlDateFormatter

class IntlDateFormatter

Замена нативный класса PHP {@link \IntlDateFormatter}.

В настоящее время в этом классе поддерживаются только следующие методы:

  • {@link __construct}
  • {@link create}
  • {@link format}
  • {@link getCalendar}
  • {@link getDateType}
  • {@link getErrorCode}
  • {@link getErrorMessage}
  • {@link getLocale}
  • {@link getPattern}
  • {@link getTimeType}
  • {@link getTimeZoneId}
  • {@link isLenient}
  • {@link parse}
  • {@link setLenient}
  • {@link setPattern}
  • {@link setTimeZoneId}
  • {@link setTimeZone}

Константы

NONE
FULL
LONG
MEDIUM
SHORT
TRADITIONAL
GREGORIAN

Методы

__construct(string $locale, int $datetype, int $timetype, mixed $timezone = null, int $calendar = self::GREGORIAN, string $pattern = null)
static IntlDateFormatter create(string $locale, int $datetype, int $timetype, string $timezone = null, int $calendar = self::GREGORIAN, string $pattern = null)

Статический конструктор.

string|bool format(int|DateTime $timestamp)

Форматирование значения даты/времени (timestamp) в строку.

string formatObject(object $object, mixed $format = null, string $locale = null)

Не поддерживается. Форматирует объект.

int getCalendar()

Возвращает календарь форматировщика.

object getCalendarObject()

Не поддерживается. Возвращает объект календаря форматировщика.

int getDateType()

Возвращает тип даты форматировщика.

int getErrorCode()

Возвращает последний код ошибки форматировщика. Всегда возвращает значение константы UZEROERROR.

string getErrorMessage()

Возвращает последнее сообщение об ошибке форматировщика. Всегда возвращает значение константы UZEROERROR_MESSAGE.

string getLocale(int $type = Locale::ACTUAL_LOCALE)

Возвращает локаль форматировщика.

string getPattern()

Возвращает шаблон форматировщика.

int getTimeType()

Возвращает тип времени форматировщика.

string getTimeZoneId()

Возвращает идентификатор часового пояса форматировщика.

mixed getTimeZone()

Не поддерживается. Возвращает часовой пояс форматировщика.

bool isLenient()

Возвращает, является ли форматировщик снисходительным.

string localtime(string $value, int $position)

Не поддерживается. Разбирает строку в значение времени на основе полей.

int parse(string $value, int $position = null)

Разбирает строку в значение отметки времени.

bool setCalendar(string $calendar)

Не поддерживается. Устанавливает календарь форматировщика.

bool setLenient(bool $lenient)

Устанавливает снисходительность анализатора.

bool setPattern(string $pattern)

Устанавливает шаблон форматировщика.

bool setTimeZoneId(string $timeZoneId)

Устанавливает идентификатор часового пояса форматировщика.

bool setTimeZone(mixed $timeZone)

Этот метод был добавлен в PHP 5.5 как замена для setTimeZoneId().

Подробности

__construct(string $locale, int $datetype, int $timetype, mixed $timezone = null, int $calendar = self::GREGORIAN, string $pattern = null)

Параметры

string $locale Код языка. В настоящее время поддерживается только "en" (или null для использования локального языка по умолчанию, т.е. "en")
int $datetype Тип форматирования даты, одно из констант типов формата
int $timetype Тип форматирования времени, одно из констант типов формата
mixed $timezone Идентификатор часового пояса
int $calendar Календарь для форматирования или парсинга. В настоящее время поддерживается только IntlDateFormatter::GREGORIAN (или null для использования календаря по умолчанию, т.е. "GREGORIAN")
string $pattern Необязательный шаблон для использования при форматировании

Исключения

MethodArgumentValueNotImplementedException Когда $locale отличается от "en" или null
MethodArgumentValueNotImplementedException Когда $calendar отличается от GREGORIAN

См. также

http://www.php.net/manual/en/intldateformatter.create.php
http://userguide.icu-project.org/formatparse/datetime

static IntlDateFormatter create(string $locale, int $datetype, int $timetype, string $timezone = null, int $calendar = self::GREGORIAN, string $pattern = null)

Статический конструктор.

Параметры

string $locale Код языка. В настоящее время поддерживается только "en" (или null для использования локального языка по умолчанию, т.е. "en")
int $datetype Тип форматирования даты, одно из констант типов формата
int $timetype Тип форматирования времени, одно из констант типов формата
string $timezone Идентификатор часового пояса
int $calendar Календарь для форматирования или парсинга; по умолчанию григорианский. Одно из констант календарей
string $pattern Необязательный шаблон для использования при форматировании

Возвращаемое значение

IntlDateFormatter

Исключения

MethodArgumentValueNotImplementedException Когда $locale отличается от "en" или null
MethodArgumentValueNotImplementedException Когда $calendar отличается от GREGORIAN

См. также

http://www.php.net/manual/en/intldateformatter.create.php
http://userguide.icu-project.org/formatparse/datetime

string|bool format(int|DateTime $timestamp)

Форматирование значения даты/времени (метки времени) в строку.

Параметры

int|DateTime $timestamp Метка времени для форматирования

Возвращаемое значение

string|bool Отформатированное значение или false, если форматирование не удалось

Исключения

MethodArgumentValueNotImplementedException Если один из символов форматирования не реализован

См. также

http://www.php.net/manual/en/intldateformatter.format.php

string formatObject(object $object, mixed $format = null, string $locale = null)

Не поддерживается. Форматирует объект.

Параметры

object $object
mixed $format
string $locale

Возвращаемое значение

string Отформатированное значение

Исключения

MethodNotImplementedException

См. также

http://www.php.net/manual/en/intldateformatter.formatobject.php

int getCalendar()

Возвращает календарь форматировщика.

Возвращаемое значение

int Календарь, используемый форматировщиком. В настоящее время всегда возвращает IntlDateFormatter::GREGORIAN.

См. также

http://www.php.net/manual/en/intldateformatter.getcalendar.php

object getCalendarObject()

Не поддерживается. Возвращает объект календаря форматировщика.

Возвращаемое значение

object Объект календаря, используемый форматировщиком

Исключения

MethodNotImplementedException

См. также

http://www.php.net/manual/en/intldateformatter.getcalendarobject.php

int getDateType()

Возвращает тип даты форматировщика.

Возвращаемое значение

int Текущее значение форматировщика

См. также

http://www.php.net/manual/en/intldateformatter.getdatetype.php

int getErrorCode()

Возвращает код последней ошибки форматировщика. Всегда возвращает значение константы класса UZEROERROR.

Возвращаемое значение

int Код ошибки последнего вызова форматировщика

См. также

http://www.php.net/manual/en/intldateformatter.geterrorcode.php

string getErrorMessage()

Возвращает последнее сообщение об ошибке форматировщика. Всегда возвращает значение константы класса UZEROERROR_MESSAGE.

Возвращаемое значение

string Сообщение об ошибке последнего вызова форматировщика

См. также

http://www.php.net/manual/en/intldateformatter.geterrormessage.php

string getLocale(int $type = Locale::ACTUAL_LOCALE)

Возвращает локаль форматировщика.

Параметры

int $type Не поддерживается. Тип имени локали для возврата (Locale::VALIDLOCALE или Locale::ACTUALLOCALE)

Возвращаемое значение

string Локаль, используемая для создания форматировщика. В настоящее время всегда возвращает "en".

См. также

http://www.php.net/manual/en/intldateformatter.getlocale.php

string getPattern()

Возвращает шаблон форматировщика.

Возвращаемое значение

string Строка шаблона, используемая форматировщиком

См. также

http://www.php.net/manual/en/intldateformatter.getpattern.php

int getTimeType()

Возвращает тип времени форматировщика.

Возвращаемое значение

int Тип времени, используемый форматировщиком

См. также

http://www.php.net/manual/en/intldateformatter.gettimetype.php

string getTimeZoneId()

Возвращает идентификатор часового пояса форматировщика.

Возвращаемое значение

string Идентификатор часового пояса, используемый форматировщиком

См. также

http://www.php.net/manual/en/intldateformatter.gettimezoneid.php

mixed getTimeZone()

Не поддерживается. Возвращает часовой пояс форматировщика.

Возвращаемое значение

mixed Часовой пояс, используемый форматировщиком

Исключения

MethodNotImplementedException

См. также

http://www.php.net/manual/en/intldateformatter.gettimezone.php

bool isLenient()

Возвращает, является ли форматировщик снисходительным.

Возвращаемое значение

bool В настоящее время всегда возвращает false

Исключения

MethodNotImplementedException

См. также

http://www.php.net/manual/en/intldateformatter.islenient.php

string localtime(string $value, int $position)

Не поддерживается. Разбор строки в значение времени на основе полей.

Параметры

string $value Строка для преобразования в значение времени
int $position Позиция для начала разбора в $value (нумерация с нуля) Если ошибка не возникает до завершения разбора $value, $parse_pos будет содержать -1, в противном случае — позицию, на которой закончился разбор. Если $parse_pos > strlen($value), разбор завершается немедленно с ошибкой.

Возвращаемое значение

string Массив целых чисел, совместимый с localtime: содержит значение 24-часового формата в поле tm_hour

Исключения

MethodNotImplementedException

См. также

http://www.php.net/manual/en/intldateformatter.localtime.php

int parse(string $value, int $position = null)

Разбор строки в значение временной метки.

Параметры

string $value Строка для преобразования в значение времени
int $position Не поддерживается. Позиция для начала разбора в $value (нумерация с нуля) Если ошибка не возникает до завершения разбора $value, $parse_pos будет содержать -1, в противном случае — позицию, на которой закончился разбор. Если $parse_pos > strlen($value), разбор завершается немедленно с ошибкой.

Возвращаемое значение

int Разборённое значение в формате временной метки

Исключения

MethodArgumentNotImplementedException Когда $position отличается от null, поведение не реализовано

См. также

http://www.php.net/manual/en/intldateformatter.parse.php

bool setCalendar(string $calendar)

Не поддерживается. Установка календаря форматировщика.

Параметры

string $calendar Используемый календарь. По умолчанию IntlDateFormatter::GREGORIAN

Возвращаемое значение

bool true при успехе или false при ошибке

Исключения

MethodNotImplementedException

См. также

http://www.php.net/manual/en/intldateformatter.setcalendar.php

bool setLenient(bool $lenient)

Установка допуска к разбору.

Определяет, является ли разборщик строгим или допускающим неточности при интерпретации входных данных, не точно соответствующих шаблону. Включение допускаемого разбора позволяет разборщику принимать даты или время с ошибками, обрабатывая как можно больше данных для получения значения. Дополнительные пробелы, нераспознанные токены или некорректные значения ("30 февраля") не принимаются.

Параметры

bool $lenient Устанавливает, является ли разборщик допускающим неточности или строгим. В настоящее время поддерживается только false (строгий).

Возвращаемое значение

bool true при успехе или false при ошибке

Исключения

MethodArgumentValueNotImplementedException Когда $lenient равно true

См. также

http://www.php.net/manual/en/intldateformatter.setlenient.php

bool setPattern(string $pattern)

Установить шаблон форматировщика.

Параметры

string $pattern Строка шаблона, соответствующая документации ICU IntlDateFormatter

Возвращаемое значение

bool true при успехе или false при ошибке

См. также

http://www.php.net/manual/en/intldateformatter.setpattern.php
http://userguide.icu-project.org/formatparse/datetime

bool setTimeZoneId(string $timeZoneId)

Установить идентификатор часового пояса форматировщика.

Параметры

string $timeZoneId Строка идентификатора часового пояса. Если NULL или пустая строка, используется по умолчанию для текущей среды выполнения.

Возвращаемое значение

bool true при успехе или false при ошибке

См. также

http://www.php.net/manual/en/intldateformatter.settimezoneid.php

bool setTimeZone(mixed $timeZone)

Этот метод был добавлен в PHP 5.5 как замена setTimeZoneId().

Параметры

mixed $timeZone

Возвращаемое значение

bool true при успехе или false при ошибке

См. также

http://www.php.net/manual/en/intldateformatter.settimezone.php

© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/3.4/Symfony/Component/Intl/DateFormatter/IntlDateFormatter.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API