Spec-Zone.ru › CakePHP 3.1

Класс PluginShortRoute

Короткая ссылка плагина, копирующая параметр плагина в параметры контроллера. Используется для поддержки маршрутов /:plugin.

Cake\Routing\Route\Route
Extended by Cake\Routing\Route\InflectedRoute
Extended by Cake\Routing\Route\PluginShortRoute
Пространство имен: Cake\Routing\Route
Расположение Routing/Route/PluginShortRoute.php

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

matchsource public

match( array $url , array $context [] )

Обрабатывает обратные ссылки на сокращенные адреса плагина. Если плагин и контроллер не совпадают, совпадение автоматически не проходит.

Параметры

массив $url
Массив параметров для преобразования в строку.
массив $context необязательно []
Массив текущего контекста запроса. Содержит информацию, такую как текущий хост, схему, порт и базовый каталог.

Возвращает

string|false
Строковый URL для параметров, если они совпадают, или false.

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

Cake\Routing\Route\InflectedRoute::match()

parsesource public

parse( string $url )

Разбирает строковый URL в массив. Если найден ключ плагина, он будет скопирован в параметр контроллера.

Параметры

строка $url
URL для разбора

Возвращает

array|false
Массив параметров запроса или логическое значение false при ошибке.

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

Cake\Routing\Route\InflectedRoute::parse()

Методы, унаследованные от Cake\Routing\Route\InflectedRoute

_underscoresource protected

_underscore( array $url )

Вспомогательный метод для подчеркивания ключей в массиве URL.

Параметры

массив $url
Массив ключей URL.

Возвращает

array
массив

Методы, унаследованные от Cake\Routing\Route\Route

__constructsource public

__construct( string $template , array|string $defaults [] , array $options [] )

Конструктор маршрута.

Параметры

  • _ext — Определяет расширения, используемые для этого маршрута.
  • pass — Копирует указанные параметры в params['pass'].

Параметры

строка $template
Шаблонная строка с заглушками параметров
массив|строка $defaults необязательно []
Значения по умолчанию для маршрута.
массив $options необязательно []
Массив дополнительных параметров для маршрута.

__set_statesource public static

__set_state( array $fields )

Магический метод установки состояния для поддержки var_export

Этот метод помогает приложениям, которые хотят реализовать кэширование маршрутизатора.

Параметры

массив $fields
Ключ/значение атрибутов объекта

Возвращает

Cake\Routing\Route\Route
Новый экземпляр маршрута

_matchMethodsource protected

_matchMethod( array $url )

Проверка соответствия HTTP-метода URL.

Параметры

массив $url
Массив для генерируемого URL.

Возвращает

boolean
bool

_parseArgssource protected

_parseArgs( string $args , string $context )

Разбор переданных параметров в список переданных аргументов.

Возвращает true, если заданное имя $param's $val соответствует заданному $rule в зависимости от $context. В настоящее время реализованы типы правил: controller, action и match, которые можно комбинировать друг с другом.

Параметры

строка $args
Строка с переданными параметрами. Например, /1/foo
строка $context
Текущий контекст маршрута, который должен содержать ключи controller/action.

Возвращает

array
Массив переданных аргументов.

_parseExtensionsource protected

_parseExtension( string $url )

Удаляет расширение из $url, если он содержит зарегистрированное расширение. Если зарегистрированное расширение не найдено, расширение не возвращается, и URL возвращается без изменений.

Параметры

строка $url
URL для разбора.

Возвращает

array
содержащий URL, расширение

_persistParamssource protected

_persistParams( array $url , array $params )

Применение постоянных параметров к массиву URL. Постоянные параметры — это специальный ключ, используемый при создании маршрута, для принудительного сохранения параметров маршрута, если они опущены из массива URL.

Параметры

массив $url
Массив, к которому применяются постоянные параметры.
массив $params
Массив постоянных значений для замены постоянных.

Возвращает

array
Массив с применёнными постоянными параметрами.

_writeRoutesource protected

_writeRoute( )

Создание регулярного выражения маршрута.

Использует свойства template, defaults и options для компиляции регулярного выражения, которое может использоваться для разбора строк запросов.

_writeUrlsource protected

_writeUrl( array $params , array $pass [] , array $query [] )

Преобразование массива сопоставленного маршрута в строку URL.

Составление строкового URL с использованием шаблона, используемого для создания маршрута.

Параметры

массив $params
Параметры для преобразования в строковый URL.
массив $pass необязательно []
Дополнительные переданные аргументы.
массив $query необязательно []
Массив параметров.

Возвращает

string
Сформированная строка маршрута.

compilesource public

compile( )

Компиляция регулярного выражения маршрута.

Изменяет свойство defaults, чтобы установить все необходимые ключи, и заполняет $this->names именованными элементами маршрутизации.

Возвращает

array
Возвращает строковое регулярное выражение скомпилированного маршрута.

compiledsource public

compiled( )

Проверка, был ли маршрут скомпилирован в регулярное выражение.

Возвращает

boolean
bool

extensionssource public

extensions( null|string|array $extensions null )

Получение/установка поддерживаемых расширений для этого маршрута.

Параметры

null|строка|массив $extensions необязательно null
Расширения для установки. Используйте null для получения.

Возвращает

array|null
Расширения или null.

getNamesource public

getName( )

Получение стандартизованного имени plugin.controller:action для маршрута.

Возвращает

string
строка

staticPathsource public

staticPath( )

Получение статической части пути для этого маршрута.

Возвращает

string
строка
END_OF_DOCUMENT_MARKER

Свойства, унаследованные от Cake\Routing\Route\InflectedRoute

$_inflectedDefaultssource

protected boolean

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

Значения по умолчанию должны быть приведены к соответствию правилам склонения, чтобы они совпадали со склонениями, которые создаст метод match().

false

Свойства, унаследованные от Cake\Routing\Route\Route

$_compiledRoutesource

protected string

Скомпилированное регулярное выражение маршрута.

null

$_extensionssource

protected array

Список подключенных расширений для данного маршрута.

[]

$_greedysource

protected string

Является ли этот маршрут жадным маршрутом? Жадные маршруты содержат /* в своей шаблоне.

false

$_namesource

protected string

Имя маршрута. Получить с помощью Route::getName();

null

$defaultssource

public array

Параметры по умолчанию для маршрута.

[]

$keyssource

public array

Массив именованных сегментов в маршруте. /:controller/:action/:id содержит 3 ключевых элемента.

[]

$optionssource

public array

Массив дополнительных параметров для маршрута.

[]

$templatesource

public string

Строка шаблона маршрута.

null

© 2005–2016 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.
http://api.cakephp.org/3.1/class-Cake.Routing.Route.PluginShortRoute.html

Spec-Zone.ru

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