Download the PHP package esyoilgmbh/annotations without Composer
On this page you can find all versions of the php package esyoilgmbh/annotations. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download esyoilgmbh/annotations
More information about esyoilgmbh/annotations
Files in esyoilgmbh/annotations
Package annotations
Short Description Annotations primarily for route declaration
License MIT
Informations about the package annotations
annotate.php
This project provides Java style annotations for PHP.
Example
Let's assume we're writing a web request router. We could use annotations to supply the routes and which method is associated.
Defining an annotation
Using the annotation above we can now define a controller and apply the annotation.
Using an annotation
Now that we have defined our annotation and applied it to our controller we can define our web request router.
This is obviously a rudimentary example from the perspective of our RequestRouter
, but it shows how the code>@Route
Annotations with multiple values
By default all annotations have a single value called value. Annotations also allow you to define your own values if a single value is not enough.
Now our code>@Route
Now our home and login controller methods indicate that they support a GET request method, while loginAuth supports POST. We would obviously need to update our RequestRouter
accordingly.
Named parameters
If you are providing all the parameters that your annotation expects, or if all the parameters you supply are in the correct order you don't need to do anything special. If you only want to pass some of your parameters however you will need to use named parameters.
API Documentation
AnnotatedReflectionClass
This class extends ReflectionClass and introduces the following methods:
- getAnnotations
- getAnnotation($annotationClass)
- hasAnnotation($annotationClass)
AnnotatedReflectionMethod
This class extends ReflectionMethod and introduces the following methods:
- getAnnotations
- getAnnotation($annotationClass)
- hasAnnotation($annotationClass)
AnnotatedReflectionProperty
This class extends ReflectionProperty and introduces the following methods:
- getAnnotations
- getAnnotation($annotationClass)
- hasAnnotation($annotationClass)
Annotation
You must extend this class anytime you define your own custom annotation.
@AnnotationTarget
This supplied annotation is used to specify the target of annotations. It takes one of the values from AnnotatedElementType
as it's value.
AnnotatedElementType
You can specify a target to annotation classes and limit what element type they pertain to. The value of the code>@AnnotationTarget
- ANNOTATION_TYPE - Annotation type declaration
- CONSTRUCTOR - Constructor declaration
- METHOD - Method declaration
- PROPERTY - Property declaration (includes constants)
- TYPE - Class (including annotation type), or interface declaration