Класс 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 имеет значение true и debug имеет значение true, или 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 Ложное значение предотвратит обработку пути как плагина
• 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 Ложное значение предотвратит обработку пути как плагина 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 Ложное значение предотвратит обработку пути как плагина 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

Экземпляр 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 для диалоговых окон подтверждения.

Параметры

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

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

Параметры

string|array $key

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

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

Параметры

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

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

mixed $default необязательно null

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

Возвращает

mixed
Значение считываемой конфигурации.

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

Параметры

string|array $key

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

mixed|null $value необязательно null

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

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

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

Возвращает

$this

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

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