1. sfObjectRoute.class.php
  2. /**
 * sfObjectRoute represents a route that is bound to PHP object(s).
 *
 * An object route can represent a single object or a list of objects.
 *
 * @package    symfony
 * @subpackage routing
 * @author     Fabien Potencier 
 * @version    SVN: $Id: sfObjectRoute.class.php 20784 2009-08-04 20:53:57Z Kris.Wallsmith $
 */
  3. class sfObjectRoute extends sfRequestRoute
  4. {
  5.   protected
  6.     $object  = false,
  7.     $objects = false;
  9.   /**
  10.    * Constructor.
  11.    *
  12.    * @param string $pattern       The pattern to match
  13.    * @param array  $defaults      An array of default parameter values
  14.    * @param array  $requirements  An array of requirements for parameters (regexes)
  15.    * @param array  $options       An array of options
  16.    *
  17.    * @see sfRoute
  18.    */
  19.   public function __construct($pattern, array $defaults = array(), array $requirements = array(), array $options = array())
  20.   {
  21.     if (!isset($options['model']))
  22.     {
  23.       throw new InvalidArgumentException(sprintf('You must pass a "model" option for a %s object (%s).', get_class($this), $pattern));
  24.     }
  26.     if (!isset($options['type']))
  27.     {
  28.       throw new InvalidArgumentException(sprintf('You must pass a "type" option for a %s object (%s).', get_class($this), $pattern));
  29.     }
  31.     if (!in_array($options['type'], array('object', 'list')))
  32.     {
  33.       throw new InvalidArgumentException(sprintf('The "type" option can only be "object" or "list", "%s" given (%s).', $options['type'], $pattern));
  34.     }
  36.     parent::__construct($pattern, $defaults, $requirements, $options);
  37.   }
  39.   /**
  40.    * Returns true if the parameters matches this route, false otherwise.
  41.    *
  42.    * @param  mixed  $params  The parameters
  43.    * @param  array  $context The context
  44.    *
  45.    * @return Boolean         true if the parameters matches this route, false otherwise.
  46.    */
  47.   public function matchesParameters($params, $context = array())
  48.   {
  49.     return parent::matchesParameters('object' == $this->options['type'] ? $this->convertObjectToArray($params) : $params);
  50.   }
  52.   /**
  53.    * Generates a URL from the given parameters.
  54.    *
  55.    * @param  mixed   $params    The parameter values
  56.    * @param  array   $context   The context
  57.    * @param  Boolean $absolute  Whether to generate an absolute URL
  58.    *
  59.    * @return string The generated URL
  60.    */
  61.   public function generate($params, $context = array(), $absolute = false)
  62.   {
  63.     return parent::generate('object' == $this->options['type'] ? $this->convertObjectToArray($params) : $params, $context, $absolute);
  64.   }
  66.   /**
  67.    * Gets the object related to the current route and parameters.
  68.    *
  69.    * This method is only accessible if the route is bound and of type "object".
  70.    *
  71.    * @return Object The related object
  72.    */
  73.   public function getObject()
  74.   {
  75.     if (!$this->isBound())
  76.     {
  77.       throw new LogicException('The route is not bound.');
  78.     }
  80.     if ('object' != $this->options['type'])
  81.     {
  82.       throw new LogicException(sprintf('The route "%s" is not of type "object".', $this->pattern));
  83.     }
  85.     if (false !== $this->object)
  86.     {
  87.       return $this->object;
  88.     }
  90.     // check the related object
  91.     if (!($this->object = $this->getObjectForParameters($this->parameters)) && (!isset($this->options['allow_empty']) || !$this->options['allow_empty']))
  92.     {
  93.       throw new sfError404Exception(sprintf('Unable to find the %s object with the following parameters "%s").', $this->options['model'], str_replace("\n", '', var_export($this->filterParameters($this->parameters), true))));
  94.     }
  96.     return $this->object;
  97.   }
  99.   /**
  100.    * Gets the list of objects related to the current route and parameters.
  101.    *
  102.    * This method is only accessible if the route is bound and of type "list".
  103.    *
  104.    * @return array And array of related objects
  105.    */
  106.   public function getObjects()
  107.   {
  108.     if (!$this->isBound())
  109.     {
  110.       throw new LogicException('The route is not bound.');
  111.     }
  113.     if ('list' != $this->options['type'])
  114.     {
  115.       throw new LogicException(sprintf('The route "%s" is not of type "list".', $this->pattern));
  116.     }
  118.     if (false !== $this->objects)
  119.     {
  120.       return $this->objects;
  121.     }
  123.     $this->objects = $this->getObjectsForParameters($this->parameters);
  125.     if (!count($this->objects) && isset($this->options['allow_empty']) && !$this->options['allow_empty'])
  126.     {
  127.       throw new sfError404Exception(sprintf('No %s object found for the following parameters "%s").', $this->options['model'], str_replace("\n", '', var_export($this->filterParameters($this->parameters), true))));
  128.     }
  130.     return $this->objects;
  131.   }
  133.   protected function getObjectForParameters($parameters)
  134.   {
  135.     $className = $this->options['model'];
  137.     if (!isset($this->options['method']))
  138.     {
  139.       throw new InvalidArgumentException(sprintf('You must pass a "method" option for a %s object.', get_class($this)));
  140.     }
  142.     return call_user_func(array($className, $this->options['method']), $this->filterParameters($parameters));
  143.   }
  145.   protected function getObjectsForParameters($parameters)
  146.   {
  147.     $className = $this->options['model'];
  149.     if (!isset($this->options['method']))
  150.     {
  151.       throw new InvalidArgumentException(sprintf('You must pass a "method" option for a %s object.', get_class($this)));
  152.     }
  154.     return call_user_func(array($className, $this->options['method']), $this->filterParameters($parameters));
  155.   }
  157.   protected function filterParameters($parameters)
  158.   {
  159.     if (!is_array($parameters))
  160.     {
  161.       return $parameters;
  162.     }
  164.     $params = array();
  165.     foreach (array_keys($this->variables) as $variable)
  166.     {
  167.       $params[$variable] = $parameters[$variable];
  168.     }
  170.     return $params;
  171.   }
  173.   protected function convertObjectToArray($object)
  174.   {
  175.     if (!$this->compiled)
  176.     {
  177.       $this->compile();
  178.     }
  180.     if (is_array($object))
  181.     {
  182.       if (!isset($object['sf_subject']))
  183.       {
  184.         return $object;
  185.       }
  187.       $parameters = $object;
  188.       $object = $parameters['sf_subject'];
  189.       unset($parameters['sf_subject']);
  190.     }
  191.     else
  192.     {
  193.       $parameters = array();
  194.     }
  196.     return array_merge($parameters, $this->doConvertObjectToArray($object));
  197.   }
  199.   protected function doConvertObjectToArray($object)
  200.   {
  201.     $method = isset($this->options['convert']) ? $this->options['convert'] : 'toParams';
  203.     return $object->$method();
  204.   }
  206.   protected function getRealVariables()
  207.   {
  208.     $variables = array();
  210.     foreach (array_keys($this->variables) as $variable)
  211.     {
  212.       if (0 === strpos($variable, 'sf_') || in_array($variable, array('module', 'action')))
  213.       {
  214.         continue;
  215.       }
  217.       $variables[] = $variable;
  218.     }
  220.     return $variables;
  221.   }
  222. }
Debug toolbar