root/branches/1.1/lib/widget/sfWidgetFormSchemaDecorator.class.php

<?php

/*
 * This file is part of the symfony package.
 * (c) Fabien Potencier <fabien.potencier@symfony-project.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

/**
 * sfWidgetFormSchemaDecorator wraps a form schema widget inside a given HTML snippet.
 *
 * @package    symfony
 * @subpackage widget
 * @author     Fabien Potencier <fabien.potencier@symfony-project.com>
 * @version    SVN: $Id$
 */
class sfWidgetFormSchemaDecorator extends sfWidgetFormSchema
{
  protected
    $widget    = null,
    $decorator = '';

  /**
   * Constructor.
   *
   * @param sfWidgetFormSchema $widget     A sfWidgetFormSchema instance
   * @param string             $decorator  A decorator string
   *
   * @see sfWidgetFormSchema
   */
  public function __construct(sfWidgetFormSchema $widget, $decorator)
  {
    $this->widget    = $widget;
    $this->decorator = $decorator;

    parent::__construct();
  }

  /**
   * Returns the decorated widget.
   *
   * @param sfWidget The decorated widget
   */
  public function getWidget()
  {
    return $this->widget;
  }

  /**
   * @param  string $name        The element name
   * @param  string $value       The value displayed in this widget
   * @param  array  $attributes  An array of HTML attributes to be merged with the default HTML attributes
   * @param  array  $errors      An array of errors for the field
   *
   * @see sfWidget
   */
  public function render($name, $values = array(), $attributes = array(), $errors = array())
  {
    return strtr($this->decorator, array('%content%' => $this->widget->render($name, $values, $attributes, $errors)));
  }

  /**
   * @see sfWidgetFormSchema
   */
  public function addFormFormatter($name, sfWidgetFormSchemaFormatter $formatter)
  {
    return $this->widget->addFormFormatter($name, $formatter);
  }

  /**
   * @see sfWidgetFormSchema
   */
  public function getFormFormatters()
  {
    return $this->widget->getFormFormatters();
  }

  /**
   * @see sfWidgetFormSchema
   */
  public function setFormFormatterName($name)
  {
    $this->widget->setFormFormatterName($name);
  }

  /**
   * @see sfWidgetFormSchema
   */
  public function getFormFormatterName()
  {
    return $this->widget->getFormFormatterName();
  }

  /**
   * @see sfWidgetFormSchema
   */
  public function getFormFormatter()
  {
    return $this->widget->getFormFormatter();
  }

  /**
   * @see sfWidgetFormSchema
   */
  public function setNameFormat($format)
  {
    $this->widget->setNameFormat($format);
  }

  /**
   * @see sfWidgetFormSchema
   */
  public function getNameFormat()
  {
    return $this->widget->getNameFormat();
  }

  /**
   * @see sfWidgetFormSchema
   */
  public function setLabels($labels)
  {
    $this->widget->setLabels($labels);
  }

  /**
   * @see sfWidgetFormSchema
   */
  public function getLabels()
  {
    return $this->widget->getLabels();
  }

  /**
   * @see sfWidgetFormSchema
   */
  public function setLabel($name, $value)
  {
    $this->widget->setLabel($name, $value);
  }

  /**
   * @see sfWidgetFormSchema
   */
  public function getLabel($name)
  {
    return $this->widget->getLabel($name);
  }

  /**
   * @see sfWidgetFormSchema
   */
  public function setHelps($helps)
  {
    $this->widget->setHelps($helps);
  }

  /**
   * @see sfWidgetFormSchema
   */
  public function getHelps()
  {
    return $this->widget->getHelps();
  }

  /**
   * @see sfWidgetFormSchema
   */
  public function setHelp($name, $help)
  {
    $this->widget->setHelp($name, $help);
  }

  /**
   * @see sfWidgetFormSchema
   */
  public function getHelp($name)
  {
    return $this->widget->getHelp($name);
  }

  /**
   * @see sfWidgetFormSchema
   */
  public function needsMultipartForm()
  {
    return $this->widget->needsMultipartForm();
  }

  /**
   * @see sfWidgetFormSchema
   */
  public function renderField($name, $value = null, $attributes = array(), $errors = array())
  {
    return $this->widget->renderField($name, $value, $attributes, $errors);
  }

  /**
   * @see sfWidgetFormSchemaFormatter
   */
  public function generateLabel($name)
  {
    return $this->widget->getFormFormatter()->generateLabel($name);
  }

  /**
   * @see sfWidgetFormSchemaFormatter
   */
  public function generateLabelName($name)
  {
    return $this->widget->getFormFormatter()->generateLabelName($name);
  }

  /**
   * @see sfWidgetFormSchema
   */
  public function generateName($name)
  {
    return $this->widget->generateName($name);
  }

  /**
   * @see sfWidgetFormSchema
   */
  public function getParent()
  {
    return $this->widget->getParent();
  }

  /**
   * @see sfWidgetFormSchema
   */
  public function setParent(sfWidgetFormSchema $parent = null)
  {
    $this->widget->setParent($parent);
  }

  /**
   * @see sfWidgetFormSchema
   */
  public function getFields()
  {
    return $this->widget->getFields();
  }

  /**
   * @see sfWidgetFormSchema
   */
  public function getPositions()
  {
    return $this->widget->getPositions();
  }

  /**
   * @see sfWidgetFormSchema
   */
  public function setPositions($positions)
  {
    $this->widget->setPositions($positions);
  }

  /**
   * @see sfWidgetFormSchema
   */
  public function moveField($field, $action, $pivot = null)
  {
    return $this->widget->moveField($field, $action, $pivot);
  }

  /**
   * @see sfWidgetFormSchema
   */
  public function offsetExists($name)
  {
    return isset($this->widget[$name]);
  }

  /**
   * @see sfWidgetFormSchema
   */
  public function offsetGet($name)
  {
    return $this->widget[$name];
  }

  /**
   * @see sfWidgetFormSchema
   */
  public function offsetSet($name, $widget)
  {
    $this->widget[$name] = $widget;
  }

  /**
   * @see sfWidgetFormSchema
   */
  public function offsetUnset($name)
  {
    unset($this->widget[$name]);
  }

  public function __clone()
  {
    $this->widget = clone $this->widget;
  }
}