Класс UrlHelper

_encodeUrlисходный код защищённый

_encodeUrl( string $url )

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

Параметры

строка $url

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

Возвращает

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

_inflectThemeNameисходный код защищённый

_inflectThemeName( string $name )

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

Параметры

строка $name

Имя темы, которое нужно преобразовать.

Возвращает

string
Преобразованное имя темы

assetTimestampисходный код публичный

assetTimestamp( string $path )

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

Параметры

строка $path

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

Возвращает

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

assetUrlисходный код публичный

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

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

Параметры

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

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

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

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

Возвращает

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

buildисходный код публичный

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

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

Параметры

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

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

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

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

Возвращает

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

implementedEventsисходный код публичный

implementedEvents( )

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

Возвращает

array
массив

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

Cake\View\Helper::implementedEvents()

webrootисходный код публичный

webroot( string $file )

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

Параметры

строка $file

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

Возвращает

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

__callисходный код публичный

__call( string $method , array $params )

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

Параметры

строка $method

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

массив $params

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

__constructисходный код публичный

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

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

Параметры

Cake\View\View $View

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

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

Параметры конфигурации для помощника.

__debugInfoисходный код публичный

__debugInfo( )

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

Возвращает

array
массив

__getисходный код публичный

__get( string $name )

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

Параметры

строка $name

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

Возвращает

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

_confirmисходный код защищённый

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

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

Параметры

строка $message

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

строка $okCode

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

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

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

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

Массив опций

Возвращает

string
JS-код onclick

addClassисходный код публичный

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

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

Параметры

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

Массив опций/атрибутов для добавления класса

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

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

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

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

Возвращает

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

_configDeleteисходный код защищённый

_configDelete( string $key )

Удаляет отдельный ключ конфигурации.

Параметры

строка $key

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

Исключения

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

_configReadисходный код защищённый

_configRead( string|null $key )

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

Параметры

строка|null $key

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

Возвращает

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

_configWritesource protected

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

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

Параметры

string|array $key

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

mixed $value

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

boolean|string $merge необязательно false

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

Исключения

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

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

Параметры

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

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

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

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

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

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

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

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

Исключения

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

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

Параметры

string|array $key

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

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

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

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

mixed
$this Сам объект.

[]

[]

[]

[]

null

null

[]

null

[]

false