Spec-Zone.ru › CakePHP 3.1

Класс DashedRoute

Этот класс маршрута прозрачно обрабатывает параметры маршрутизации контроллера, действия и плагина, так что запрос /my-plugin/my-controller/my-action будет разобран как ['plugin' => 'MyPlugin', 'controller' => 'MyController', 'action' => 'myAction']

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

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

_camelizePluginsource protected

_camelizePlugin( string $plugin )

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

Параметры

строка $plugin
Имя плагина

Возвращает

string
строка

_dasherizesource protected

_dasherize( array $url )

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

Параметры

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

Возвращает

array
массив

matchsource public

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

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

Параметры

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

Возвращает

boolean|string
Либо ложь, либо строка URL.

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

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

parsesource public

parse( string $url )

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

Параметры

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

Возвращает

array|false
Массив параметров запроса или ложь при неудаче.

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

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

Методы, унаследованные от 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
логическое значение

_parseArgssource protected

_parseArgs( string $args , string $context )

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

Возвращает true, если заданное именованное значение параметра $val соответствует заданному правилу $rule в зависимости от $context. В настоящее время реализованы типы правил контроллер, действие и совпадение, которые могут комбинироваться друг с другом.

Параметры

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

Возвращает

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
логическое значение

extensionssource public

extensions( null|string|array $extensions null )

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

Параметры

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

Возвращает

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

getNamesource public

getName( )

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

Возвращает

string
строка

staticPathsource public

staticPath( )

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

Возвращает

string
строка

Резюме свойств

$_inflectedDefaultssource

protected логическое значение

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

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

false

Наследуемые свойства от Cake\Routing\Route\Route

$_compiledRoutesource

protected строка

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

null

$_extensionssource

protected массив

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

[]

$_greedysource

protected строка

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

false

$_namesource

protected строка

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

null

$defaultssource

public массив

Значения параметров по умолчанию для маршрута

[]

$keyssource

public массив

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

[]

$optionssource

public массив

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

[]

$templatesource

public строка

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

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.DashedRoute.html

Spec-Zone.ru

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