Spec-Zone.ru › CakePHP 3.2

Класс InflectedRoute

Этот класс маршрута прозрачно склоняет параметры маршрутизации контроллера и плагина, так что запрос /my_controller анализируется как ['controller' => 'MyController']

Cake\Routing\Route\Route
Extended by Cake\Routing\Route\InflectedRoute

Непосредственные подклассы

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

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

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

Унаследованные свойства

  • _compiledRoute, _extensions, _greedy, _name, defaults, keys, options, template

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

  • _underscore() protected
    Вспомогательный метод для подчеркивания ключей в массиве URL.
  • match() public

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

  • parse() public

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

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

_underscore()source protected

_underscore( array $url )

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

Параметры

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

Возвращает

массив

match()source public

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

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

Параметры

массив $url
Массив параметров для преобразования в строку.
массив $context необязательно []

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

Возвращает

строка|ложь
Строка URL для параметров, если они совпадают, или ложь.

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

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

parse()source public

parse( string $url )

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

Параметры

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

Возвращает

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

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

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

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

__construct()source public

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

Конструктор для маршрута

Параметры

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

Параметры

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

__set_state()source public статический

__set_state( array $fields )

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

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

Параметры

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

Возвращает

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

_matchMethod()source protected

_matchMethod( array $url )

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

Параметры

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

Возвращает

булево значение

_parseArgs()source protected

_parseArgs( string $args , string $context )

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

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

Параметры

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

Возвращает

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

_parseExtension()source protected

_parseExtension( string $url )

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

Параметры

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

Возвращает

массив
содержащий url, extension

_persistParams()source protected

_persistParams( array $url , array $params )

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

Параметры

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

Возвращает

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

_writeRoute()source protected

_writeRoute( )

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

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

_writeUrl()source protected

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

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

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

Параметры

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

Возвращает

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

compile()source public

compile( )

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

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

Возвращает

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

compiled()source public

compiled( )

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

Возвращает

булево значение
END_OF_DOCUMENT_MARKER

extensions()source public

extensions( null|string|array $extensions null )

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

Параметры

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

Возвращает

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

getName()source public

getName( )

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

Возвращает

string

staticPath()source public

staticPath( )

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

Возвращает

string

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

$_inflectedDefaultssource

protected boolean

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

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

false

© 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.2/class-Cake.Routing.Route.InflectedRoute.html

Spec-Zone.ru

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