1. sfFormObject.class.php
  2. /**
 * Base class for forms that deal with a single object.
 * 
 * @package    symfony
 * @subpackage form
 * @author     Kris Wallsmith 
 * @version    SVN: $Id: sfFormObject.class.php 22917 2009-10-10 13:44:53Z Kris.Wallsmith $
 */
  3. abstract class sfFormObject extends BaseForm
  4. {
  5.   protected
  6.     $isNew  = true,
  7.     $object = null;
  9.   /**
  10.    * Returns the current model name.
  11.    * 
  12.    * @return string
  13.    */
  14.   abstract public function getModelName();
  16.   /**
  17.    * Returns the default connection for the current model.
  18.    *
  19.    * @return mixed A database connection
  20.    */
  21.   abstract public function getConnection();
  23.   /**
  24.    * Updates the values of the object with the cleaned up values.
  25.    *
  26.    * If you want to add some logic before updating or update other associated
  27.    * objects, this is the method to override.
  28.    *
  29.    * @param array $values An array of values
  30.    */
  31.   abstract protected function doUpdateObject($values);
  33.   /**
  34.    * Processes cleaned up values.
  35.    *
  36.    * @param  array $values An array of values
  37.    * 
  38.    * @return array An array of cleaned up values
  39.    */
  40.   abstract public function processValues($values);
  42.   /**
  43.    * Returns true if the current form embeds a new object.
  44.    *
  45.    * @return Boolean true if the current form embeds a new object, false otherwise
  46.    */
  47.   public function isNew()
  48.   {
  49.     return $this->isNew;
  50.   }
  52.   /**
  53.    * Returns the current object for this form.
  54.    *
  55.    * @return mixed The current object
  56.    */
  57.   public function getObject()
  58.   {
  59.     return $this->object;
  60.   }
  62.   /**
  63.    * Binds the current form and saves the object to the database in one step.
  64.    *
  65.    * @param  array An array of tainted values to use to bind the form
  66.    * @param  array An array of uploaded files (in the $_FILES or $_GET format)
  67.    * @param  mixed An optional connection object
  68.    *
  69.    * @return Boolean true if the form is valid, false otherwise
  70.    */
  71.   public function bindAndSave($taintedValues, $taintedFiles = null, $con = null)
  72.   {
  73.     $this->bind($taintedValues, $taintedFiles);
  74.     if ($this->isValid())
  75.     {
  76.       $this->save($con);
  78.       return true;
  79.     }
  81.     return false;
  82.   }
  85.   /**
  86.    * Saves the current object to the database.
  87.    *
  88.    * The object saving is done in a transaction and handled by the doSave() method.
  89.    *
  90.    * @param mixed $con An optional connection object
  91.    *
  92.    * @return mixed The current saved object
  93.    *
  94.    * @see doSave()
  95.    * 
  96.    * @throws sfValidatorError If the form is not valid
  97.    */
  98.   public function save($con = null)
  99.   {
  100.     if (!$this->isValid())
  101.     {
  102.       throw $this->getErrorSchema();
  103.     }
  105.     if (null === $con)
  106.     {
  107.       $con = $this->getConnection();
  108.     }
  110.     try
  111.     {
  112.       $con->beginTransaction();
  114.       $this->doSave($con);
  116.       $con->commit();
  117.     }
  118.     catch (Exception $e)
  119.     {
  120.       $con->rollBack();
  122.       throw $e;
  123.     }
  125.     return $this->getObject();
  126.   }
  128.   /**
  129.    * Updates and saves the current object.
  130.    *
  131.    * If you want to add some logic before saving or save other associated
  132.    * objects, this is the method to override.
  133.    *
  134.    * @param mixed $con An optional connection object
  135.    */
  136.   protected function doSave($con = null)
  137.   {
  138.     if (null === $con)
  139.     {
  140.       $con = $this->getConnection();
  141.     }
  143.     $this->updateObject();
  145.     $this->getObject()->save($con);
  147.     // embedded forms
  148.     $this->saveEmbeddedForms($con);
  149.   }
  151.   /**
  152.    * Updates the values of the object with the cleaned up values.
  153.    *
  154.    * @param  array $values An array of values
  155.    *
  156.    * @return mixed The current updated object
  157.    */
  158.   public function updateObject($values = null)
  159.   {
  160.     if (null === $values)
  161.     {
  162.       $values = $this->values;
  163.     }
  165.     $values = $this->processValues($values);
  167.     $this->doUpdateObject($values);
  169.     // embedded forms
  170.     $this->updateObjectEmbeddedForms($values);
  172.     return $this->getObject();
  173.   }
  175.   /**
  176.    * Updates the values of the objects in embedded forms.
  177.    *
  178.    * @param array $values An array of values
  179.    * @param array $forms  An array of forms
  180.    */
  181.   public function updateObjectEmbeddedForms($values, $forms = null)
  182.   {
  183.     if (null === $forms)
  184.     {
  185.       $forms = $this->embeddedForms;
  186.     }
  188.     foreach ($forms as $name => $form)
  189.     {
  190.       if (!isset($values[$name]) || !is_array($values[$name]))
  191.       {
  192.         continue;
  193.       }
  195.       if ($form instanceof sfFormObject)
  196.       {
  197.         $form->updateObject($values[$name]);
  198.       }
  199.       else
  200.       {
  201.         $this->updateObjectEmbeddedForms($values[$name], $form->getEmbeddedForms());
  202.       }
  203.     }
  204.   }
  206.   /**
  207.    * Saves embedded form objects.
  208.    *
  209.    * @param mixed $con   An optional connection object
  210.    * @param array $forms An array of forms
  211.    */
  212.   public function saveEmbeddedForms($con = null, $forms = null)
  213.   {
  214.     if (null === $con)
  215.     {
  216.       $con = $this->getConnection();
  217.     }
  219.     if (null === $forms)
  220.     {
  221.       $forms = $this->embeddedForms;
  222.     }
  224.     foreach ($forms as $form)
  225.     {
  226.       if ($form instanceof sfFormObject)
  227.       {
  228.         $form->saveEmbeddedForms($con);
  229.         $form->getObject()->save($con);
  230.       }
  231.       else
  232.       {
  233.         $this->saveEmbeddedForms($con, $form->getEmbeddedForms());
  234.       }
  235.     }
  236.   }
  238.   /**
  239.    * Renders a form tag suitable for the related object.
  240.    *
  241.    * The method is automatically guessed based on the Doctrine object:
  242.    *
  243.    *  * if the object is new, the method is POST
  244.    *  * if the object already exists, the method is PUT
  245.    *
  246.    * @param  string $url         The URL for the action
  247.    * @param  array  $attributes  An array of HTML attributes
  248.    *
  249.    * @return string An HTML representation of the opening form tag
  250.    *
  251.    * @see sfForm
  252.    */
  253.   public function renderFormTag($url, array $attributes = array())
  254.   {
  255.     if (!isset($attributes['method']))
  256.     {
  257.       $attributes['method'] = $this->isNew() ? 'post' : 'put';
  258.     }
  260.     return parent::renderFormTag($url, $attributes);
  261.   }
  263.   protected function camelize($text)
  264.   {
  265.     return preg_replace(array('#/(.?)#e', '/(^|_|-)+(.)/e'), array("'::'.strtoupper('\\1')", "strtoupper('\\2')"), $text);
  266.   }
  267. }
Debug toolbar