Класс UrlHelper

_encodeUrl()source protected

_encodeUrl( string $url )

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

Параметры

строка $url

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

Возвращает

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

_inflectThemeName()source protected

_inflectThemeName( string $name )

Привести имя темы к нижнему подчеркиванию.

Параметры

string $name

Имя темы, которое нужно привести к нижнему подчеркиванию.

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

string
Имя темы в формате нижнего подчеркивания

assetTimestamp()source public

assetTimestamp( string $path )

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

Параметры

string $path

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

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

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

assetUrl()source public

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

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

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

Параметры

string|array $path

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

array $options optional []

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

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

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

build()source public

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

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

Опции:

• escape: Если false, URL будет возвращён без экранирования, используйте только если он будет экранирован вручную перед отображением.
• fullBase: Если true, к результату будет добавлен полный базовый URL

Параметры

string|array|null $url optional null

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

array|boolean $options optional false

Массив опций; bool full для совместимости.

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

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

css()source public

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

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

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

Параметры

string|array $path

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

array $options optional []

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

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

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

image()source public

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

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

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

Параметры

string|array $path

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

array $options optional []

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

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

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

implementedEvents()source public

implementedEvents( )

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

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

array

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

Cake\View\Helper::implementedEvents()

script()source public

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

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

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

Параметры

string|array $path

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

array $options optional []

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

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

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

webroot()source public

webroot( string $file )

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

Параметры

string $file

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

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

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

__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

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

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

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

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

Массив опций

Возвращает

строка
код JS onclick

addClass()source public

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

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

Параметры

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

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

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

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

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

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

Возвращает

массив
Массив опций со значением $key.

getView()source public

getView( )

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

Возвращает

Cake\View\View
Экземпляр привязанного представления.

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

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

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

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

Выбрасывает

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']);

Устарело

3.4.0 используйте setConfig()/getConfig() вместо.

Параметры

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

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

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

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

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

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

Возвращает

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

Выбрасывает

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

configShallow()source public

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

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

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

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

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

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

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

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

Параметры

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

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

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

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

Возвращает

$this

getConfig()source public

getConfig( string|null $key null , mixed $default null )

Возвращает конфигурацию.

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

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

$this->getConfig();

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

$this->getConfig('key');

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

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

Чтение со значением по умолчанию:

$this->getConfig('some-key', 'default-value');

Параметры

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

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

смешанное $default необязательно null

Значение возврата, когда ключ не существует.

Возвращает

смешанное
Значение конфигурации, которое читается.

setConfig()source public

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

Устанавливает конфигурацию.

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

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

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

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

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

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

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

Параметры

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

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

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

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

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

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

Возвращает

$this

Выбрасывает

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