saxulum/saxulum-route-controller-provider

Saxulum Route/Controller Provider

saxulum-route-controller-provider

works with plain silex-php, _(*1)

, _(*2)

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][1]., _(*3)

AnnotationRegistry

Add this line after you added the autoload.php from composer, _(*4)

```{.php} \Doctrine\Common\Annotations\AnnotationRegistry::registerLoader( array($loader, 'loadClass') );, <sub>(*5)</sub>

### With defined cache dir

```{.php}
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, <sub>(*6)</sub>

```{.php} use Saxulum\RouteController\Provider\RouteControllerProvider; use Silex\Provider\ServiceControllerServiceProvider;, <sub>(*7)</sub>

$app->register(new ServiceControllerServiceProvider()); $app->register(new RouteControllerProvider());, <sub>(*8)</sub>

* `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

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

        return $paths;
    })
);

Usage

Route Annotation

Controller

```{.php} use Saxulum\RouteController\Annotation\Route;, <sub>(*9)</sub>

/** * @Route("/{_locale}") */, <sub>(*10)</sub>

#### Method

```{.php}
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., <sub>(*11)</sub>

Container Injection

```{.php} use Saxulum\RouteController\Annotation\DI;, <sub>(*12)</sub>

/** * @DI(injectContainer=true) */, <sub>(*13)</sub>

#### Service Injection
```{.php}
use Saxulum\RouteController\Annotation\DI;

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