Skip to content

aight8/zf-annotations

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

60 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Annotations for Zend Framework 2.

This module provides "configuration via annotation" support for Zend Framework 2. Out of the box it allows to define routes, service and all the ServiceManager-based implementations (as controllers, view helpers, etc).
The goal of this project is to get rid of large configuration arrays in application configs.

Build Status Latest Stable Version Total Downloads Latest Unstable Version License Deps. Status

Requirements

  • PHP >= 5.5.0

Installation

  • NOTE: if you want to use Zend libraries from Zend Framework 2, use ~1.0 versions. Branch ~2.0 supports future versions of Zend Framework and may not be compatible with ZF 2.*
Require via composer
composer require alex-oleshkevich/zf-annotations
Enable it in application.config.php
return array(
    'modules' => array(
        // other modules
        'ZfAnnotation'
    ),
    // other content
);

Configuration:

array(
    'zf_annotation' => array(
        // in which modules to search annotated classes
        'scan_modules' => array(),
                             
        // here listed all annotations supported by the module
        // add your own here
        'annotations' => array(
            'ZfAnnotation\Annotation\Route',
            // ...
        ),
        
        // listeners to events emitted by parser. 
        // they process class annotations and transforms them into config values
        // add your own here.
        'event_listeners' => array(
            'ZfAnnotation\EventListener\RouteListener',
            // ...
        )
    )
)

Components

Read how to add own annotations

Performance

This module is pretty fast, but anyway, parsing of lots of files on each request takes time.
The module subscribes to ModuleEvent::EVENT_MERGE_CONFIG and scans every time its is triggered. If you have option module_listener_options.config_cache_enabled enabled, annotation parser will not do parsing unless you set config_cache_enabled to false or remove a cache file. More info about caching here.

About

Zend Framework 2 configuration annotations

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • PHP 100.0%