2010-04-15 13:41:42 +01:00
|
|
|
<?php
|
|
|
|
|
|
|
|
namespace Symfony\Components\DomCrawler;
|
|
|
|
|
|
|
|
/*
|
2010-04-24 00:22:16 +01:00
|
|
|
* This file is part of the Symfony package.
|
2010-04-15 13:41:42 +01:00
|
|
|
*
|
|
|
|
* (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.
|
|
|
|
*/
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Form represents an HTML form.
|
|
|
|
*
|
|
|
|
* @package Symfony
|
|
|
|
* @subpackage Components_DomCrawler
|
|
|
|
* @author Fabien Potencier <fabien.potencier@symfony-project.com>
|
|
|
|
*/
|
2010-06-14 08:04:45 +01:00
|
|
|
class Form implements \ArrayAccess
|
2010-04-15 13:41:42 +01:00
|
|
|
{
|
2010-05-06 12:25:53 +01:00
|
|
|
protected $document;
|
|
|
|
protected $button;
|
|
|
|
protected $node;
|
|
|
|
protected $fields;
|
|
|
|
protected $method;
|
|
|
|
protected $host;
|
|
|
|
protected $path;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Constructor.
|
|
|
|
*
|
|
|
|
* @param \DOMNode $node A \DOMNode instance
|
|
|
|
* @param string $method The method to use for the link (if null, it defaults to the method defined by the form)
|
|
|
|
* @param string $host The base URI to use for absolute links (like http://localhost)
|
|
|
|
* @param string $path The base path for relative links (/ by default)
|
|
|
|
*
|
|
|
|
* @throws \LogicException if the node is not a button inside a form tag
|
|
|
|
*/
|
|
|
|
public function __construct(\DOMNode $node, $method = null, $host = null, $path = '/')
|
2010-04-15 13:41:42 +01:00
|
|
|
{
|
2010-05-06 12:25:53 +01:00
|
|
|
$this->button = $node;
|
2010-05-07 15:09:11 +01:00
|
|
|
if ('button' == $node->nodeName || ('input' == $node->nodeName && in_array($node->getAttribute('type'), array('submit', 'button', 'image')))) {
|
2010-05-08 14:32:30 +01:00
|
|
|
do {
|
2010-05-06 12:25:53 +01:00
|
|
|
// use the ancestor form element
|
2010-05-07 15:09:11 +01:00
|
|
|
if (null === $node = $node->parentNode) {
|
2010-05-06 12:25:53 +01:00
|
|
|
throw new \LogicException('The selected node does not have a form ancestor.');
|
|
|
|
}
|
2010-05-07 15:09:11 +01:00
|
|
|
} while ('form' != $node->nodeName);
|
|
|
|
} else {
|
2010-05-06 12:25:53 +01:00
|
|
|
throw new \LogicException(sprintf('Unable to submit on a "%s" tag.', $node->nodeName));
|
|
|
|
}
|
|
|
|
$this->node = $node;
|
|
|
|
$this->method = $method;
|
|
|
|
$this->host = $host;
|
|
|
|
$this->path = empty($path) ? '/' : $path;
|
|
|
|
|
|
|
|
$this->initialize();
|
2010-04-15 13:41:42 +01:00
|
|
|
}
|
2010-05-06 12:25:53 +01:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Gets the form node associated with this form.
|
|
|
|
*
|
|
|
|
* @return \DOMNode A \DOMNode instance
|
|
|
|
*/
|
|
|
|
public function getFormNode()
|
2010-04-15 13:41:42 +01:00
|
|
|
{
|
2010-05-06 12:25:53 +01:00
|
|
|
return $this->node;
|
2010-04-15 13:41:42 +01:00
|
|
|
}
|
2010-05-06 12:25:53 +01:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Gets the value of a field.
|
|
|
|
*
|
|
|
|
* @param string $name The field name
|
|
|
|
*
|
|
|
|
* @throws \InvalidArgumentException if the field does not exist
|
|
|
|
*/
|
|
|
|
public function getValue($name)
|
2010-04-15 13:41:42 +01:00
|
|
|
{
|
2010-05-07 15:09:11 +01:00
|
|
|
if (!$this->hasField($name)) {
|
2010-05-06 12:25:53 +01:00
|
|
|
throw new \InvalidArgumentException(sprintf('The form field "%s" does not exist', $name));
|
|
|
|
}
|
|
|
|
|
|
|
|
return $this->fields[$name]->getValue();
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Sets the value of a field.
|
|
|
|
*
|
|
|
|
* @param string $name The field name
|
|
|
|
* @param string|array $value The value of the field
|
|
|
|
*
|
|
|
|
* @throws \InvalidArgumentException if the field does not exist
|
|
|
|
*/
|
|
|
|
public function setValue($name, $value)
|
|
|
|
{
|
2010-05-07 15:09:11 +01:00
|
|
|
if (!$this->hasField($name)) {
|
2010-05-06 12:25:53 +01:00
|
|
|
throw new \InvalidArgumentException(sprintf('The form field "%s" does not exist', $name));
|
|
|
|
}
|
|
|
|
|
|
|
|
$this->fields[$name]->setValue($value);
|
|
|
|
|
|
|
|
return $this;
|
2010-04-15 13:41:42 +01:00
|
|
|
}
|
|
|
|
|
2010-05-06 12:25:53 +01:00
|
|
|
/**
|
|
|
|
* Sets the value of the fields.
|
|
|
|
*
|
|
|
|
* @param array $values An array of field values
|
|
|
|
*/
|
|
|
|
public function setValues(array $values)
|
2010-04-15 13:41:42 +01:00
|
|
|
{
|
2010-05-07 15:09:11 +01:00
|
|
|
foreach ($values as $name => $value) {
|
2010-05-06 12:25:53 +01:00
|
|
|
$this->setValue($name, $value);
|
|
|
|
}
|
|
|
|
|
|
|
|
return $this;
|
2010-04-15 13:41:42 +01:00
|
|
|
}
|
|
|
|
|
2010-05-06 12:25:53 +01:00
|
|
|
/**
|
|
|
|
* Gets the field values.
|
|
|
|
*
|
|
|
|
* The returned array does not include file fields (@see getFiles).
|
|
|
|
*
|
|
|
|
* @return array An array of field values.
|
|
|
|
*/
|
|
|
|
public function getValues()
|
|
|
|
{
|
|
|
|
$values = array();
|
2010-05-07 15:09:11 +01:00
|
|
|
foreach ($this->fields as $name => $field) {
|
2010-05-08 14:32:30 +01:00
|
|
|
if (!$field instanceof Field\FileFormField && $field->hasValue()) {
|
2010-05-06 12:25:53 +01:00
|
|
|
$values[$name] = $field->getValue();
|
|
|
|
}
|
|
|
|
}
|
2010-04-15 13:41:42 +01:00
|
|
|
|
2010-05-06 12:25:53 +01:00
|
|
|
return $values;
|
|
|
|
}
|
2010-04-15 13:41:42 +01:00
|
|
|
|
2010-05-06 12:25:53 +01:00
|
|
|
/**
|
|
|
|
* Gets the file field values.
|
|
|
|
*
|
|
|
|
* @return array An array of file field values.
|
|
|
|
*/
|
|
|
|
public function getFiles()
|
2010-04-15 13:41:42 +01:00
|
|
|
{
|
2010-05-07 15:09:11 +01:00
|
|
|
if (!in_array($this->getMethod(), array('post', 'put', 'delete'))) {
|
2010-05-06 12:25:53 +01:00
|
|
|
return array();
|
|
|
|
}
|
|
|
|
|
|
|
|
$files = array();
|
2010-05-07 15:09:11 +01:00
|
|
|
foreach ($this->fields as $name => $field) {
|
2010-05-08 14:32:30 +01:00
|
|
|
if ($field instanceof Field\FileFormField) {
|
2010-05-06 12:25:53 +01:00
|
|
|
$files[$name] = $field->getValue();
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
return $files;
|
2010-04-15 13:41:42 +01:00
|
|
|
}
|
|
|
|
|
2010-05-06 12:25:53 +01:00
|
|
|
/**
|
|
|
|
* Gets the field values as PHP.
|
|
|
|
*
|
|
|
|
* This method converts fields with th array notation
|
|
|
|
* (like foo[bar] to arrays) like PHP does.
|
|
|
|
*
|
|
|
|
* @return array An array of field values.
|
|
|
|
*/
|
|
|
|
public function getPhpValues()
|
2010-04-15 13:41:42 +01:00
|
|
|
{
|
2010-05-06 12:25:53 +01:00
|
|
|
$qs = http_build_query($this->getValues());
|
|
|
|
parse_str($qs, $values);
|
|
|
|
|
|
|
|
return $values;
|
2010-04-15 13:41:42 +01:00
|
|
|
}
|
|
|
|
|
2010-05-06 12:25:53 +01:00
|
|
|
/**
|
|
|
|
* Gets the file field values as PHP.
|
|
|
|
*
|
|
|
|
* This method converts fields with th array notation
|
|
|
|
* (like foo[bar] to arrays) like PHP does.
|
|
|
|
*
|
|
|
|
* @return array An array of field values.
|
|
|
|
*/
|
|
|
|
public function getPhpFiles()
|
2010-04-15 13:41:42 +01:00
|
|
|
{
|
2010-05-06 12:25:53 +01:00
|
|
|
$qs = http_build_query($this->getFiles());
|
|
|
|
parse_str($qs, $values);
|
|
|
|
|
|
|
|
return $values;
|
2010-04-15 13:41:42 +01:00
|
|
|
}
|
|
|
|
|
2010-05-06 12:25:53 +01:00
|
|
|
/**
|
|
|
|
* Gets the URI of the form.
|
|
|
|
*
|
|
|
|
* The returned URI is not the same as the form "action" attribute.
|
|
|
|
* This method merges the value if the method is GET to mimics
|
|
|
|
* browser behavior.
|
|
|
|
*
|
|
|
|
* @param Boolean $absolute Whether to return an absolute URI or not (this only works if a base URI has been provided)
|
|
|
|
*
|
|
|
|
* @return string The URI
|
|
|
|
*/
|
|
|
|
public function getUri($absolute = true)
|
2010-04-15 13:41:42 +01:00
|
|
|
{
|
2010-05-06 12:25:53 +01:00
|
|
|
$uri = $this->node->getAttribute('action');
|
|
|
|
|
2010-05-07 15:09:11 +01:00
|
|
|
if (!in_array($this->getMethod(), array('post', 'put', 'delete')) && $queryString = http_build_query($this->getValues(), null, '&')) {
|
2010-05-06 12:25:53 +01:00
|
|
|
$sep = false === strpos($uri, '?') ? '?' : '&';
|
|
|
|
$uri .= $sep.$queryString;
|
|
|
|
}
|
|
|
|
|
2010-05-07 15:09:11 +01:00
|
|
|
if ($uri && '/' !== $uri[0]) {
|
2010-05-06 12:25:53 +01:00
|
|
|
$uri = $this->path.$uri;
|
|
|
|
}
|
|
|
|
|
2010-05-07 15:09:11 +01:00
|
|
|
if ($absolute && null !== $this->host) {
|
2010-05-06 12:25:53 +01:00
|
|
|
return $this->host.$uri;
|
|
|
|
}
|
|
|
|
|
|
|
|
return $uri;
|
2010-04-15 13:41:42 +01:00
|
|
|
}
|
|
|
|
|
2010-05-06 12:25:53 +01:00
|
|
|
/**
|
|
|
|
* Gets the form method.
|
|
|
|
*
|
|
|
|
* If no method is defined in the form, GET is returned.
|
|
|
|
*
|
|
|
|
* @return string The method
|
|
|
|
*/
|
|
|
|
public function getMethod()
|
2010-04-15 13:41:42 +01:00
|
|
|
{
|
2010-05-07 15:09:11 +01:00
|
|
|
if (null !== $this->method) {
|
2010-05-06 12:25:53 +01:00
|
|
|
return $this->method;
|
|
|
|
}
|
|
|
|
|
|
|
|
return $this->node->getAttribute('method') ? strtolower($this->node->getAttribute('method')) : 'get';
|
2010-04-15 13:41:42 +01:00
|
|
|
}
|
|
|
|
|
2010-05-06 12:25:53 +01:00
|
|
|
/**
|
|
|
|
* Returns true if the named field exists.
|
|
|
|
*
|
|
|
|
* @param string $name The field name
|
|
|
|
*
|
|
|
|
* @param Boolean true if the field exists, false otherwise
|
|
|
|
*/
|
|
|
|
public function hasField($name)
|
2010-04-15 13:41:42 +01:00
|
|
|
{
|
2010-05-06 12:25:53 +01:00
|
|
|
return isset($this->fields[$name]);
|
2010-04-15 13:41:42 +01:00
|
|
|
}
|
|
|
|
|
2010-05-06 12:25:53 +01:00
|
|
|
/**
|
|
|
|
* Gets a named field.
|
|
|
|
*
|
|
|
|
* @param string $name The field name
|
|
|
|
*
|
|
|
|
* @return Field\FormField The field instance
|
|
|
|
*
|
|
|
|
* @throws \InvalidArgumentException When field is not present in this form
|
|
|
|
*/
|
|
|
|
public function getField($name)
|
2010-04-15 13:41:42 +01:00
|
|
|
{
|
2010-05-07 15:09:11 +01:00
|
|
|
if (!$this->hasField($name)) {
|
2010-05-06 12:25:53 +01:00
|
|
|
throw new \InvalidArgumentException(sprintf('The form has no "%s" field', $name));
|
|
|
|
}
|
|
|
|
|
|
|
|
return $this->fields[$name];
|
2010-04-15 13:41:42 +01:00
|
|
|
}
|
|
|
|
|
2010-05-06 12:25:53 +01:00
|
|
|
/**
|
|
|
|
* Sets a named field.
|
|
|
|
*
|
|
|
|
* @param string $name The field name
|
|
|
|
*
|
|
|
|
* @return Field\FormField The field instance
|
|
|
|
*/
|
|
|
|
public function setField(Field\FormField $field)
|
2010-04-15 13:41:42 +01:00
|
|
|
{
|
2010-05-06 12:25:53 +01:00
|
|
|
$this->fields[$field->getName()] = $field;
|
2010-04-15 13:41:42 +01:00
|
|
|
}
|
|
|
|
|
2010-05-06 12:25:53 +01:00
|
|
|
/**
|
|
|
|
* Gets all fields.
|
|
|
|
*
|
|
|
|
* @return array An array of fields
|
|
|
|
*/
|
|
|
|
public function getFields()
|
2010-04-15 13:41:42 +01:00
|
|
|
{
|
2010-05-06 12:25:53 +01:00
|
|
|
return $this->fields;
|
2010-04-15 13:41:42 +01:00
|
|
|
}
|
|
|
|
|
2010-05-06 12:25:53 +01:00
|
|
|
protected function initialize()
|
2010-04-15 13:41:42 +01:00
|
|
|
{
|
2010-05-06 12:25:53 +01:00
|
|
|
$this->fields = array();
|
|
|
|
|
|
|
|
$document = new \DOMDocument('1.0', 'UTF-8');
|
|
|
|
$node = $document->importNode($this->node, true);
|
|
|
|
$button = $document->importNode($this->button, true);
|
|
|
|
$root = $document->appendChild($document->createElement('_root'));
|
|
|
|
$root->appendChild($node);
|
|
|
|
$root->appendChild($button);
|
|
|
|
$xpath = new \DOMXPath($document);
|
|
|
|
|
2010-05-07 15:09:11 +01:00
|
|
|
foreach ($xpath->query('descendant::input | descendant::textarea | descendant::select', $root) as $node) {
|
2010-05-08 14:32:30 +01:00
|
|
|
if ($node->hasAttribute('disabled') || !$node->hasAttribute('name')) {
|
2010-05-06 12:25:53 +01:00
|
|
|
continue;
|
|
|
|
}
|
|
|
|
|
|
|
|
$nodeName = $node->nodeName;
|
|
|
|
|
2010-05-07 15:09:11 +01:00
|
|
|
if ($node === $button) {
|
2010-05-06 12:25:53 +01:00
|
|
|
$this->setField(new Field\InputFormField($node));
|
2010-05-07 15:09:11 +01:00
|
|
|
} elseif ('select' == $nodeName || 'input' == $nodeName && 'checkbox' == $node->getAttribute('type')) {
|
2010-05-06 12:25:53 +01:00
|
|
|
$this->setField(new Field\ChoiceFormField($node));
|
2010-05-07 15:09:11 +01:00
|
|
|
} elseif ('input' == $nodeName && 'radio' == $node->getAttribute('type')) {
|
2010-05-08 14:32:30 +01:00
|
|
|
if ($this->hasField($node->getAttribute('name'))) {
|
2010-05-06 12:25:53 +01:00
|
|
|
$this->getField($node->getAttribute('name'))->addChoice($node);
|
2010-05-07 15:09:11 +01:00
|
|
|
} else {
|
2010-05-06 12:25:53 +01:00
|
|
|
$this->setField(new Field\ChoiceFormField($node));
|
|
|
|
}
|
2010-05-07 15:09:11 +01:00
|
|
|
} elseif ('input' == $nodeName && 'file' == $node->getAttribute('type')) {
|
2010-05-06 12:25:53 +01:00
|
|
|
$this->setField(new Field\FileFormField($node));
|
2010-05-07 15:09:11 +01:00
|
|
|
} elseif ('input' == $nodeName && !in_array($node->getAttribute('type'), array('submit', 'button', 'image'))) {
|
2010-05-06 12:25:53 +01:00
|
|
|
$this->setField(new Field\InputFormField($node));
|
2010-05-07 15:09:11 +01:00
|
|
|
} elseif ('textarea' == $nodeName) {
|
2010-05-06 12:25:53 +01:00
|
|
|
$this->setField(new Field\TextareaFormField($node));
|
|
|
|
}
|
2010-04-15 13:41:42 +01:00
|
|
|
}
|
|
|
|
}
|
2010-06-14 08:04:45 +01:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Returns true if the named field exists.
|
|
|
|
*
|
|
|
|
* @param string $name The field name
|
|
|
|
*
|
|
|
|
* @param Boolean true if the field exists, false otherwise
|
|
|
|
*/
|
|
|
|
public function offsetExists($name)
|
|
|
|
{
|
|
|
|
return $this->hasValue($name);
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Gets the value of a field.
|
|
|
|
*
|
|
|
|
* @param string $name The field name
|
|
|
|
*
|
|
|
|
* @throws \InvalidArgumentException if the field does not exist
|
|
|
|
*/
|
|
|
|
public function offsetGet($name)
|
|
|
|
{
|
|
|
|
return $this->getValue($name);
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Sets the value of a field.
|
|
|
|
*
|
|
|
|
* @param string $name The field name
|
|
|
|
* @param string|array $value The value of the field
|
|
|
|
*
|
|
|
|
* @throws \InvalidArgumentException if the field does not exist
|
|
|
|
*/
|
|
|
|
public function offsetSet($name, $value)
|
|
|
|
{
|
|
|
|
$this->setValue($name, $value);
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Unimplemented.
|
|
|
|
*
|
|
|
|
* @param string $name The field name
|
|
|
|
*/
|
|
|
|
public function offsetUnset($name)
|
|
|
|
{
|
|
|
|
throw new \LogicException('The Form fields cannot be removed.');
|
|
|
|
}
|
2010-04-15 13:41:42 +01:00
|
|
|
}
|