Redirect.php

<?php
/**
 * Zend Framework (http://framework.zend.com/)
 *
 * @link      http://github.com/zendframework/zf2 for the canonical source repository
 * @copyright Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
 * @license   http://framework.zend.com/license/new-bsd New BSD License
 * @package   Zend_Mvc
 */

namespace Zend\Mvc\Controller\Plugin;

use Zend\Http\Response;
use Zend\Mvc\Exception;
use Zend\Mvc\InjectApplicationEventInterface;
use Zend\Mvc\MvcEvent;
use Zend\Mvc\Router\RouteStackInterface;

/**
 * @todo       allow specifying status code as a default, or as an option to methods
 * @category   Zend
 * @package    Zend_Mvc
 * @subpackage Controller
 */
class Redirect extends AbstractPlugin
{
    protected $event;
    protected $response;
    protected $router;

    /**
     * Gets current route name
     *
     * @return string
     */
    protected function getCurrentRoute ()
    {
        return $this->getEvent()->getRouteMatch()->getMatchedRouteName();
    }

    /**
     * Gets current route params
     */
    protected function getCurrentRouteParams()
    {
        return $this->getEvent()->getRouteMatch()->getParams();
    }

    /**
     * Generates a URL based on a route
     *
     * @param  string $route RouteInterface name
     * @param  array $params Parameters to use in url generation, if any
     * @param  array $options RouteInterface-specific options to use in url generation, if any
     * @return Response
     * @throws Exception\DomainException if composed controller does not implement InjectApplicationEventInterface, or
     *         router cannot be found in controller event
     */
    public function toRoute($route = null, array $params = array(), array $options = array())
    {
        // Refresh if null provided
        if (is_null($route)) {
            $route  = $this->getCurrentRoute();
            $params = array_merge($this->getCurrentRouteParams(), $params);
        }

        $response = $this->getResponse();
        $router   = $this->getRouter();

        $options['name'] = $route;
        $url = $router->assemble($params, $options);
        $response->getHeaders()->addHeaderLine('Location', $url);
        $response->setStatusCode(302);
        return $response;
    }

    /**
     * Redirect to the given URL
     *
     * @param  string $url
     * @return Response
     */
    public function toUrl($url)
    {
        $response = $this->getResponse();
        $response->getHeaders()->addHeaderLine('Location', $url);
        $response->setStatusCode(302);
        return $response;
    }

    /**
     * Refresh to current route
     *
     * @return string
     */
    public function refresh()
    {
        return $this->toRoute($this->getCurrentRoute(), $this->getCurrentRouteParams());
    }

    /**
     * Get the router
     *
     * @return RouteStackInterface
     * @throws Exception\DomainException if unable to find router
     */
    protected function getRouter()
    {
        if ($this->router) {
            return $this->router;
        }

        $event  = $this->getEvent();
        $router = $event->getRouter();
        if (!$router instanceof RouteStackInterface) {
            throw new Exception\DomainException('Redirect plugin requires event compose a router');
        }
        $this->router = $router;
        return $this->router;
    }

    /**
     * Get the response
     *
     * @return Response
     * @throws Exception\DomainException if unable to find response
     */
    protected function getResponse()
    {
        if ($this->response) {
            return $this->response;
        }

        $event    = $this->getEvent();
        $response = $event->getResponse();
        if (!$response instanceof Response) {
            throw new Exception\DomainException('Redirect plugin requires event compose a response');
        }
        $this->response = $response;
        return $this->response;
    }

    /**
     * Get the event
     *
     * @return MvcEvent
     * @throws Exception\DomainException if unable to find event
     */
    protected function getEvent()
    {
        if ($this->event) {
            return $this->event;
        }

        $controller = $this->getController();
        if (!$controller instanceof InjectApplicationEventInterface) {
            throw new Exception\DomainException('Redirect plugin requires a controller that implements InjectApplicationEventInterface');
        }

        $event = $controller->getEvent();
        if (!$event instanceof MvcEvent) {
            $params = $event->getParams();
            $event  = new MvcEvent();
            $event->setParams($params);
        }
        $this->event = $event;

        return $this->event;
    }
}