Класс UrlHelper

_encodeUrl()source protected

_encodeUrl( string $url )

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

Параметры

строка $url

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

Возвращает

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

_inflectThemeName()source protected

_inflectThemeName( string $name )

Изменяет имя темы на подчеркнутое.

Параметры

строка $name

Имя темы, которое должно быть изменено.

Возвращает

строка
Изменённое имя темы

assetTimestamp()source public

assetTimestamp( string $path )

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

Параметры

строка $path

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

Возвращает

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

assetUrl()source public

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

Генерирует URL для заданного файла ресурса.

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

Параметры

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

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

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

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

Возвращает

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

build()source public

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

Возвращает URL на основе предоставленных параметров.

Параметры

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

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

boolean $full необязательно false

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

Возвращает

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

css()source public

css( string|array $path , array $options [] )

Генерирует URL для заданного файла CSS.

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

Параметры

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

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

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

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

Возвращает

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

image()source public

image( string|array $path , array $options [] )

Генерирует URL для заданного файла изображения.

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

Параметры

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

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

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

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

Возвращает

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

implementedEvents()source public

implementedEvents( )

Обработчики событий.

Возвращает

массив

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

Cake\View\Helper::implementedEvents()

script()source public

script( string|array $path , array $options [] )

Генерирует URL для заданного файла javascript.

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

Параметры

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

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

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

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

Возвращает

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

webroot()source public

webroot( string $file )

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

Параметры

строка $file

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

Возвращает

строка
Доступный по веб-протоколу путь к файлу.

__call()source public

__call( string $method , array $params )

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

Параметры

строка $method

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

массив $params

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

__construct()source public

__construct( Cake\View\View $View , array $config [] )

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

Параметры

Cake\View\View $View

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

массив $config необязательно []

Настройки конфигурации помощника.

__debugInfo()source public

__debugInfo( )

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

Возвращает

массив

__get()source public

__get( string $name )

Ленично загружает помощников.

Параметры

строка $name

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

Возвращает

Cake\View\Helper|null
Экземпляр помощника, если помощник с заданным именем существует

_confirm()source protected

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

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

Параметры

строка $message

Сообщение, которое должно быть отображено

строка $okCode

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

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

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

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

Массив опций

Возвращает

строка
JS код onclick

addClass()source public

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

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

Параметры

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

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

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

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

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

Ключ, используемый для класса.

Возвращает

массив
Массив опций со свойством $key.

initialize()source public

initialize( array $config )

Метод-обработчик конструктора.

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

Параметры

массив $config

Настройки конфигурации, предоставленные данному помощнику.

_configDelete()source protected

_configDelete( string $key )

Удаление одного ключа конфигурации

Параметры

строка $key

Ключ для удаления.

Исключение

Cake\Core\Exception\Exception
при попытке перезаписи существующей конфигурации

_configRead()source protected

_configRead( string|null $key )

Чтение переменной конфигурации

Параметры

строка|null $key

Ключ для чтения.

Возвращает

смешанный

_configWrite()source protected

_configWrite( string|array $key , mixed $value , boolean|string $merge false )

Запись переменной конфигурации

Параметры

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

Ключ для записи.

смешанный $value

Значение для записи.

boolean|строка $merge необязательно false

Истина для рекурсивного слияния, 'shallow' для простого слияния, ложь для перезаписи, по умолчанию ложь.

Исключение

Cake\Core\Exception\Exception
при попытке перезаписи существующей конфигурации

config()source public

config( string|array|null $key null , mixed|null $value null , boolean $merge true )

Использование

Чтение всей конфигурации:

$this->config();

Чтение определенного значения:

$this->config('key');

Чтение вложенного значения:

$this->config('some.nested.key');

Установка определенного значения:

$this->config('key', $value);

Установка вложенного значения:

$this->config('some.nested.key', $value);

Обновление нескольких параметров конфигурации одновременно:

$this->config(['one' => 'value', 'another' => 'value']);

Параметры

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

Ключ для получения/установки или полный массив конфигураций.

смешанный|null $value необязательно null

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

boolean $merge необязательно true

Необходимо ли рекурсивно сливать или перезаписывать существующую конфигурацию, по умолчанию истина.

Возвращает

смешанный
Значение конфигурации, которое читается, или сам объект при операциях записи.

Исключение

Cake\Core\Exception\Exception
При попытке установить недопустимый ключ.

configShallow()source public

configShallow( string|array $key , mixed|null $value null )

Объединение предоставленной конфигурации с существующей. В отличие от config(), которая выполняет рекурсивное объединение для вложенных ключей, этот метод выполняет простое объединение.

Установка определенного значения:

$this->config('key', $value);

Установка вложенного значения:

$this->config('some.nested.key', $value);

Обновление нескольких параметров конфигурации одновременно:

$this->config(['one' => 'value', 'another' => 'value']);

Параметры

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

Ключ для установки, или полный массив конфигураций.

смешанный|null $value необязательно null

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

Возвращает

$this Объект самого себя.