Класс NumberHelper

__callsource public

__call( string $method , array $params )

Вызов методов из класса утилиты CakeNumber

Параметры

string $method

Метод для вызова.

array $params

Параметры для передачи методу.

Возвращает

mixed
Результат вызываемого метода или false при ошибке

Переопределяет

Helper::__call()

__constructsource public

__construct( View $View , array $settings array() )

Конструктор по умолчанию

Настройки:

• engine Имя класса, используемого для замены функциональности CakeNumber. Класс должен быть размещён в Utility каталоге.

Параметры

View $View

Вид, к которому подключается помощник.

array $settings необязательно array()

Настройки помощника

Исключения

CakeException
Возникает, если не удалось найти класс движка.

Переопределяет

Helper::__construct()

addFormatsource public

addFormat( string $formatName , array $options )

Добавление формата валюты в помощник Number. Упрощает повторное использование форматов валют.

$this->Number->addFormat('NOK', array('before' => 'Kr. '));

Теперь вы можете использовать NOK в качестве сокращенного обозначения при форматировании сумм валют.

$this->Number->currency($value, 'NOK');

Добавленные форматы объединяются со значениями по умолчанию, определенными в Cake\Utility\Number::$_currencyDefaults. Смотрите Cake\Utility\Number::currency() для получения дополнительной информации о различных параметрах и их функциях.

Параметры

string $formatName

Имя формата, которое будет использоваться в будущем.

array $options

Массив параметров для этого формата.

См. также

CakeNumber::addFormat()

Ссылка

http://book.cakephp.org/2.0/ru/core-libraries/helpers/number.html#NumberHelper::addFormat

currencysource public

currency( float $number , string $currency null , array $options array() )

Форматирует число в формате валюты.

Параметры

float $number

Число для форматирования.

string $currency необязательно null

Сокращение для параметров по умолчанию. Допустимые значения: 'USD', 'EUR', 'GBP', в противном случае задайте как минимум параметры 'before' и 'after'. 'USD' — валюта по умолчанию, используйте CakeNumber::defaultCurrency() для изменения этого значения по умолчанию.

array $options необязательно array()

Список параметров.

Возвращает

string
Число, отформатированное как валюта.

См. также

CakeNumber::currency()

Ссылка

http://book.cakephp.org/2.0/ru/core-libraries/helpers/number.html#NumberHelper::currency

defaultCurrencysource public

defaultCurrency( string $currency )

Геттер/сеттер для валюты по умолчанию

Параметры

string $currency

Валюта, которая будет использоваться в дальнейшем.

Возвращает

string
Валюта

См. также

CakeNumber::defaultCurrency()

formatsource public

format( float $number , integer $options false )

Форматирует число в формате валюты.

Параметры

float $number

Число с плавающей точкой

integer $options необязательно false

Если целое число, то количество знаков после запятой, если строка, то перед запятой, если (,.-), то использовать или массив с ключами places и before

Возвращает

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

См. также

CakeNumber::format()

Ссылка

http://book.cakephp.org/2.0/ru/core-libraries/helpers/number.html#NumberHelper::format

precisionsource public

precision( float $number , integer $precision 3 )

Форматирует число с заданной точностью.

Параметры

float $number

Число с плавающей точкой.

integer $precision необязательно 3

Точность возвращаемого числа.

Возвращает

float
Отформатированное число с плавающей точкой.

См. также

CakeNumber::precision()

Ссылка

http://book.cakephp.org/2.0/ru/core-libraries/helpers/number.html#NumberHelper::precision

toPercentagesource public

toPercentage( float $number , integer $precision 2 , array $options array() )

Форматирует число в строку процентов.

Параметры:

• multiply: Умножает входное значение на 100 для десятичных процентов.

Параметры

float $number

Число с плавающей точкой

integer $precision необязательно 2

Точность возвращаемого числа

array $options необязательно array()

Параметры

Возвращает

string
Строка процентов

См. также

CakeNumber::toPercentage()

Ссылка

http://book.cakephp.org/2.0/ru/core-libraries/helpers/number.html#NumberHelper::toPercentage

toReadableSizesource public

toReadableSize( integer $size )

Возвращает размер файла в удобном для восприятия формате.

Параметры

integer $size

Размер в байтах

Возвращает

string
Размер в удобном для восприятия формате

См. также

CakeNumber::toReadableSize()

Ссылка

http://book.cakephp.org/2.0/ru/core-libraries/helpers/number.html#NumberHelper::toReadableSize

__getsource public

__get( string $name )

Ленивая загрузка помощников. Также предоставляет доступ к устаревшим свойствам запроса.

Устарело

3.0.0 Доступ к свойствам запроса через этот метод устарел и будет удален в версии 3.0.

Параметры

string $name

Имя свойства, к которому осуществляется доступ.

Возвращает

mixed
Помощник или свойство, найденное по имени $name

__setsource public

__set( string $name , mixed $value )

Обеспечивает обратную совместимость для установки значений в объект запроса.

Устарело

3.0.0 Этот метод будет удален в версии 3.0

Параметры

string $name

Имя свойства, к которому осуществляется доступ.

mixed $value

Значение для установки.

_cleansource protected

_clean( )

Удаляет вредный контент из вывода

_confirmsource protected

_confirm( string $message , string $okCode , string $cancelCode '' , array $options array() )

Возвращает строку, используемую в качестве обработчика onclick для диалогов подтверждения.

Параметры

строка $message

Сообщение, отображаемое в диалоге

строка $okCode

Код, который выполняется после выбора пользователем 'OK'

строка $cancelCode необязательно ''

Код, который выполняется после выбора пользователем 'Отмена'

массив $options необязательно array()

Массив параметров

Возвращает

string
JS-код onclick

_encodeUrlsource protected

_encodeUrl( string $url )

Кодирует URL для использования в атрибутах HTML.

Параметры

строка $url

URL для кодирования.

Возвращает

string
URL, закодированный для контекстов URL и HTML.

_formatAttributesource protected

_formatAttribute( string $key , string $value , boolean $escape true )

Форматирует отдельный атрибут и возвращает строковое значение составленного атрибута. Работает с миниатюрными атрибутами, которые имеют такое же значение, как и их имя, например, 'disabled' и 'checked'.

Устарело

3.0.0 Этот метод будет перемещен в HtmlHelper в версии 3.0

Параметры

строка $key

Имя атрибута для создания

строка $value

Значение атрибута для создания.

логическое значение $escape необязательно true

Определяет, должно ли значение быть экранировано

Возвращает

string
Составленный атрибут.

_initInputFieldsource protected

_initInputField( string $field , array $options array() )

Устанавливает значения по умолчанию для тега input. Установит атрибуты name, value и id для массива атрибутов HTML.

Параметры

строка $field

Имя поля для инициализации.

массив $options необязательно array()

Массив параметров для использования при инициализации поля ввода.

Возвращает

array
Массив параметров для поля формы.

_namesource protected

_name( array|string $options array() , string $field null , string $key 'name' )

Получает имя поля ввода для текущего тега. Создает атрибуты имени input с использованием формата CakePHP data[Model][field].

Параметры

массив|строка $options необязательно array()

Если массив, должен быть массивом атрибутов, к которым необходимо добавить $key. Если строка или null, будет использоваться сущность View.

строка $field необязательно null

Имя поля.

строка $key необязательно 'name'

Имя атрибута, который нужно установить, по умолчанию 'name'

Возвращает

mixed
Если для $options был передан массив, возвращается массив с заданным $key. Если была передана строка, возвращается строка.

_parseAttributessource protected

_parseAttributes( array $options , array $exclude null , string $insertBefore ' ' , string $insertAfter null )

Возвращает строку с элементами массива $options, разделенными пробелом. Если ключ массива $options совпадает с одним из перечисленных в Helper::$_minimizedAttributes,

и его значение равно:

• '1' (строка)
• 1 (целое число)
• true (логическое значение)
• 'true' (строка)

то значение будет перезаписано, чтобы быть идентичным имени ключа. Если значение не равно ни одному из этих 3 значений, параметр не выводится.

'escape' — специальный параметр, который управляет преобразованием атрибутов в их эквиваленты, закодированные в HTML-сущностях. Установите его в false, чтобы отключить кодирование HTML.

Если значение для любого ключа параметра установлено в null или false, этот параметр будет исключен из вывода.

Устарело

3.0.0 Этот метод будет перемещен в HtmlHelper в версии 3.0

Параметры

массив $options

Массив параметров.

массив $exclude необязательно null

Массив параметров, которые нужно исключить, эти параметры не будут частью результата.

строка $insertBefore необязательно ' '

Строка, которая должна быть вставлена перед параметрами.

строка $insertAfter необязательно null

Строка, которая должна быть вставлена после параметров.

Возвращает

string
Составленные атрибуты.

_resetsource protected

_reset( )

Сбрасывает переменные, используемые Helper::clean(), в null

_selectedArraysource protected

_selectedArray( string|array $data , string $key 'id' )

Преобразует набор записей из ассоциации hasAndBelongsToMany в список выбранных параметров для элемента множественного выбора.

Параметры

строка|массив $data

Массив данных или имя модели.

строка $key необязательно 'id'

Имя поля.

Возвращает

array
массив

addClasssource public

addClass( array $options array() , string $class null , string $key 'class' )

Добавляет заданный класс к параметрам элемента.

Параметры

массив $options необязательно array()

Массив параметров/атрибутов для добавления класса к ним

строка $class необязательно null

Имя добавляемого класса.

строка $key необязательно 'class'

Ключ для использования класса.

Возвращает

array
Массив параметров с установленным $key.

afterLayoutsource public

afterLayout( string $layoutFile )

Обратный вызов после макета. afterLayout вызывается после отрисовки макета.

Переопределяется в подклассах.

Параметры

строка $layoutFile

Файл макета, который был отрисован.

afterRendersource public

afterRender( string $viewFile )

Обратный вызов после отрисовки. afterRender вызывается после отрисовки файла представления, но перед отрисовкой макета.

Переопределяется в подклассах.

Параметры

строка $viewFile

Файл представления, который был отрисован.

afterRenderFilesource public

afterRenderFile( string $viewFile , string $content )

Обратный вызов после отрисовки файла. Вызывается после отрисовки любого фрагмента представления.

Переопределяется в подклассах.

Параметры

строка $viewFile

Файл, который только что был отрисован.

строка $content

Содержимое, которое было отрисовано.

assetTimestampsource public

assetTimestamp( string $path )

Добавляет отметку времени к файловому ресурсу на основе значения Asset.timestamp в Configure. Если Asset.timestamp равен true и debug > 0, или Asset.timestamp равен 'force', будет добавлена метка времени.

Параметры

строка $path

Путь к файлу, к которому нужно добавить отметку времени, путь должен находиться внутри WWW_ROOT

Возвращает

string
Путь с добавленной отметкой времени или без неё.

assetUrlsource public

assetUrl( string|array $path , array $options array() )

Генерирует URL для указанного файла ресурса. В зависимости от переданных параметров предоставляет полный URL с именем домена. Также вызывает Helper::assetTimestamp() для добавления отметки времени к локальным файлам.

Параметры

строка|массив $path

Строка пути или массив URL

массив $options необязательно array()

Массив параметров. Возможные ключи: fullBase Возвращает полный URL с именем домена pathPrefix Префикс пути для относительных URL ext Расширение ресурса для добавления plugin Значение False предотвратит обработку пути как плагина

Возвращает

string
Сгенерированный URL

beforeLayoutsource public

beforeLayout( string $layoutFile )

Обратный вызов перед макетом. beforeLayout вызывается перед отрисовкой макета.

Переопределяется в подклассах.

Параметры

строка $layoutFile

Макет, который собирается отрисоваться.

beforeRendersource public

beforeRender( string $viewFile )

Обратный вызов перед отрисовкой. beforeRender вызывается перед отрисовкой файла представления.

Переопределяется в подклассах.

Параметры

строка $viewFile

Файл представления, который будет отрисован

beforeRenderFilesource public

beforeRenderFile( string $viewFile )

Обратный вызов перед отрисовкой файла. Вызывается перед отрисовкой любого фрагмента представления.

Переопределяется в подклассах.

Параметры

строка $viewFile

Файл, который собирается отрисоваться.

cleansource public

clean( string|array $output )

Используется для удаления вредных тегов из содержимого. Удаляет ряд известных атак XSS из содержимого. Однако, не гарантирует удаления всех возможных атак. Лучшим способом предотвращения всех возможных атак является экранирование содержимого.

Устарело

3.0.0 Этот метод будет удален в 3.0

Параметры

строка|массив $output

Либо массив строк для очистки, либо одна строка для очистки.

Возвращает

string|array|null
Очищенное содержимое для вывода

domIdsource public

domId( array|string $options null , string $id 'id' )

Генерирует идентификатор DOM для выбранного элемента, если он не задан. Использует текущие настройки View::entity() для генерации идентификатора с использованием верблюжьего случая.

Параметры

массив|строка $options необязательно null

Либо массив html атрибутов, в который добавить $id, либо строка с путем к сущности представления для получения domId.

строка $id необязательно 'id'

Имя атрибута 'id'.

Возвращает

mixed
Если $options был массивом, будет возвращён массив с установленным $id. Если была передана строка, будет возвращена строка.

entitysource public

entity( )

Возвращает ссылку на сущность текущего контекста в виде массива элементов идентификации.

Возвращает

array
Массив, содержащий элементы идентификации сущности

fieldsource public

field( )

Возвращает текущее поле модели контекста отрисовки. Удаляет постфиксы полей, такие как год, месяц, день, час, мин, меридиан, когда текущая сущность содержит более 2 элементов.

Возвращает

string
строка

modelsource public

model( )

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

Возвращает

string
строка

outputsource public

output( string $str )

Возвращает строку, сгенерированную методом помощника.

Этот метод может быть переопределен в подклассах для обобщённой обработки вывода после отрисовки.

Устарело

3.0.0 Этот метод будет удален в будущих версиях.

Параметры

строка $str

Строка для вывода.

Возвращает

string
строка

setEntitysource public

setEntity( string $entity , boolean $setScope false )

Устанавливает свойства модели и поля помощника на пары значений, разделённые точкой, в $entity.

Параметры

строка $entity

Имя поля, например, "ModelName.fieldName" или "ModelName.ID.fieldName"

логическое $setScope необязательно false

Устанавливает область представления для модели, указанной в $tagValue

urlsource public

url( string|array $url null , boolean $full false )

Находит URL для указанного действия.

Возвращает URL, указывающий на заданные параметры.

Параметры

строка|массив $url необязательно null

Либо относительный URL, например, /products/view/23 , либо массив параметров URL. Использование массива для URL позволит вам использовать функции обратного маршрутизирования CakePHP.

логическое $full необязательно false

Если true, полный базовый URL будет добавлен к результату

Возвращает

string
Полный переведённый URL с базовым путём.

Ссылка

http://book.cakephp.org/2.0/ru/views/helpers.html

valuesource public

value( array|string $options array() , string $field null , string $key 'value' )

Получает данные для текущего тега.

Параметры

массив|строка $options необязательно array()

Если массив, должен быть массивом атрибутов, к которым нужно добавить $key. Если строка или null, будет использоваться как сущность представления.

строка $field необязательно null

Имя поля.

строка $key необязательно 'value'

Имя атрибута, который нужно установить, по умолчанию 'value'

Возвращает

mixed
Если для $options был передан массив, будет возвращён массив с установленным $key. Если была передана строка, будет возвращена строка.

webrootsource public

webroot( string $file )

Проверяет наличие файла, когда используется тема. Если файл не найден, возвращается расположение по умолчанию.

Параметры

строка $file

Файл, для которого нужно получить путь webroot.

Возвращает

string
Веб-доступный путь к файлу.

_mergeVarssource protected

_mergeVars( array $properties , string $class , boolean $normalize true )

Объединяет $property этого объекта со свойством в определении $class. Значение этого объекта для свойства будет объединённо поверх значения $class.

Это обеспечивает часть магии DRY, предоставляемой CakePHP. Если вы хотите отключить её, переопределите этот метод как пустую функцию.

Параметры

массив $properties

Имя свойств для объединения.

строка $class

Класс для объединения свойства.

логическое $normalize необязательно true

Установите в true, чтобы выполнить нормализацию свойств с помощью Hash::normalize() перед объединением.

_setsource protected

_set( array $properties array() )

Разрешает установку нескольких свойств объекта в одной строке кода. Будет устанавливать только свойства, которые являются частью объявления класса.

Параметры

массив $properties необязательно array()

Ассоциативный массив, содержащий свойства и соответствующие значения.

_stopsource protected

_stop( integer|string $status 0 )

Остановить выполнение текущего скрипта. Обёртка exit(), что упрощает тестирование.

Параметры

целое число|строка $status необязательно 0

см. http://php.net/exit для значений

dispatchMethodsource public

dispatchMethod( string $method , array $params array() )

Вызывает метод этого объекта с заданными параметрами. Предоставляет оболочку ООП для call_user_func_array

Параметры

string $method

Имя вызываемого метода

array $params необязательно array()

Список параметров для вызова $method

Возвращает

mixed
Результат вызова метода

logsource public

log( string $msg , integer $type LOG_ERR , null|string|array $scope null )

Удобный метод для записи сообщения в CakeLog. Для получения более подробной информации о записи в лог, обратитесь к CakeLog::write().

Параметры

string $msg

Сообщение для лога

integer $type необязательно LOG_ERR

Константа типа ошибки. Определена в app/Config/core.php.

null|string|array $scope необязательно null

Область(и), в которой создаётся сообщение для лога. Более подробную информацию о областях ведения логов см. в CakeLog::config().

Возвращает

boolean
Успех записи в лог

requestActionsource public

requestAction( string|array $url , array $extra array() )

Вызывает метод контроллера из любой точки. Может быть использован для связи контроллеров или интеграции плагинов в основное приложение. requestAction может использоваться для возвращения отрисованных представлений или получения возвращаемого значения действий контроллера.

Под капотом этот метод использует Router::reverse() для преобразования параметра $url в строковый URL. Вы должны использовать форматы URL, совместимые с Router::reverse().

Передача данных POST и GET

Данные POST и GET могут быть смоделированы в requestAction. Используйте $extra['url'] для данных GET. Параметр $extra['data'] позволяет моделировать данные POST.

Параметры

string|array $url

URL в виде строки или массива. В отличие от других массивов URL в CakePHP, этот URL не будет автоматически обрабатывать переданные и именованные аргументы в параметре $url.

array $extra необязательно array()

Если массив содержит ключ "return", он устанавливает AutoRender в значение true. Также может быть использован для отправки данных GET/POST, а также именованных/переданных аргументов.

Возвращает

mixed
Булево значение true или false при успехе/неуспехе, или содержимое отрисованного действия, если в $extra задан ключ 'return'

toStringsource public

toString( )

Преобразование объекта в строку. Каждый класс может переопределять этот метод по необходимости.

Возвращает

string
Имя класса

null

'%s="%s"'

null

array(
    'year', 'month', 'day', 'hour', 'min', 'second', 'meridian'
)

array()

'%s="%s"'

array(
    'allowfullscreen',
    'async',
    'autofocus',
    'autoplay',
    'checked',
    'compact',
    'controls',
    'declare',
    'default',
    'defaultchecked',
    'defaultmuted',
    'defaultselected',
    'defer',
    'disabled',
    'enabled',
    'formnovalidate',
    'hidden',
    'indeterminate',
    'inert',
    'ismap',
    'itemscope',
    'loop',
    'multiple',
    'muted',
    'nohref',
    'noresize',
    'noshade',
    'novalidate',
    'nowrap',
    'open',
    'pauseonexit',
    'readonly',
    'required',
    'reversed',
    'scoped',
    'seamless',
    'selected',
    'sortable',
    'spellcheck',
    'truespeed',
    'typemustmatch',
    'visible'
)

null

array()

array()

null

null

array()

array()

null