saxulum/saxulum-route-controller-provider

Saxulum Route/Controller Provider

Installs: 530

Dependents: 3

Stars: 1

Watchers: 2

Forks: 1

Language: PHP

1.2.3 2015-03-25 15:25 UTC

README

works with plain silex-php

Build Status Total Downloads Latest Stable Version Scrutinizer Code Quality

Features

  • Register Controller as Service using Annotations

Requirements

  • php >=5.3
  • Doctrine Annotations >=1.1
  • PHP Parser >=0.9,<1.0
  • Saxulum ClassFinder >=1.0
  • Symfony Finder Component >=2.3
  • Silex >= 1.1

Installation

Through Composer as saxulum/saxulum-route-controller-provider.

AnnotationRegistry

Add this line after you added the autoload.php from composer

\Doctrine\Common\Annotations\AnnotationRegistry::registerLoader(
    array($loader, 'loadClass')
);

With defined cache dir

use Saxulum\RouteController\Provider\RouteControllerProvider;
use Silex\Provider\ServiceControllerServiceProvider;

$app->register(new ServiceControllerServiceProvider());
$app->register(new RouteControllerProvider(), array(
    'route_controller_cache' => '/path/to/cache/'
));
  • debug == true: the cache file will be build at each load
  • debug == false: the cache file will be build if not exists, delete it if its out of sync

Without defined cache dir

probably slower, cause temp dir cleanups

use Saxulum\RouteController\Provider\RouteControllerProvider;
use Silex\Provider\ServiceControllerServiceProvider;

$app->register(new ServiceControllerServiceProvider());
$app->register(new RouteControllerProvider());
  • debug == true: the cache file will be build at each load
  • debug == false: the cache file will be build if not exists, delete it if its out of sync

Add the controller paths

$app['route_controller_paths'] = $app->share(
    $app->extend('route_controller_paths', function ($paths) {
        $paths[] = '/path/to/the/controllers';

        return $paths;
    })
);

Usage

Route Annotation

Controller
use Saxulum\RouteController\Annotation\Route;

/**
 * @Route("/{_locale}")
 */
Method
use Saxulum\RouteController\Annotation\Callback;
use Saxulum\RouteController\Annotation\Convert;
use Saxulum\RouteController\Annotation\Route;

/**
 * @Route("/hello/{name}",
 *      bind="hello_name",
 *      asserts={"name"="\w+"},
 *      values={"name"="world"},
 *      converters={
 *          @Convert("name", callback=@Callback("__self:convertName"))
 *      },
 *      method="GET",
 *      requireHttp=false,
 *      requireHttps=false,
 *      before={
 *          @Callback("__self:beforeFirst"),
 *          @Callback("__self::beforeSecond")
 *      },
 *      after={
 *          @Callback("__self:afterFirst"),
 *          @Callback("__self::afterSecond")
 *      }
 * )
 */
  • __self get replaced by the controller class.
  • __self:beforeFirst calls the method beforeFirst on the controller instance
  • __self::beforeSecond calls the static method beforeSecond on the controller

Dependency Injection Annotation

If there is no DI annotation, the controller will be registred without any dependencies as long there is at least one method route annotation.

Container Injection
use Saxulum\RouteController\Annotation\DI;

/**
 * @DI(injectContainer=true)
 */
Service Injection
use Saxulum\RouteController\Annotation\DI;

/**
 * @DI(serviceIds={"url_generator"})
 */