1. sfModelGeneratorConfigurationField.class.php
  2. /**
 * Model generator field.
 *
 * @package    symfony
 * @subpackage generator
 * @author     Fabien Potencier 
 * @version    SVN: $Id: sfModelGeneratorConfigurationField.class.php 21908 2009-09-11 12:06:21Z fabien $
 */
  3. class sfModelGeneratorConfigurationField
  4. {
  5.   protected
  6.     $name   = null,
  7.     $config = null;
  9.   /**
  10.    * Constructor.
  11.    *
  12.    * @param string $name   The field name
  13.    * @param array  $config The configuration for this field
  14.    */
  15.   public function __construct($name, $config)
  16.   {
  17.     $this->name = $name;
  18.     $this->config = $config;
  20.     if (isset($this->config['flag']))
  21.     {
  22.       $this->setFlag($this->config['flag']);
  23.       unset($this->config['flag']);
  24.     }
  25.   }
  27.   /**
  28.    * Returns the name of the field.
  29.    *
  30.    * @return string The field name
  31.    */
  32.   public function getName()
  33.   {
  34.     return $this->name;
  35.   }
  37.   /**
  38.    * Returns the configuration value for a given key.
  39.    *
  40.    * If the key is null, the method returns all the configuration array.
  41.    *
  42.    * @param string  $key     A key string
  43.    * @param mixed   $default The default value if the key does not exist
  44.    * @param Boolean $escaped Whether to escape single quote (false by default)
  45.    *
  46.    * @return mixed The configuration value associated with the key
  47.    */
  48.   public function getConfig($key = null, $default = null, $escaped = false)
  49.   {
  50.     if (null === $key)
  51.     {
  52.       return $this->config;
  53.     }
  55.     $value = sfModelGeneratorConfiguration::getFieldConfigValue($this->config, $key, $default);
  57.     return $escaped ? str_replace("'", "\\'", $value) : $value;
  58.   }
  60.   /**
  61.    * Returns the type of the field.
  62.    *
  63.    * @return string The field type
  64.    */
  65.   public function getType()
  66.   {
  67.     return $this->config['type'];
  68.   }
  70.   /**
  71.    * Returns true if the column maps a database column.
  72.    *
  73.    * @return boolean true if the column maps a database column, false otherwise
  74.    */
  75.   public function isReal()
  76.   {
  77.     return isset($this->config['is_real']) ? $this->config['is_real'] : false;
  78.   }
  80.   /**
  81.    * Returns true if the column is a partial.
  82.    *
  83.    * @return boolean true if the column is a partial, false otherwise
  84.    */
  85.   public function isPartial()
  86.   {
  87.     return isset($this->config['is_partial']) ? $this->config['is_partial'] : false;
  88.   }
  90.   /**
  91.    * Sets or unsets the partial flag.
  92.    *
  93.    * @param Boolean $boolean true if the field is a partial, false otherwise
  94.    */
  95.   public function setPartial($boolean)
  96.   {
  97.     $this->config['is_partial'] = $boolean;
  98.   }
  100.   /**
  101.    * Returns true if the column is a component.
  102.    *
  103.    * @return boolean true if the column is a component, false otherwise
  104.    */
  105.   public function isComponent()
  106.   {
  107.     return isset($this->config['is_component']) ? $this->config['is_component'] : false;
  108.   }
  110.   /**
  111.    * Sets or unsets the component flag.
  112.    *
  113.    * @param Boolean $boolean true if the field is a component, false otherwise
  114.    */
  115.   public function setComponent($boolean)
  116.   {
  117.     $this->config['is_component'] = $boolean;
  118.   }
  120.   /**
  121.    * Returns true if the column has a link.
  122.    *
  123.    * @return boolean true if the column has a link, false otherwise
  124.    */
  125.   public function isLink()
  126.   {
  127.     return isset($this->config['is_link']) ? $this->config['is_link'] : false;
  128.   }
  130.   /**
  131.    * Sets or unsets the link flag.
  132.    *
  133.    * @param Boolean $boolean true if the field is a link, false otherwise
  134.    */
  135.   public function setLink($boolean)
  136.   {
  137.     $this->config['is_link'] = $boolean;
  138.   }
  140.   /**
  141.    * Sets the list renderer for the field.
  142.    *
  143.    * @param mixed $renderer A PHP callable
  144.    */
  145.   public function setRenderer($renderer)
  146.   {
  147.     $this->config['renderer'] = $renderer;
  148.   }
  150.   /**
  151.    * Gets the list renderer for the field.
  152.    *
  153.    * @return mixed A PHP callable
  154.    */
  155.   public function getRenderer()
  156.   {
  157.     return isset($this->config['renderer']) ? $this->config['renderer'] : null;
  158.   }
  160.   /**
  161.    * Sets the list renderer arguments for the field.
  162.    *
  163.    * @param array $arguments An array of arguments to pass to the renderer
  164.    */
  165.   public function setRendererArguments(array $arguments)
  166.   {
  167.     $this->config['renderer_arguments'] = $arguments;
  168.   }
  170.   /**
  171.    * Gets the list renderer arguments for the field.
  172.    *
  173.    * @return array An array of arguments to pass to the renderer
  174.    */
  175.   public function getRendererArguments()
  176.   {
  177.     return isset($this->config['renderer_arguments']) ? $this->config['renderer_arguments'] : array();
  178.   }
  180.   static public function splitFieldWithFlag($field)
  181.   {
  182.     if (in_array($flag = $field[0], array('=', '_', '~')))
  183.     {
  184.       $field = substr($field, 1);
  185.     }
  186.     else
  187.     {
  188.       $flag = null;
  189.     }
  191.     return array($field, $flag);
  192.   }
  194.   /**
  195.    * Sets a flag.
  196.    *
  197.    * The flag can be =, _, or ~.
  198.    *
  199.    * @param string $flag The flag
  200.    */
  201.   public function setFlag($flag)
  202.   {
  203.     if (null === $flag)
  204.     {
  205.       return;
  206.     }
  208.     switch ($flag)
  209.     {
  210.       case '=':
  211.         $this->setLink(true);
  212.         break;
  213.       case '_':
  214.         $this->setPartial(true);
  215.         break;
  216.       case '~':
  217.         $this->setComponent(true);
  218.         break;
  219.       default:
  220.         throw new InvalidArgumentException(sprintf('Flag "%s" does not exist.', $flag));
  221.     }
  222.   }
  224.   /**
  225.    * Gets the flag associated with the field.
  226.    *
  227.    * The flag will be
  228.    *
  229.    *   * = for a link
  230.    *   * _ for a partial
  231.    *   * ~ for a component
  232.    *
  233.    * @return string The flag
  234.    */
  235.   public function getFlag()
  236.   {
  237.     if ($this->isLink())
  238.     {
  239.       return '=';
  240.     }
  241.     else if ($this->isPartial())
  242.     {
  243.       return '_';
  244.     }
  245.     else if ($this->isComponent())
  246.     {
  247.       return '~';
  248.     }
  250.     return '';
  251.   }
  252. }
Debug toolbar