Класс NumberHelper

__call()исходный код public

__call( string $method , array $params )

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

Параметры

строка $method

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

массив $params

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

Возвращает

смешанный тип
Результат вызываемого метода или false в случае неудачи

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

Helper::__call()

__construct()исходный код public

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

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

Настройки:

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

Параметры

View $View

Представление, к которому прикреплён помощник.

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

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

Вызывает исключения

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

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

Helper::__construct()

addFormat()исходный код public

addFormat( string $formatName , array $options )

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

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

You can now use `NOK` as a shortform when formatting currency amounts.

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

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

Параметры

строка $formatName

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

массив $options

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

См. также

CakeNumber::addFormat()

Ссылка

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

currency()исходный код public

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

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

Параметры

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

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

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

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

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

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

Возвращает

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

См. также

CakeNumber::currency()

Ссылка

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

defaultCurrency()исходный код public

defaultCurrency( string $currency )

Получение/установка значения по умолчанию для валюты

Параметры

строка $currency

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

Возвращает

строка
Валюта

См. также

CakeNumber::defaultCurrency()

format()исходный код public

format( float $number , integer $options false )

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

Параметры

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

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

целое число $options необязательно false

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

Возвращает

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

См. также

CakeNumber::format()

Ссылка

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

precision()исходный код public

precision( float $number , integer $precision 3 )

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

Параметры

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

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

целое число $precision необязательно 3

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

Возвращает

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

См. также

CakeNumber::precision()

Ссылка

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

toPercentage()исходный код public

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

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

Параметры:

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

Параметры

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

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

целое число $precision необязательно 2

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

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

Параметры

Возвращает

строка
Процентное значение в виде строки

См. также

CakeNumber::toPercentage()

Ссылка

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

toReadableSize()source public

toReadableSize( integer $size )

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

Параметры

целое число $size

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

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

строка
Размер, удобочитаемый для человека

См. также

CakeNumber::toReadableSize()

Ссылка

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

__get()source public

__get( string $name )

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

Устарело

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

Параметры

строка $name

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

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

смешанный тип
Хелпер или свойство, найденное по имени $name

__set()source public

__set( string $name , mixed $value )

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

Устарело

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

Параметры

строка $name

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

смешанный тип $value

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

_clean()source protected

_clean( )

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

_confirm()source protected

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

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

Параметры

строка $message

Сообщение для отображения

строка $okCode

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

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

Код, который будет выполнен после выбора пользователем «Отмена», также выполняется, когда okCode не возвращает значение

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

Массив опций

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

строка
JS-код onclick

_encodeUrl()source protected

_encodeUrl( string $url )

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

Параметры

строка $url

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

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

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

_formatAttribute()source protected

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

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

Устарело

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

Параметры

строка $key

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

строка $value

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

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

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

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

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

_initInputField()source protected

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

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

Параметры

строка $field

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

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

Массив опций, используемых при инициализации поля ввода.

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

массив
Массив опций для элемента формы ввода.

_name()source protected

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

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

Параметры

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

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

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

Имя поля.

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

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

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

смешанный тип

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

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

Строка, которая будет вставлена после опций.

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

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

_reset()source protected

_reset( )

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

_selectedArray()source protected

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

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

Параметры

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

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

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

Имя поля.

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

массив

addClass()source public

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

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

Параметры

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

Массив опций/атрибутов, к которым необходимо добавить класс

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

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

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

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

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

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

afterLayout()source public

afterLayout( string $layoutFile )

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

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

Параметры

строка $layoutFile

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

afterRender()source public

afterRender( string $viewFile )

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

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

Параметры

строка $viewFile

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

afterRenderFile()source public

afterRenderFile( string $viewFile , string $content )

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

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

Параметры

строка $viewFile

Файл, который только что был отрендерен.

строка $content

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

assetTimestamp()source public

assetTimestamp( string $path )

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

Параметры

строка $path

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

Возвращает

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

assetUrl()source public

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

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

Параметры

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

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

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

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

Возвращает

строка
Сгенерированный URL

beforeLayout()source public

beforeLayout( string $layoutFile )

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

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

Параметры

строка $layoutFile

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

beforeRender()source public

beforeRender( string $viewFile )

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

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

Параметры

строка $viewFile

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

beforeRenderFile()source public

beforeRenderFile( string $viewFile )

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

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

Параметры

строка $viewFile

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

clean()source public

clean( string|array $output )

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

Устарело

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

Параметры

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

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

Возвращает

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

domId()source public

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

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

Параметры

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

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

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

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

Возвращает

смешанный

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

entity()source public

entity( )

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

Возвращает

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

field()source public

field( )

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

Возвращает

строка

model()source public

model( )

Получает текущую используемую модель контекста рендеринга.

Возвращает

строка

output()source public

output( string $str )

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

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

Устарело

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

Параметры

строка $str

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

Возвращает

строка

setEntity()source public

setEntity( string $entity , boolean $setScope false )

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

Параметры

строка $entity

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

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

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

url()source public

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

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

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

Параметры

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

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

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

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

Возвращает

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

Ссылка

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

value()source public

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

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

Параметры

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

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

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

Имя поля.

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

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

Возвращает

смешанный

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

webroot()source public

webroot( string $file )

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

Параметры

строка $file

Файл, для которого требуется получить путь webroot.

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

строка
Путь к файлу, доступный через веб.

_mergeVars()source protected

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

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

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

Параметры

массив $properties

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

строка $class

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

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

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

_set()source protected

_set( array $properties array() )

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

Параметры

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

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

_stop()source protected

_stop( integer|string $status 0 )

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

Параметры

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

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

dispatchMethod()source public

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

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

Параметры

строка $method

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

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

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

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

смешанный
Возвращает результат вызова метода

log()source public

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

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

Параметры

строка $msg

Сообщение журнала

целое число $type необязательно LOG_ERR

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

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

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

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

логическое значение
Успех записи в журнал

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

Параметры

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

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

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

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

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

смешанный

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

toString()source public

toString( )

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

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

строка
Название данного класса

null