1. sfWebController.class.php
  2. /**
 * sfWebController provides web specific methods to sfController such as, url redirection.
 *
 * @package    symfony
 * @subpackage controller
 * @author     Fabien Potencier 
 * @author     Sean Kerr 
 * @version    SVN: $Id: sfWebController.class.php 25406 2009-12-15 12:22:30Z FabianLange $
 */
  3. abstract class sfWebController extends sfController
  4. {
  5.   /**
  6.    * Generates an URL from an array of parameters.
  7.    *
  8.    * @param mixed   $parameters An associative array of URL parameters or an internal URI as a string.
  9.    * @param boolean $absolute   Whether to generate an absolute URL
  10.    *
  11.    * @return string A URL to a symfony resource
  12.    */
  13.   public function genUrl($parameters = array(), $absolute = false)
  14.   {
  15.     $route = '';
  16.     $fragment = '';
  18.     if (is_string($parameters))
  19.     {
  20.       // absolute URL or symfony URL?
  21.       if (preg_match('#^[a-z][a-z0-9\+.\-]*\://#i', $parameters))
  22.       {
  23.         return $parameters;
  24.       }
  26.       // relative URL?
  27.       if (0 === strpos($parameters, '/'))
  28.       {
  29.         return $parameters;
  30.       }
  32.       if ($parameters == '#')
  33.       {
  34.         return $parameters;
  35.       }
  36.   
  37.       // strip fragment
  38.       if (false !== ($pos = strpos($parameters, '#')))
  39.       {
  40.         $fragment = substr($parameters, $pos + 1);
  41.         $parameters = substr($parameters, 0, $pos);
  42.       }
  44.       list($route, $parameters) = $this->convertUrlStringToParameters($parameters);
  45.     }
  46.     else if (is_array($parameters))
  47.     {
  48.       if (isset($parameters['sf_route']))
  49.       {
  50.         $route = $parameters['sf_route'];
  51.         unset($parameters['sf_route']);
  52.       }
  53.     }
  55.     // routing to generate path
  56.     $url = $this->context->getRouting()->generate($route, $parameters, $absolute);
  58.     if ($fragment)
  59.     {
  60.       $url .= '#'.$fragment;
  61.     }
  63.     return $url;
  64.   }
  66.   /**
  67.    * Converts an internal URI string to an array of parameters.
  68.    *
  69.    * @param string $url An internal URI
  70.    *
  71.    * @return array An array of parameters
  72.    */
  73.   public function convertUrlStringToParameters($url)
  74.   {
  75.     $givenUrl = $url;
  77.     $params = array();
  78.     $queryString = '';
  79.     $route = '';
  81.     // empty url?
  82.     if (!$url)
  83.     {
  84.       $url = '/';
  85.     }
  87.     // we get the query string out of the url
  88.     if ($pos = strpos($url, '?'))
  89.     {
  90.       $queryString = substr($url, $pos + 1);
  91.       $url = substr($url, 0, $pos);
  92.     }
  94.     // 2 url forms
  95.     // @routeName?key1=value1&key2=value2...
  96.     // module/action?key1=value1&key2=value2...
  98.     // first slash optional
  99.     if ($url[0] == '/')
  100.     {
  101.       $url = substr($url, 1);
  102.     }
  104.     // routeName?
  105.     if ($url[0] == '@')
  106.     {
  107.       $route = substr($url, 1);
  108.     }
  109.     else if (false !== strpos($url, '/'))
  110.     {
  111.       list($params['module'], $params['action']) = explode('/', $url);
  112.     }
  113.     else if (!$queryString)
  114.     {
  115.       $route = $givenUrl;
  116.     }
  117.     else
  118.     {
  119.       throw new InvalidArgumentException(sprintf('An internal URI must contain a module and an action (module/action) ("%s" given).', $givenUrl));
  120.     }
  122.     // split the query string
  123.     if ($queryString)
  124.     {
  125.       $matched = preg_match_all('/
  126.         ([^&=]+)            # key
  127.         =                   # =
  128.         (.*?)               # value
  129.         (?:
  130.           (?=&[^&=]+=) | $  # followed by another key= or the end of the string
  131.         )
  132.       /x', $queryString, $matches, PREG_SET_ORDER | PREG_OFFSET_CAPTURE);
  133.       foreach ($matches as $match)
  134.       {
  135.         $params[urldecode($match[1][0])] = urldecode($match[2][0]);
  136.       }
  138.       // check that all string is matched
  139.       if (!$matched)
  140.       {
  141.         throw new sfParseException(sprintf('Unable to parse query string "%s".', $queryString));
  142.       }
  143.     }
  145.     return array($route, $params);
  146.   }
  148.   /**
  149.    * Redirects the request to another URL.
  150.    *
  151.    * @param string $url        An associative array of URL parameters or an internal URI as a string
  152.    * @param int    $delay      A delay in seconds before redirecting. This is only needed on
  153.    *                           browsers that do not support HTTP headers
  154.    * @param int    $statusCode The status code
  155.    *
  156.    * @throws InvalidArgumentException If the url argument is null or an empty string
  157.    */
  158.   public function redirect($url, $delay = 0, $statusCode = 302)
  159.   {
  160.     if (empty($url))
  161.     {
  162.       throw new InvalidArgumentException('Cannot redirect to an empty URL.'); 
  163.     } 
  165.     $url = $this->genUrl($url, true);
  167.     if (sfConfig::get('sf_logging_enabled'))
  168.     {
  169.       $this->dispatcher->notify(new sfEvent($this, 'application.log', array(sprintf('Redirect to "%s"', $url))));
  170.     }
  172.     // redirect
  173.     $response = $this->context->getResponse();
  174.     $response->clearHttpHeaders();
  175.     $response->setStatusCode($statusCode);
  176.     $response->setHttpHeader('Location', $url);
  177.     $response->setContent(sprintf('<html><head><meta http-equiv="refresh" content="%d;url=%s"/></head></html>', $delay, htmlspecialchars($url, ENT_QUOTES, sfConfig::get('sf_charset'))));
  178.     $response->send();
  179.   }
  180. }
Debug toolbar