Defines a route. More...
Inheritance diagram for RouteAnnotation:
Public Member Functions | |
| initAnnotation (array $properties) | |
| Initialize the annotation. | |
| Public Member Functions inherited from BaseAnnotation | |
| asAnnotation () | |
| __toString () | |
| Public Member Functions inherited from BaseAnnotationTrait | |
| getProperties () | |
| getPropertiesAndValues ($props=NULL) | |
| isSameAs ($annot) | |
Data Fields | |
| $path | |
| $methods | |
| $name | |
| $cache | |
| $duration | |
| $inherited | |
| $automated | |
| $requirements | |
| $priority | |
Additional Inherited Members | |
| Protected Member Functions inherited from BaseAnnotation | |
| getDefaultParameters () | |
Detailed Description
Defines a route.
usages :
- route("routePath") default path: ""
- route("path"=>"routePath")
- route("routePath","methods"=>["routeMethods"])
- route("routePath","cache"=>true,"duration"=>intValue)
- route("routePath","inherited"=>true)
- route("routePath","automated"=>true)
- route("routePath","requirements"=>["member"=>"regExpr"])
- route("routePath","priority"=>intValue)
- route("routePath","name"=>"routeName") default routeName: controllerName_actionName
@usage('method'=>true,'class'=>true,'multiple'=>true, 'inherited'=>true)
Definition at line 22 of file RouteAnnotation.php.
Member Function Documentation
◆ initAnnotation()
| initAnnotation | ( | array | $properties | ) |
Initialize the annotation.
Reimplemented from BaseAnnotation.
Reimplemented in DeleteAnnotation, GetAnnotation, OptionsAnnotation, PatchAnnotation, PostAnnotation, and PutAnnotation.
Definition at line 36 of file RouteAnnotation.php.
Field Documentation
◆ $automated
| $automated |
Definition at line 29 of file RouteAnnotation.php.
◆ $cache
| $cache |
Definition at line 26 of file RouteAnnotation.php.
◆ $duration
| $duration |
Definition at line 27 of file RouteAnnotation.php.
◆ $inherited
| $inherited |
Definition at line 28 of file RouteAnnotation.php.
◆ $methods
| $methods |
Definition at line 24 of file RouteAnnotation.php.
◆ $name
| $name |
Definition at line 25 of file RouteAnnotation.php.
◆ $path
| $path |
Definition at line 23 of file RouteAnnotation.php.
◆ $priority
| $priority |
Definition at line 31 of file RouteAnnotation.php.
◆ $requirements
| $requirements |
Definition at line 30 of file RouteAnnotation.php.
The documentation for this class was generated from the following file:
- C:/Users/myadd/Documents/GitHub/ubiquity-doc-api/vendor/phpmv/ubiquity-annotations/src/Ubiquity/annotations/items/router/RouteAnnotation.php