FormField.php 2.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112
  1. <?php
  2. /*
  3. * This file is part of the Symfony package.
  4. *
  5. * (c) Fabien Potencier <fabien@symfony.com>
  6. *
  7. * For the full copyright and license information, please view the LICENSE
  8. * file that was distributed with this source code.
  9. */
  10. namespace Symfony\Component\DomCrawler\Field;
  11. /**
  12. * FormField is the abstract class for all form fields.
  13. *
  14. * @author Fabien Potencier <fabien@symfony.com>
  15. */
  16. abstract class FormField
  17. {
  18. /**
  19. * @var \DOMElement
  20. */
  21. protected $node;
  22. /**
  23. * @var string
  24. */
  25. protected $name;
  26. /**
  27. * @var string
  28. */
  29. protected $value;
  30. /**
  31. * @var \DOMDocument
  32. */
  33. protected $document;
  34. /**
  35. * @var \DOMXPath
  36. */
  37. protected $xpath;
  38. /**
  39. * @var bool
  40. */
  41. protected $disabled;
  42. /**
  43. * @param \DOMElement $node The node associated with this field
  44. */
  45. public function __construct(\DOMElement $node)
  46. {
  47. $this->node = $node;
  48. $this->name = $node->getAttribute('name');
  49. $this->xpath = new \DOMXPath($node->ownerDocument);
  50. $this->initialize();
  51. }
  52. /**
  53. * Returns the name of the field.
  54. *
  55. * @return string The name of the field
  56. */
  57. public function getName()
  58. {
  59. return $this->name;
  60. }
  61. /**
  62. * Gets the value of the field.
  63. *
  64. * @return string|array The value of the field
  65. */
  66. public function getValue()
  67. {
  68. return $this->value;
  69. }
  70. /**
  71. * Sets the value of the field.
  72. *
  73. * @param string $value The value of the field
  74. */
  75. public function setValue($value)
  76. {
  77. $this->value = (string) $value;
  78. }
  79. /**
  80. * Returns true if the field should be included in the submitted values.
  81. *
  82. * @return bool true if the field should be included in the submitted values, false otherwise
  83. */
  84. public function hasValue()
  85. {
  86. return true;
  87. }
  88. /**
  89. * Check if the current field is disabled.
  90. *
  91. * @return bool
  92. */
  93. public function isDisabled()
  94. {
  95. return $this->node->hasAttribute('disabled');
  96. }
  97. /**
  98. * Initializes the form field.
  99. */
  100. abstract protected function initialize();
  101. }