Spec-Zone.ru › CakePHP 4.2

Класс Asset

Класс для генерации URL-адресов ресурсов.

Пространство имён: Cake\Routing

Краткое описание свойств

  • $inflectionType protected static
    string

    Тип склонения.

Краткое описание методов

  • assetTimestamp() public static

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

  • cssUrl() public static

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

  • encodeUrl() protected static

    Кодирует части URL с использованием rawurlencode().

  • imageUrl() public static

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

  • inflectString() protected static

    Склоняет имя темы/плагина к типу, установленного с помощью Asset::setInflectionType().

  • pluginSplit() protected static

    Разделяет имя плагина в формате с точкой на его имя плагина и имя файла. Если в $name нет точки, то индекс 0 будет null. Проверяет, загружен ли плагин, иначе имя файла останется неизменным для имён файлов, содержащих точку.

  • requestWebroot() protected static

    Получение webroot из запроса.

  • scriptUrl() public static

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

  • setInflectionType() public static

    Устанавливает тип склонения для использования при склонении имени плагина/темы.

  • url() public static

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

  • webroot() public static

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

Подробное описание методов

assetTimestamp() public static 

assetTimestamp(string $path, bool|string $timestamp = null): string

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

Параметры

string $path

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

bool|string $timestamp optional

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

Возвращает

string

cssUrl() public static 

cssUrl(string $path, array $options = []): string

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

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

Параметры

string $path

Строка пути.

array $options optional

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

Возвращает

string

encodeUrl() protected static 

encodeUrl(string $url): string

Кодирует части URL с помощью rawurlencode().

Параметры

string $url

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

Возвращает

string

imageUrl() public static 

imageUrl(string $path, array $options = []): string

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

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

Параметры

string $path

Строка пути.

array $options optional

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

Возвращает

string

inflectString() protected static 

inflectString(string $string): string

Изменяет имя темы/плагина на тип, используя Asset::setInflectionType().

Параметры

string $string

Строка, подлежащая изменению.

Возвращает

string

pluginSplit() protected static 

pluginSplit(string $name): array

Разделяет имя плагина в формате «точка» на плагин и имя файла. Если в $name нет точки, то индекс 0 будет null. Проверяет, загружен ли плагин, иначе имя файла останется неизменным для имён файлов, содержащих точку.

Параметры

string $name

Имя плагина для разделения.

Возвращает

array

requestWebroot() protected static 

requestWebroot(): string

Получение webroot из запроса.

Возвращает

string

scriptUrl() public static 

scriptUrl(string $path, array $options = []): string

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

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

Параметры

string $path

Строка пути.

array $options optional

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

Возвращает

string

setInflectionType() public static 

setInflectionType(string $inflectionType): void

Устанавливает тип склонения для использования при склонении имени плагина/темы.

Параметры

string $inflectionType

Тип склонения. Значение должно быть допустимым именем метода класса Inflector , например 'dasherize' или 'underscore.

Возвращает

void

url() public static 

url(string $path, array $options = []): string

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

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

Опции:

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

Параметры

string $path

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

array $options optional

Массив опций.

Возвращает

string

webroot() public static 

webroot(string $file, array $options = []): string

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

Опции:

  • theme Необязательное имя темы

Параметры

string $file

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

array $options optional

Массив опций.

Возвращает

string

Подробное описание свойств

$inflectionType protected static

Тип склонения.

Тип

string

© 2005–present The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/4.2/class-Cake.Routing.Asset.html

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API