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;
Chris@0: 
Chris@0: /**
Chris@0:  * Document for redirection entries with the RedirectController.
Chris@0:  *
Chris@0:  * Defines additional methods needed by the RedirectController to redirect
Chris@0:  * based on the route.
Chris@0:  *
Chris@0:  * This document may define (in order of precedence - the others can be empty):
Chris@0:  *
Chris@0:  * - uri: an absolute uri
Chris@0:  * - routeName and routeParameters: to be used with the standard symfony router
Chris@0:  *   or a route entry in the routeParameters for the DynamicRouter. Precedency
Chris@0:  *   between these is determined by the order of the routers in the chain
Chris@0:  *   router.
Chris@0:  *
Chris@0:  * With standard Symfony routing, you can just use uri / routeName and a
Chris@0:  * hashmap of parameters.
Chris@0:  *
Chris@0:  * For the dynamic router, you can return a RouteInterface instance in the
Chris@0:  * field 'route' of the parameters.
Chris@0:  *
Chris@0:  * Note: getRedirectContent must return the redirect route itself for the
Chris@0:  * integration with DynamicRouter to work.
Chris@0:  *
Chris@0:  * @author David Buchmann <david@liip.ch>
Chris@0:  */
Chris@0: interface RedirectRouteInterface extends RouteObjectInterface
Chris@0: {
Chris@0:     /**
Chris@0:      * Get the absolute uri to redirect to external domains.
Chris@0:      *
Chris@0:      * If this is non-empty, the other methods won't be used.
Chris@0:      *
Chris@0:      * @return string target absolute uri
Chris@0:      */
Chris@0:     public function getUri();
Chris@0: 
Chris@0:     /**
Chris@0:      * Get the target route document this route redirects to.
Chris@0:      *
Chris@0:      * If non-null, it is added as route into the parameters, which will lead
Chris@0:      * to have the generate call issued by the RedirectController to have
Chris@0:      * the target route in the parameters.
Chris@0:      *
Chris@0:      * @return RouteObjectInterface the route this redirection points to
Chris@0:      */
Chris@0:     public function getRouteTarget();
Chris@0: 
Chris@0:     /**
Chris@0:      * Get the name of the target route for working with the symfony standard
Chris@0:      * router.
Chris@0:      *
Chris@0:      * @return string target route name
Chris@0:      */
Chris@0:     public function getRouteName();
Chris@0: 
Chris@0:     /**
Chris@0:      * Whether this should be a permanent or temporary redirect.
Chris@0:      *
Chris@0:      * @return bool
Chris@0:      */
Chris@0:     public function isPermanent();
Chris@0: 
Chris@0:     /**
Chris@0:      * Get the parameters for the target route router::generate().
Chris@0:      *
Chris@0:      * Note that for the DynamicRouter, you return the target route
Chris@0:      * document as field 'route' of the hashmap.
Chris@0:      *
Chris@0:      * @return array Information to build the route
Chris@0:      */
Chris@0:     public function getParameters();
Chris@0: }