saxulum / saxulum-route-controller-provider
Saxulum Route/Controller Provider
Installs: 2 520
Dependents: 2
Suggesters: 0
Security: 0
Stars: 2
Watchers: 0
Forks: 2
Open Issues: 0
Requires
- php: >=5.3.9,<8.0
- doctrine/annotations: ~1.1
- nikic/php-parser: ~1.2,>=1.2.1
- saxulum/saxulum-annotation-manager: ~1.2
- silex/silex: ~1.1
- symfony/finder: ~2.3|~3.0
Requires (Dev)
- phpunit/phpunit: ~4.0
- symfony/browser-kit: ~2.3|~3.0
README
works with plain silex-php
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 loaddebug == 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 loaddebug == 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 methodbeforeFirst
on the controller instance__self::beforeSecond
calls the static methodbeforeSecond
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"})
*/