Chris@0: <?php
Chris@0: 
Chris@0: /*
Chris@0:  * This file is part of the Symfony CMF package.
Chris@0:  *
Chris@0:  * (c) 2011-2015 Symfony CMF
Chris@0:  *
Chris@0:  * For the full copyright and license information, please view the LICENSE
Chris@0:  * file that was distributed with this source code.
Chris@0:  */
Chris@0: 
Chris@0: namespace Symfony\Cmf\Component\Routing\Event;
Chris@0: 
Chris@0: use Symfony\Component\EventDispatcher\Event;
Chris@0: use Symfony\Component\Routing\Route;
Chris@0: 
Chris@0: /**
Chris@0:  * Event fired before the dynamic router generates a url for a route.
Chris@0:  *
Chris@0:  * The name, parameters and absolute properties have the semantics of
Chris@0:  * UrlGeneratorInterface::generate()
Chris@0:  *
Chris@0:  * @author Ben Glassman
Chris@0:  *
Chris@0:  * @see \Symfony\Component\Routing\Generator\UrlGeneratorInterface::generate()
Chris@0:  */
Chris@0: class RouterGenerateEvent extends Event
Chris@0: {
Chris@0:     /**
Chris@0:      * The name of the route or the Route instance to generate.
Chris@0:      *
Chris@0:      * @var string|Route
Chris@0:      */
Chris@0:     private $route;
Chris@0: 
Chris@0:     /**
Chris@0:      * The parameters to use when generating the url.
Chris@0:      *
Chris@0:      * @var array
Chris@0:      */
Chris@0:     private $parameters;
Chris@0: 
Chris@0:     /**
Chris@0:      * The type of reference to be generated (one of the constants in UrlGeneratorInterface).
Chris@0:      *
Chris@0:      * @var bool|string
Chris@0:      */
Chris@0:     private $referenceType;
Chris@0: 
Chris@0:     /**
Chris@0:      * @param string|Route $route         The route name or object
Chris@0:      * @param array        $parameters    The parameters to use
Chris@0:      * @param bool|string  $referenceType The type of reference to be generated
Chris@0:      */
Chris@0:     public function __construct($route, $parameters, $referenceType)
Chris@0:     {
Chris@0:         $this->route = $route;
Chris@0:         $this->parameters = $parameters;
Chris@0:         $this->referenceType = $referenceType;
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Get route name or object.
Chris@0:      *
Chris@0:      * @return string|Route
Chris@0:      */
Chris@0:     public function getRoute()
Chris@0:     {
Chris@0:         return $this->route;
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Set route name or object.
Chris@0:      *
Chris@0:      * @param string|Route $route
Chris@0:      */
Chris@0:     public function setRoute($route)
Chris@0:     {
Chris@0:         $this->route = $route;
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Get route parameters.
Chris@0:      *
Chris@0:      * @return array
Chris@0:      */
Chris@0:     public function getParameters()
Chris@0:     {
Chris@0:         return $this->parameters;
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Set the route parameters.
Chris@0:      *
Chris@0:      * @param array $parameters
Chris@0:      */
Chris@0:     public function setParameters(array $parameters)
Chris@0:     {
Chris@0:         $this->parameters = $parameters;
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Set a route parameter.
Chris@0:      *
Chris@0:      * @param string $key
Chris@0:      * @param mixed  $value
Chris@0:      */
Chris@0:     public function setParameter($key, $value)
Chris@0:     {
Chris@0:         $this->parameters[$key] = $value;
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Remove a route parameter by key.
Chris@0:      *
Chris@0:      * @param string $key
Chris@0:      */
Chris@0:     public function removeParameter($key)
Chris@0:     {
Chris@0:         unset($this->parameters[$key]);
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * The type of reference to be generated (one of the constants in UrlGeneratorInterface).
Chris@0:      *
Chris@0:      * @return bool|string
Chris@0:      */
Chris@0:     public function getReferenceType()
Chris@0:     {
Chris@0:         return $this->referenceType;
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * The type of reference to be generated (one of the constants in UrlGeneratorInterface).
Chris@0:      *
Chris@0:      * @param bool|string $referenceType
Chris@0:      */
Chris@0:     public function setReferenceType($referenceType)
Chris@0:     {
Chris@0:         $this->referenceType = $referenceType;
Chris@0:     }
Chris@0: }