Download the PHP package makallio85/yaml-route without Composer
On this page you can find all versions of the php package makallio85/yaml-route. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download makallio85/yaml-route
More information about makallio85/yaml-route
Files in makallio85/yaml-route
Package yaml-route
Short Description Configure routes with simple YAML files
License MIT
Informations about the package yaml-route
Yaml-route
Yaml-route provides possibility to configure CakePHP 3 routes with simple YAML files. This is basically just wrapper for CakePHP core routing that parses YAML files and makes proper calls to .
Main goal is not to implement all fancy features that CakePHP 3 routing provides, only those ones that are really needed. Of course this is relative to developer, so feel free to fork and commit your own code.
Installation
Usage
- Replace all contents in file with single method call
- Load all plugins by calling Method is basically just wrapper for method. Note that method is not supported and all plugins should be loaded one at time.
- Add your own route to files to your project and desired plugins.
About route configuration
Every route is automatically named with its key. Root route should be named as root by convention. Route can contain path and config keys. Path is always string but config can be string that references to another YAML file that contains routes configuration. Syntax for external path is "PluginName.RouteFileNameWithoutExtension". All route configurations should be placed in config folder of project or plugin.
Route can also contain subroutes and they are defined inside key
key can contain keys listed below
Key | Type | Description |
---|---|---|
controller | string | Route controller |
action | string | Route action |
plugin | string | Route plugin |
_method | array or string | Route method |
extensions | array | Allowed extensions |
routes | array | Subroutes |
validate | array | List of variables to validate |
Note that subroutes can't contain routes so for subroutes is not available.
Examples
Basic routing
like this
Turns into this
Plugin Routing
like this
Turns into this
Debugging
If you want to debug generated routes, you can set debug parameter to true when calling . After that, you are able to get executed calls by calling .
toDo
- Add support for true inheritance by allowing subroute to contain subroute
Add testsAdd more tests- Refactor classes
Add support for extensionsImprove exception handling
License
The MIT License (MIT)
Copyright (c) 2016 makallio85
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
All versions of yaml-route with dependencies
cakephp/cakephp Version >=3.0.0
symfony/yaml Version ~2.6
cakephp/plugin-installer Version *