CLocalizedFormatter
| Пакет | system.utils |
|---|---|
| Наследование | класс CLocalizedFormatter » CFormatter » CApplicationComponent » CComponent |
| Реализует | IApplicationComponent |
| С | 1.1.14 |
| Исходный код | framework/utils/CLocalizedFormatter.php |
CLocalizedFormatter предоставляет набор часто используемых методов форматирования данных, основанных на текущих настройках локалей.
Он предоставляет ту же функциональность, что и CFormatter, но переопределяет все настройки для booleanFormat, datetimeFormat и numberFormat значениями для текущей локали. Из-за этого вы не можете напрямую настраивать эти свойства для CLocalizedFormatter. Формат даты и времени можно настроить, задав dateFormat и timeFormat.
По умолчанию используется CApplication::locale, но вы можете установить пользовательскую локаль, используя метод setLocale.
Список распознаваемых типов форматов и подробности о том, как вызывать методы форматирования, см. в документации CFormatter.
Чтобы заменить компонент приложения 'format', который регистрируется по умолчанию CApplication, вы можете добавить следующее в конфигурацию компонентов приложения:
Он предоставляет ту же функциональность, что и CFormatter, но переопределяет все настройки для booleanFormat, datetimeFormat и numberFormat значениями для текущей локали. Из-за этого вы не можете напрямую настраивать эти свойства для CLocalizedFormatter. Формат даты и времени можно настроить, задав dateFormat и timeFormat.
По умолчанию используется CApplication::locale, но вы можете установить пользовательскую локаль, используя метод setLocale.
Список распознаваемых типов форматов и подробности о том, как вызывать методы форматирования, см. в документации CFormatter.
Чтобы заменить компонент приложения 'format', который регистрируется по умолчанию CApplication, вы можете добавить следующее в конфигурацию компонентов приложения:
'format' => array(
'class' => 'CLocalizedFormatter',
),
Общественные свойства
| Свойство | Тип | Описание | Определено |
|---|---|---|---|
| behaviors | массив | поведения, которые должны быть присоединены к этому компоненту. | CApplicationComponent |
| booleanFormat | массив | текст, отображаемый при форматировании булевого значения. | CFormatter |
| dateFormat | строка | ширина шаблона даты. | CLocalizedFormatter |
| datetimeFormat | строка | строка формата, используемая для форматирования даты и времени с помощью функции PHP date(). | CFormatter |
| htmlPurifier | CHtmlPurifier | экземпляр очистителя HTML | CFormatter |
| htmlPurifierOptions | массив | опции, передаваемые экземпляру CHtmlPurifier, используемому в этом классе. | CFormatter |
| isInitialized | булево | Проверяет, был ли инициирован этот компонент приложения. | CApplicationComponent |
| locale | CLocale | $locale текущая локаль, используемая для форматирования значений | CLocalizedFormatter |
| numberFormat | массив | формат, используемый для форматирования числа с помощью функции PHP number_format(). | CFormatter |
| sizeFormat | массив | формат, используемый для форматирования размера (байты). | CFormatter |
| timeFormat | строка | ширина шаблона времени. | CLocalizedFormatter |
Публичные методы
| Метод | Описание | Определено в |
|---|---|---|
| __call() | Вызывает метод format, когда вызывается его сокращение. | CFormatter |
| __get() | Возвращает значение свойства, список обработчиков событий или поведение на основе его имени. | CComponent |
| __isset() | Проверяет, является ли значение свойства null. | CComponent |
| __set() | Устанавливает значение свойства компонента. | CComponent |
| __unset() | Устанавливает свойство компонента в null. | CComponent |
| asa() | Возвращает объект поведения с указанным именем. | CComponent |
| attachBehavior() | Присоединяет поведение к компоненту. | CComponent |
| attachBehaviors() | Присоединяет список поведений к компоненту. | CComponent |
| attachEventHandler() | Присоединяет обработчик событий к событию. | CComponent |
| canGetProperty() | Определяет, может ли свойство быть прочитано. | CComponent |
| canSetProperty() | Определяет, может ли свойство быть установлено. | CComponent |
| detachBehavior() | Отсоединяет поведение от компонента. | CComponent |
| detachBehaviors() | Отсоединяет все поведения от компонента. | CComponent |
| detachEventHandler() | Отсоединяет существующий обработчик событий. | CComponent |
| disableBehavior() | Отключает присоединенное поведение. | CComponent |
| disableBehaviors() | Отключает все присоединённые к этому компоненту поведения. | CComponent |
| enableBehavior() | Включает присоединённое поведение. | CComponent |
| enableBehaviors() | Включает все присоединённые к этому компоненту поведения. | CComponent |
| evaluateExpression() | Вычисляет PHP выражение или обратный вызов в контексте данного компонента. | CComponent |
| format() | Форматирует значение на основе заданного типа. | CFormatter |
| formatBoolean() | Форматирует значение как логическое. | CLocalizedFormatter |
| formatDate() | Форматирует значение как дату, используя форматировщик дат locale. | CLocalizedFormatter |
| formatDatetime() | Форматирует значение как дату и время, используя форматировщик дат locale. | CLocalizedFormatter |
| formatEmail() | Форматирует значение как ссылку mailto. | CFormatter |
| formatHtml() | Форматирует значение как HTML-текст без кодирования. | CFormatter |
| formatImage() | Форматирует значение как тег изображения. | CFormatter |
| formatNtext() | Форматирует значение как HTML-кодированный обычный текст и преобразует новые строки в HTML <br />. | CFormatter |
| formatNumber() | Форматирует значение как число, используя форматировщик чисел locale. | CLocalizedFormatter |
| formatRaw() | Форматирует значение как есть без форматирования. | CFormatter |
| formatSize() | Форматирует значение в байтах как размер в удобочитаемой форме. | CFormatter |
| formatText() | Форматирует значение как HTML-кодированный обычный текст. | CFormatter |
| formatTime() | Форматирует значение как время, используя форматировщик дат locale. | CLocalizedFormatter |
| formatUrl() | Форматирует значение как гиперссылку. | CFormatter |
| getEventHandlers() | Возвращает список присоединенных обработчиков событий для события. | CComponent |
| getHtmlPurifier() | Возвращает экземпляр HTML-очистителя | CFormatter |
| getIsInitialized() | Проверяет, был ли инициализирован этот компонент приложения. | CApplicationComponent |
| getLocale() | Возвращает $locale - текущий locale, используемый для форматирования значений | CLocalizedFormatter |
| hasEvent() | Определяет, определено ли событие. | CComponent |
| hasEventHandler() | Проверяет, имеются ли присоединенные обработчики для указанного события. | CComponent |
| hasProperty() | Определяет, определено ли свойство. | CComponent |
| init() | Инициализирует компонент приложения. | CApplicationComponent |
| raiseEvent() | Вызывает событие. | CComponent |
| setLocale() | Устанавливает locale для форматирования значений. | CLocalizedFormatter |
Защищенные методы
| Метод | Описание | Определено в |
|---|---|---|
| normalizeDateValue() | Нормализует выражение в виде отметки времени. | CFormatter |
Подробное описание свойств
dateFormat свойство
public string $dateFormat;
ширина шаблона даты. Может быть 'full', 'long', 'medium' и 'short'. По умолчанию 'medium'.
См. также
locale свойство
public CLocale getLocale()
public void setLocale(CLocale|string $locale)
$locale текущий locale, используемый для форматирования значений
timeFormat свойство
public string $timeFormat;
ширина шаблона времени. Может быть 'full', 'long', 'medium' и 'short'. По умолчанию 'medium'.
См. также
Подробное описание методов
formatBoolean() метод
public string formatBoolean(mixed $value) | ||
| $value | смешанный тип | значение для форматирования |
| {return} | строка | результат форматирования |
Исходный код: framework/utils/CLocalizedFormatter.php#79 (показать)
public function formatBoolean($value)
{
return $value ? Yii::t('yii','Yes') : Yii::t('yii','No');
}
Форматирует значение как логическое.
См. также
formatDate() метод
public string formatDate(mixed $value) | ||
| $value | mixed | значение, которое необходимо отформатировать |
| {return} | string | отформатированный результат |
Исходный код: framework/utils/CLocalizedFormatter.php#91 (показать)
public function formatDate($value)
{
return $this->getLocale()->dateFormatter->formatDateTime($this->normalizeDateValue($value), $this->dateFormat, null);
}
Форматирует значение как дату с использованием форматера даты локального языка.
См. также
formatDatetime() метод
public string formatDatetime(mixed $value) | ||
| $value | mixed | значение, которое необходимо отформатировать |
| {return} | string | отформатированный результат |
Исходный код: framework/utils/CLocalizedFormatter.php#116 (показать)
public function formatDatetime($value)
{
return $this->getLocale()->dateFormatter->formatDateTime($this->normalizeDateValue($value), $this->dateFormat, $this->timeFormat);
}
Форматирует значение как дату и время с использованием форматера даты локального языка.
См. также
formatNumber() метод
public string formatNumber(mixed $value) | ||
| $value | mixed | значение, которое необходимо отформатировать |
| {return} | string | отформатированный результат |
Исходный код: framework/utils/CLocalizedFormatter.php#127 (показать)
public function formatNumber($value)
{
return $this->getLocale()->numberFormatter->formatDecimal($value);
}
Форматирует значение как число с использованием форматера чисел локального языка.
См. также
formatTime() метод
public string formatTime(mixed $value) | ||
| $value | mixed | значение, которое необходимо отформатировать |
| {return} | string | отформатированный результат |
Исходный код: framework/utils/CLocalizedFormatter.php#103 (показать)
public function formatTime($value)
{
return $this->getLocale()->dateFormatter->formatDateTime($this->normalizeDateValue($value), null, $this->timeFormat);
}
Форматирует значение как время с использованием форматера даты локального языка.
См. также
getLocale() метод
public CLocale getLocale() | ||
| {return} | CLocale | текущий локальный язык, используемый для форматирования значений |
Исходный код: framework/utils/CLocalizedFormatter.php#65 (показать)
public function getLocale()
{
if($this->_locale === null) {
$this->setLocale(Yii::app()->locale);
}
return $this->_locale;
}
setLocale() метод
public void setLocale(CLocale|string $locale) | ||
| $locale | CLocale|string | экземпляр CLocale или идентификатор локального языка |
Исходный код: framework/utils/CLocalizedFormatter.php#54 (показать)
public function setLocale($locale)
{
if(is_string($locale))
$locale=CLocale::getInstance($locale);
$this->sizeFormat['decimalSeparator']=$locale->getNumberSymbol('decimal');
$this->_locale=$locale;
}
Устанавливает локальный язык для форматирования значений.
© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc/api/1.1/CLocalizedFormatter
