Download the PHP package larachimp/pine-annotations without Composer

Pine Annotations

Introduction

Pine Annotations package makes creating and reading annotations seamlessly in any laravel 5 project. Behind the scenes Pine Annotations make use of the doctrine-annotations project, but tries to simplify its integration with Laravel 5.

License

Pine Annotations is open-sourced software licensed under the MIT license.

Version Compatibility

Installation

Configuration

If you are using Laravel >= 5.5, you can skip service registration thanks to Laravel auto package discovery feature.

After installation all you need is to register the
in your config/app.php configuration file:

You can also register the alias which helps in reading object's annotations.

You can now publish config using the command:

This will create the file in your config directory.

Registering your annotations in the AnnotationRegistry

The config file has two sections and .

autoload_files

In this array you may include the file paths of all your annotations classes. These will get registered in the . You can include as many files as you need.

autoload_namespaces

This array contains the namespaces of your annotations classes. This is useful if you want to register all annotations classes of a whole namespace in a single go.

Using the Reader to manually add entries to the Registry.

Alternatively you may use the methods and to perform manual entries of files and namespaces to the annotation registry.

It is imperative that you register your annotations classes in one way or the other with the Reader. Otherwise AnnotationsReader won't be able to parse them.

The AnnotationsReader

To create an instance of the , use the Laravel's IOC to either inject or create it via the method or facade:

or:

Alternatively can also use the facade for all annotations reading.

Reading all annotations of a class

Consider the following class which is annotated with the :

To read this class' annotations, simply create an instance of the with target as class :

The will return a of the class' annotations with their values filled in the correct attributes :

Note that all annotations are cached by default for convinience. Hence the AnnotationsReader does not have to parse doc blocks each time it reads annotations from a target, which would be rather costly operation otherwise. The AnnotationsReader uses the default cache which you define in your Laravel App.

Reading a specific annotation of a class

Consider the following class which is annotated with the and :

Now we may want to only parse or read the doc block. To do so, we can use the method on our instance. The method takes as a single argument the annotation's class name :

This will return with the keys and values of the targetted annotation:

Reading all annotations of a property on a class

Consider the following class with the given annotations blocks on the property:

To read the annotations of the property, we will use the target as and the property's name on the :

The result is a with all Annotations objects and theirs properties values filled in :

Reading specific annotation of a property on a class

Consider the following class with the given annotations blocks on the property:

Now we may want to only parse or read the doc block. To do so, we will use the target as together with the property's name and the method on our instance. The method takes as a single argument the annotation's class name :

This will return with the keys and values of the targetted annotation:

Reading all annotations of a method on a class

Consider the following class with the given annotations blocks on the method :

To read all the annotations of the method, we will use target as and the method's name on our instance :

The result is a with all Annotations objects and theirs properties values filled in :

Reading a specific annotation of a method on a class

Consider the following class with the given annotations blocks on the method :

Now we may want to only parse or read the doc block. To do so, we will use the target as together with the method's name and the method on our instance. The method takes as a single argument the annotation's class name :

This will return with the keys and values of the targetted annotation:

Credits

Big Thanks to all developers who worked hard to create something amazing!

Creator

Twitter: @PercyMamedy

GitHub: percymamedy