1. sfObjectRouteCollection.class.php
  2. /**
 * sfObjectRouteCollection represents a collection of routes bound to objects.
 *
 * @package    symfony
 * @subpackage routing
 * @author     Fabien Potencier 
 * @version    SVN: $Id: sfObjectRouteCollection.class.php 24591 2009-11-30 18:34:29Z FabianLange $
 */
  3. class sfObjectRouteCollection extends sfRouteCollection
  4. {
  5.   protected
  6.     $routeClass = 'sfObjectRoute';
  8.   /**
  9.    * Constructor.
  10.    *
  11.    * @param array $options An array of options
  12.    */
  13.   public function __construct(array $options)
  14.   {
  15.     parent::__construct($options);
  17.     if (!isset($this->options['model']))
  18.     {
  19.       throw new InvalidArgumentException(sprintf('You must pass a "model" option to %s ("%s" route)', get_class($this), $this->options['name']));
  20.     }
  21.     
  22.     $this->options = array_merge(array(
  23.       'actions'              => false,
  24.       'module'               => $this->options['name'],
  25.       'prefix_path'          => '/'.$this->options['name'],
  26.       'column'               => isset($this->options['column']) ? $this->options['column'] : 'id',
  27.       'with_show'            => true,
  28.       'segment_names'        => array('edit' => 'edit', 'new' => 'new'),
  29.       'model_methods'        => array(),
  30.       'requirements'         => array(),
  31.       'with_wildcard_routes' => false,
  32.       'default_params'   => array(),
  33.     ), $this->options);
  34.     
  35.     $this->options['requirements'] = array_merge(array($this->options['column'] => 'id' == $this->options['column'] ? '\d+' : null), $this->options['requirements']);
  36.     $this->options['model_methods'] = array_merge(array('list' => null, 'object' => null), $this->options['model_methods']);
  38.     if (isset($this->options['route_class']))
  39.     {
  40.       $this->routeClass = $this->options['route_class'];
  41.     }
  43.     $this->generateRoutes();
  44.   }
  46.   protected function generateRoutes()
  47.   {
  48.     // collection actions
  49.     if (isset($this->options['collection_actions']))
  50.     {
  51.       foreach ($this->options['collection_actions'] as $action => $methods)
  52.       {
  53.         $this->routes[$this->getRoute($action)] = $this->getRouteForCollection($action, $methods);
  54.       }
  55.     }
  57.     // "standard" actions
  58.     $actions = false === $this->options['actions'] ? $this->getDefaultActions() : $this->options['actions'];
  59.     foreach ($actions as $action)
  60.     {
  61.       $method = 'getRouteFor'.ucfirst($action);
  62.       if (!method_exists($this, $method))
  63.       {
  64.         throw new InvalidArgumentException(sprintf('Unable to generate a route for the "%s" action.', $action));
  65.       }
  67.       $this->routes[$this->getRoute($action)] = $this->$method();
  68.     }
  70.     // object actions
  71.     if (isset($this->options['object_actions']))
  72.     {
  73.       foreach ($this->options['object_actions'] as $action => $methods)
  74.       {
  75.         $this->routes[$this->getRoute($action)] = $this->getRouteForObject($action, $methods);
  76.       }
  77.     }
  79.     if ($this->options['with_wildcard_routes'])
  80.     {
  81.       // wildcard object actions
  82.       $this->routes[$this->getRoute('object')] = new $this->routeClass(
  83.         sprintf('%s/:%s/:action.:sf_format', $this->options['prefix_path'], $this->options['column']),
  84.         array_merge($this->options['default_params'], array('module' => $this->options['module'], 'sf_format' => 'html')),
  85.         array_merge($this->options['requirements'], array('sf_method' => 'get')),
  86.         array('model' => $this->options['model'], 'type' => 'object', 'method' => $this->options['model_methods']['object'])
  87.       );
  89.       // wildcard collection actions
  90.       $this->routes[$this->getRoute('collection')] = new $this->routeClass(
  91.         sprintf('%s/:action/action.:sf_format', $this->options['prefix_path']),
  92.         array_merge($this->options['default_params'], array('module' => $this->options['module'], 'sf_format' => 'html')),
  93.         array_merge($this->options['requirements'], array('sf_method' => 'post')),
  94.         array('model' => $this->options['model'], 'type' => 'list', 'method' => $this->options['model_methods']['list'])
  95.       );
  96.     }
  97.   }
  99.   protected function getRouteForCollection($action, $methods)
  100.   {
  101.     return new $this->routeClass(
  102.       sprintf('%s/%s.:sf_format', $this->options['prefix_path'], $action),
  103.       array_merge($this->options['default_params'], array('module' => $this->options['module'], 'action' => $action, 'sf_format' => 'html')),
  104.       array_merge($this->options['requirements'], array('sf_method' => $methods)),
  105.       array('model' => $this->options['model'], 'type' => 'list', 'method' => $this->options['model_methods']['list'])
  106.     );
  107.   }
  109.   protected function getRouteForObject($action, $methods)
  110.   {
  111.     return new $this->routeClass(
  112.       sprintf('%s/:%s/%s.:sf_format', $this->options['prefix_path'], $this->options['column'], $action),
  113.       array_merge($this->options['default_params'], array('module' => $this->options['module'], 'action' => $action, 'sf_format' => 'html')),
  114.       array_merge($this->options['requirements'], array('sf_method' => $methods)),
  115.       array('model' => $this->options['model'], 'type' => 'object', 'method' => $this->options['model_methods']['object'])
  116.     );
  117.   }
  119.   protected function getRouteForList()
  120.   {
  121.     return new $this->routeClass(
  122.       sprintf('%s.:sf_format', $this->options['prefix_path']),
  123.       array_merge($this->options['default_params'], array('module' => $this->options['module'], 'action' => $this->getActionMethod('list'), 'sf_format' => 'html')),
  124.       array_merge($this->options['requirements'], array('sf_method' => 'get')),
  125.       array('model' => $this->options['model'], 'type' => 'list', 'method' => $this->options['model_methods']['list'])
  126.     );
  127.   }
  129.   protected function getRouteForNew()
  130.   {
  131.     return new $this->routeClass(
  132.       sprintf('%s/%s.:sf_format', $this->options['prefix_path'], $this->options['segment_names']['new']),
  133.       array_merge($this->options['default_params'], array('module' => $this->options['module'], 'action' => $this->getActionMethod('new'), 'sf_format' => 'html')),
  134.       array_merge($this->options['requirements'], array('sf_method' => 'get')),
  135.       array('model' => $this->options['model'], 'type' => 'object')
  136.     );
  137.   }
  139.   protected function getRouteForCreate()
  140.   {
  141.     return new $this->routeClass(
  142.       sprintf('%s.:sf_format', $this->options['prefix_path']),
  143.       array_merge($this->options['default_params'], array('module' => $this->options['module'], 'action' => $this->getActionMethod('create'), 'sf_format' => 'html')),
  144.       array_merge($this->options['requirements'], array('sf_method' => 'post')),
  145.       array('model' => $this->options['model'], 'type' => 'object')
  146.     );
  147.   }
  149.   protected function getRouteForShow()
  150.   {
  151.     return new $this->routeClass(
  152.       sprintf('%s/:%s.:sf_format', $this->options['prefix_path'], $this->options['column']),
  153.       array_merge($this->options['default_params'], array('module' => $this->options['module'], 'action' => $this->getActionMethod('show'), 'sf_format' => 'html')),
  154.       array_merge($this->options['requirements'], array('sf_method' => 'get')),
  155.       array('model' => $this->options['model'], 'type' => 'object', 'method' => $this->options['model_methods']['object'])
  156.     );
  157.   }
  159.   protected function getRouteForEdit()
  160.   {
  161.     return new $this->routeClass(
  162.       sprintf('%s/:%s/%s.:sf_format', $this->options['prefix_path'], $this->options['column'], $this->options['segment_names']['edit']),
  163.       array_merge($this->options['default_params'], array('module' => $this->options['module'], 'action' => $this->getActionMethod('edit'), 'sf_format' => 'html')),
  164.       array_merge($this->options['requirements'], array('sf_method' => 'get')),
  165.       array('model' => $this->options['model'], 'type' => 'object', 'method' => $this->options['model_methods']['object'])
  166.     );
  167.   }
  169.   protected function getRouteForUpdate()
  170.   {
  171.     return new $this->routeClass(
  172.       sprintf('%s/:%s.:sf_format', $this->options['prefix_path'], $this->options['column']),
  173.       array_merge($this->options['default_params'], array('module' => $this->options['module'], 'action' => $this->getActionMethod('update'), 'sf_format' => 'html')),
  174.       array_merge($this->options['requirements'], array('sf_method' => 'put')),
  175.       array('model' => $this->options['model'], 'type' => 'object', 'method' => $this->options['model_methods']['object'])
  176.     );
  177.   }
  179.   protected function getRouteForDelete()
  180.   {
  181.     return new $this->routeClass(
  182.       sprintf('%s/:%s.:sf_format', $this->options['prefix_path'], $this->options['column']),
  183.       array_merge($this->options['default_params'], array('module' => $this->options['module'], 'action' => $this->getActionMethod('delete'), 'sf_format' => 'html')),
  184.       array_merge($this->options['requirements'], array('sf_method' => 'delete')),
  185.       array('model' => $this->options['model'], 'type' => 'object', 'method' => $this->options['model_methods']['object'])
  186.     );
  187.   }
  189.   protected function getDefaultActions()
  190.   {
  191.     $actions = array('list', 'new', 'create', 'edit', 'update', 'delete');
  193.     if ($this->options['with_show'])
  194.     {
  195.       $actions[] = 'show';
  196.     }
  198.     return $actions;
  199.   }
  201.   protected function getRoute($action)
  202.   {
  203.     return 'list' == $action ? $this->options['name'] : $this->options['name'].'_'.$action;
  204.   }
  206.   protected function getActionMethod($action)
  207.   {
  208.     return 'list' == $action ? 'index' : $action;
  209.   }
  210. }
Debug toolbar