You are here

FormField.php in Zircon Profile 8

Same filename and directory in other branches
  1. 8.0 vendor/symfony/dom-crawler/Field/FormField.php

File

vendor/symfony/dom-crawler/Field/FormField.php
View source
<?php

/*
 * This file is part of the Symfony package.
 *
 * (c) Fabien Potencier <fabien@symfony.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */
namespace Symfony\Component\DomCrawler\Field;


/**
 * FormField is the abstract class for all form fields.
 *
 * @author Fabien Potencier <fabien@symfony.com>
 */
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();

}

Classes

Namesort descending Description
FormField FormField is the abstract class for all form fields.