secit-pl/route-injector-bundle

Route Injector Symfony Bundle.

Installs: 1 861

Dependents: 0

Suggesters: 0

Stars: 1

Watchers: 0

Forks: 0

Open Issues: 0

Type:symfony-bundle

1.0.3 2018-02-13 21:09 UTC

README

Route injector annotation for Symfony 2.8 and 3.0+.

Installation

From the command line run

$ composer require secit-pl/route-injector-bundle

Update your AppKernel by adding the bundle declaration

class AppKernel extends Kernel
{
    public function registerBundles()
    {
        $bundles = [
            ...
            new SecIT\RouteInjectorBundle\RouteInjectorBundle(),
        ];

        ...
    }
}

Usage

The Annotation

To inject route to the variable just add the @InjectRoute annotation to it. The the first argument is the route name. The second and other arguments are the optional configuration options.

use SecIT\RouteInjectorBundle\Mapping\Annotation\InjectRoute;

/**
 * @InjectRoute("route_name", configuration options...);
 */
private $url;

Basic Usage

Here is the basic usage example.

The class:

use SecIT\RouteInjectorBundle\Mapping\Annotation\InjectRoute;

class Example
{
    /**
     * @var string
     *
     * @InjectRoute("route_name", parametersMapping={"param": "getRouteParam"});
     */
    private $url;
    
    private $routeParam = '';
    
    /**
     * @return string
     */
    public function getUrl()
    {
        return $this->url;
    }
    
    /**
     * @return string
     */
    public function getRouteParam()
    {
        return $this->routeParam;
    }
    
    /**
     * @param string $value
     */
    public function setRouteParam($value)
    {
        $this->routeParam = $value;
    }
}

And how to manually run the injector.

$processor = $this->container->get('secit.route_injector.processor');
$exampleEbject = new Example();
$exampleEbject->setRouteParam('test');
$processor->injectRoutes($exampleEbject);

Doctrine Entity Usage

This bundle provides the Doctrine integration. So if you use the @InjectRoute annotation in the entity the injectRoutes processor method will be triggered on every (depending on the conditions) load, update and persist action.

Example entity:

namespace ExampleBundle\Entity;

use Doctrine\ORM\Mapping as ORM;
use SecIT\RouteInjectorBundle\Mapping\Annotation\InjectRoute;

/**
 * @ORM\Table(name="example")
 * @ORM\Entity()
 */
class Example
{
    /**
     * @var string
     *
     * @ORM\Column(name="param", type="string")
     */
    private $param;

    /**
     * @var string
     *
     * @InjectRoute("route_name", parametersMapping={"param": "getParam"});
     */
    private $url;
    
    /**
     * @return string
     */
    public function getParam()
    {
        return $this->string;
    }
    
    /**
     * @param string $param
     */
    public function setParam($param)
    {
        $this->string = $param;
    }
    
    /**
     * @return string
     */
    public function getUrl()
    {
        return $this->url;
    }
}

When you create a new Example entity instance the $url will be null. But just after persist the route will be automatically injected and accessible.

$exampleObject = new ExampleBundle\Entity\Example();

$this->getDoctrine()->getManager()->persist($exampleObject);

Materialized Routes

In the previous example the route will be injected on each time we will load, update or store the entity but in some cases we would like to store it in the database. To achieve this simply add the Doctrine @Column annotation to make it a database field.

namespace ExampleBundle\Entity;

use Doctrine\ORM\Mapping as ORM;
use SecIT\RouteInjectorBundle\Mapping\Annotation\InjectRoute;

/**
 * @ORM\Table(name="example")
 * @ORM\Entity()
 */
class Example
{
    ...
    
    /**
     * @var string
     *
     * @ORM\Column(name="url", type="string", length=255)
     * @InjectRoute("route_name", parametersMapping={"param": "getParam"});
     */
    private $url;
    
    ...
}

Configuration options

Here are all possible configuration options:

@InjectRoute("route_name", configuration options...);
parametersMapping = array, default empty array

The array of the route parameters mapped to the public class methods from which the parameters values should be taken.

@InjectRoute("route_name", parametersMapping={"param": "publicGetterMethodName"});

Warning! The route will not be injected if any of the parameters will be null.

absolute = bool, default false

Set to true if you'd like to have the generated URLs with the protocol and hostname prefix.

@InjectRoute("route_name", absolute=true);
injectIfNotEmpty = bool, default false

By default the route will be injected only if the current value is empty (null, false, or the empty string). To make it updatable even if it's not empty set this option to true.

@InjectRoute("route_name", injectIfNotEmpty=true);