Spec-Zone.ru › Symfony 4.1

IntlDateFormatter

class IntlDateFormatter

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

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

  • {@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

Свойства

protected int $errorCode Код ошибки последней операции.
protected string $errorMessage Сообщение об ошибке последней операции.

Методы

__construct(string|null $locale, int $datetype, int $timetype, mixed $timezone = null, int|null $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()

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

string getErrorMessage()

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

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

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

string getPattern()

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

int getTimeType()

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

string getTimeZoneId()

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

mixed getTimeZone()

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

bool isLenient()

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

string localtime(string $value, int $position = 0)

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

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

DateTime createDateTime(int $timestamp)

Создаёт и возвращает объект DateTime с заданной временной отметкой и текущим часовым поясом.

string getDefaultPattern()

Возвращает строку шаблона на основе значений datetype и timetype.

Подробности

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

Параметры

string|null $locale Код языка. В настоящее время поддерживается только "en" (или null для использования языка по умолчанию, т.е. "en")
int $datetype Тип форматирования даты, один из констант типов форматирования
int $timetype Тип форматирования времени, один из констант типов форматирования
mixed $timezone Идентификатор часового пояса
int|null $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()

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

Значение результата

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

См. также

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

string getErrorMessage()

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

Значение результата

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

См. также

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

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

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

Параметры

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

Значение результата

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 = 0)

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

Параметры

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

protected DateTime createDateTime(int $timestamp)

Создает и возвращает объект DateTime с указанной меткой времени и текущим часовым поясом.

Параметры

int $timestamp

Значение возврата

DateTime

protected string getDefaultPattern()

Возвращает строку шаблона, основанную на значениях datetype и timetype.

Значение возврата

string

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

Spec-Zone.ru

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