Spec-Zone.ru › Symfony 3.2

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

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

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

Устанавливает строгость разбора.

Определяет, будет ли разбор строгим или гибким при интерпретации ввода, не полностью соответствующего шаблону. Включённый гибкий разбор позволяет парсеру принимать неидеальные даты и время, разбирая по возможности как можно больше для получения значения. Дополнительные пробелы, нераспознанные токены или недействительные значения ("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.2/Symfony/Component/Intl/DateFormatter/IntlDateFormatter.html

Spec-Zone.ru

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