abstract class FormField in Zircon Profile 8

FormField is the abstract class for all form fields.

@author Fabien Potencier <[e-mail]>

Hierarchy

• class \Symfony\Component\DomCrawler\Field\FormField

3 files declare their use of FormField

BrowserKitDriver.php in vendor/behat/mink-browserkit-driver/src/BrowserKitDriver.php

Form.php in vendor/symfony/dom-crawler/Form.php

FormFieldRegistry.php in vendor/symfony/dom-crawler/FormFieldRegistry.php

File

vendor/symfony/dom-crawler/Field/FormField.php, line 19

Namespace

Symfony\Component\DomCrawler\Field

abstract class FormField {

  /**
   * @var \DOMElement
   */
  protected $node;

  /**
   * @var string
   */
  protected $name;

  /**
   * @var string
   */
  protected $value;

  /**
   * @var \DOMDocument
   */
  protected $document;

  /**
   * @var \DOMXPath
   */
  protected $xpath;

  /**
   * @var bool
   */
  protected $disabled;

  /**
   * Constructor.
   *
   * @param \DOMElement $node The node associated with this field
   */
  public function __construct(\DOMElement $node) {
    $this->node = $node;
    $this->name = $node
      ->getAttribute('name');
    $this->xpath = new \DOMXPath($node->ownerDocument);
    $this
      ->initialize();
  }

  /**
   * Returns the name of the field.
   *
   * @return string The name of the field
   */
  public function getName() {
    return $this->name;
  }

  /**
   * Gets the value of the field.
   *
   * @return string|array The value of the field
   */
  public function getValue() {
    return $this->value;
  }

  /**
   * Sets the value of the field.
   *
   * @param string $value The value of the field
   */
  public function setValue($value) {
    $this->value = (string) $value;
  }

  /**
   * Returns true if the field should be included in the submitted values.
   *
   * @return bool true if the field should be included in the submitted values, false otherwise
   */
  public function hasValue() {
    return true;
  }

  /**
   * Check if the current field is disabled.
   *
   * @return bool
   */
  public function isDisabled() {
    return $this->node
      ->hasAttribute('disabled');
  }

  /**
   * Initializes the form field.
   */
  protected abstract function initialize();

}

Members

Name	Modifiers	Type	Description	Overrides
FormField::$disabled	protected	property
FormField::$document	protected	property
FormField::$name	protected	property
FormField::$node	protected	property
FormField::$value	protected	property
FormField::$xpath	protected	property
FormField::getName	public	function	Returns the name of the field.
FormField::getValue	public	function	Gets the value of the field.
FormField::hasValue	public	function	Returns true if the field should be included in the submitted values.	1
FormField::initialize	abstract protected	function	Initializes the form field.	4
FormField::isDisabled	public	function	Check if the current field is disabled.	1
FormField::setValue	public	function	Sets the value of the field.	2
FormField::__construct	public	function	Constructor.