Класс 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 , boolean|string $timestamp = null )

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

Параметры

строка $path

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

логическое значение или строка $timestamp необязательно null

Если задано, переопределяет значение Asset.timestamp в Configure.

Возвращает

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

assetUrl()source public

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

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

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

Параметры:

• fullBase Логическое значение true или строка (например, https://example) для возвращения полного URL с протоколом и доменным именем.
• pathPrefix Префикс пути для относительных URL
• ext Расширение ресурса для добавления
• plugin Значение False предотвратит обработку пути как плагина
• timestamp Переопределяет значение Asset.timestamp в Configure. Установите в false, чтобы пропустить генерацию отметки времени. Установите в true, чтобы применять отметки времени, когда debug равен true. Установите в 'force', чтобы всегда включать отметку времени независимо от значения debug.

Параметры

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

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

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

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

Возвращает

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

build()source public

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

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

Параметры:

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

Параметры

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

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

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

Массив параметров; логическое значение full для совместимости с предыдущими версиями.

Возвращает

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

css()source public

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

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

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

Параметры

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

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

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

Массив параметров. Возможные ключи: fullBase Возвращает полный URL с доменным именем pathPrefix Префикс пути для относительных URL ext Расширение ресурса для добавления plugin Значение False предотвратит обработку пути как плагина timestamp Переопределяет значение Asset.timestamp в Configure. Установите в false, чтобы пропустить генерацию отметки времени. Установите в true, чтобы применять отметки времени, когда debug равен true. Установите в 'force', чтобы всегда включать отметку времени независимо от значения debug.

Возвращает

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

image()source public

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

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

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

Параметры

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

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

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

Массив параметров. Возможные ключи: fullBase Возвращает полный URL с доменным именем pathPrefix Префикс пути для относительных URL plugin Значение False предотвратит обработку пути как плагина timestamp Переопределяет значение Asset.timestamp в Configure. Установите в false, чтобы пропустить генерацию отметки времени. Установите в true, чтобы применять отметки времени, когда debug равен true. Установите в 'force', чтобы всегда включать отметку времени независимо от значения debug.

Возвращает

строка
Сгенерированный 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 Ложное значение предотвратит разбор пути как плагина timestamp Перезаписывает значение Asset.timestamp в Configure. Установите в false, чтобы пропустить генерацию отметки времени. Установите в true, чтобы применять отметки времени, когда debug = true. Установите в 'force', чтобы всегда включить отметку времени, независимо от значения debug.

Возвращает

строка
Сгенерированный 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
Экземпляр помощника, если помощник с указанным именем существует

__set()source public

__set( string $name , mixed $value )

Магический сеттер для удаленных свойств.

Параметры

строка $name

Имя свойства.

смешанный $value

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

_cleanConfirmMessage()source protected

_cleanConfirmMessage( string $message )

Возвращает строку, готовую для использования в confirm()

Параметры

строка $message

Сообщение для очистки

Возвращает

смешанный

_confirm()source protected

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

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

Параметры

строка $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

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

boolean|строка $merge дополнительно false

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

Выбрасывает

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

config()source public deprecated

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

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

boolean $merge дополнительно true

Выполнять ли рекурсивное слияние или перезаписывать существующую конфигурацию, по умолчанию 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

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

Возвращает

смешанное
Данные конфигурации по указанному ключу или 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

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

Возвращает

$this

Исключения

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