Spec-Zone.ru › Symfony 3.0

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)

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

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()

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

string getTimeType()

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

string getTimeZoneId()

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

mixed getTimeZone()

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

bool isLenient()

Возвращает, является ли форматер строгим.

string localtime(string $value, int $position)

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

string 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.
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

string getTimeType()

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

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

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

См. также

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 был обработан, $parsepos будет содержать -1, иначе - позицию, на которой разбор был завершен. Если $parsepos > strlen($value), разбор сразу завершается с ошибкой.

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

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

Исключения

MethodNotImplementedException

См. также

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

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

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

Параметры

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

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

string Разбор в виде временной метки

Исключения

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)

Установка строгости разбора.

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

Параметры

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.0/Symfony/Component/Intl/DateFormatter/IntlDateFormatter.html

Spec-Zone.ru

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