Download the PHP package codeburner/annotator without Composer
On this page you can find all versions of the php package codeburner/annotator. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download codeburner/annotator
More information about codeburner/annotator
Files in codeburner/annotator
Package annotator
Short Description Implements a simple, fast and useful annotation support.
License MIT
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package annotator
Codeburner Annotator
A simple and fast annotation support for PHP.
Instalation
Add codeburner/annotator to your composer.json file.
or via cli
Don't forget to install or update the composer and include the vendor/autoload.php file.
Table of Content
- Introduction
- Syntax
- Annotation Classes
- Filtering Values
- Basic Usage
- Real World Usage
Introduction
Annotation is a form of metadata, provide data about a program but is not part of the program itself. Annotations have no direct effect on the operation of the code they annotate. It's frequently used on JAVA applications, in PHP there is no native implementation of annotations, but as example exists the Doctrine ORM that annotate the models using the PHPDoc comment style.
Syntax
The annotations need to start with @ and be inside a doc block /**. Annotation names receive the same rules of vars in PHP, and they value can be everything BUT it will be parsed as string, the annotator does not make any cast and arrays must be write as jsons.
Annotation Classes
By default any annotation is a Codeburner\Annotator\Annotation but you can specialize one annotation adding logic to they. For it you must create a new class that extends the Codeburner\Annotator\Annotation. The annotation name will be the full class name, but can be affected by the use and namespace statements.
BarAnnotation is Foo\Bar\BarAnnotation class, FooAnnotation is Foo\FooAnnotation class and AliasedAnnotation is Foo\Bar\BarAnnotation class.
NOTE: All defined annotations must have the
-fflag in usage, this means that it's a file and can have a filter.
Filtering Values
When defining a class for an annotation the arguments could be formmated or filtered by the implementation of method public function filter().
Basic Usage
Real World Usage
For example registering routes in the codeburner router system only using annotations in a controller.
In this code there is three annotations, @RouteStrategy, @RoutePrefix and @Route. The router system will read these annotations and build a route based on then.
