Giter VIP home page Giter VIP logo

saxulum-route-controller-provider's Introduction

saxulum-route-controller-provider

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"})
 */

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.