FormTest.php 19 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408
  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\Tests\Component\DomCrawler;
  11. use Symfony\Component\DomCrawler\Form;
  12. class FormTest extends \PHPUnit_Framework_TestCase
  13. {
  14. public function testConstructorThrowsExceptionIfTheNodeHasNoFormAncestor()
  15. {
  16. $dom = new \DOMDocument();
  17. $dom->loadHTML('
  18. <html>
  19. <input type="submit" />
  20. <form>
  21. <input type="foo" />
  22. </form>
  23. <button />
  24. </html>
  25. ');
  26. $nodes = $dom->getElementsByTagName('input');
  27. try {
  28. $form = new Form($nodes->item(0));
  29. $this->fail('__construct() throws a \\LogicException if the node has no form ancestor');
  30. } catch (\LogicException $e) {
  31. $this->assertTrue(true, '__construct() throws a \\LogicException if the node has no form ancestor');
  32. }
  33. try {
  34. $form = new Form($nodes->item(1));
  35. $this->fail('__construct() throws a \\LogicException if the input type is not submit, button, or image');
  36. } catch (\LogicException $e) {
  37. $this->assertTrue(true, '__construct() throws a \\LogicException if the input type is not submit, button, or image');
  38. }
  39. $nodes = $dom->getElementsByTagName('button');
  40. try {
  41. $form = new Form($nodes->item(0));
  42. $this->fail('__construct() throws a \\LogicException if the input type is not submit, button, or image');
  43. } catch (\LogicException $e) {
  44. $this->assertTrue(true, '__construct() throws a \\LogicException if the input type is not submit, button, or image');
  45. }
  46. }
  47. /**
  48. * @dataProvider provideInitializeValues
  49. */
  50. public function testConstructor($message, $form, $values)
  51. {
  52. $form = $this->createForm('<form>'.$form.'</form>');
  53. $this->assertEquals($values, array_map(function ($field) { return array(get_class($field), $field->getValue()); }, $form->all()), '->getDefaultValues() '.$message);
  54. }
  55. public function provideInitializeValues()
  56. {
  57. return array(
  58. array(
  59. 'does not take into account input fields without a name attribute',
  60. '<input type="text" value="foo" />
  61. <input type="submit" />',
  62. array(),
  63. ),
  64. array(
  65. 'does not take into account disabled input fields',
  66. '<input type="text" name="foo" value="foo" disabled="disabled" />
  67. <input type="submit" />',
  68. array(),
  69. ),
  70. array(
  71. 'appends the submitted button value',
  72. '<input type="submit" name="bar" value="bar" />',
  73. array('bar' => array('Symfony\\Component\\DomCrawler\\Field\\InputFormField', 'bar')),
  74. ),
  75. array(
  76. 'appends the submitted button value but not other submit buttons',
  77. '<input type="submit" name="bar" value="bar" />
  78. <input type="submit" name="foobar" value="foobar" />',
  79. array('foobar' => array('Symfony\\Component\\DomCrawler\\Field\\InputFormField', 'foobar')),
  80. ),
  81. array(
  82. 'returns textareas',
  83. '<textarea name="foo">foo</textarea>
  84. <input type="submit" />',
  85. array('foo' => array('Symfony\\Component\\DomCrawler\\Field\\TextareaFormField', 'foo')),
  86. ),
  87. array(
  88. 'returns inputs',
  89. '<input type="text" name="foo" value="foo" />
  90. <input type="submit" />',
  91. array('foo' => array('Symfony\\Component\\DomCrawler\\Field\\InputFormField', 'foo')),
  92. ),
  93. array(
  94. 'returns checkboxes',
  95. '<input type="checkbox" name="foo" value="foo" checked="checked" />
  96. <input type="submit" />',
  97. array('foo' => array('Symfony\\Component\\DomCrawler\\Field\\ChoiceFormField', 'foo')),
  98. ),
  99. array(
  100. 'returns not-checked checkboxes',
  101. '<input type="checkbox" name="foo" value="foo" />
  102. <input type="submit" />',
  103. array('foo' => array('Symfony\\Component\\DomCrawler\\Field\\ChoiceFormField', false)),
  104. ),
  105. array(
  106. 'returns radio buttons',
  107. '<input type="radio" name="foo" value="foo" />
  108. <input type="radio" name="foo" value="bar" checked="bar" />
  109. <input type="submit" />',
  110. array('foo' => array('Symfony\\Component\\DomCrawler\\Field\\ChoiceFormField', 'bar')),
  111. ),
  112. array(
  113. 'returns file inputs',
  114. '<input type="file" name="foo" />
  115. <input type="submit" />',
  116. array('foo' => array('Symfony\\Component\\DomCrawler\\Field\\FileFormField', array('name' => '', 'type' => '', 'tmp_name' => '', 'error' => 4, 'size' => 0))),
  117. ),
  118. );
  119. }
  120. public function testGetFormNode()
  121. {
  122. $dom = new \DOMDocument();
  123. $dom->loadHTML('<html><form><input type="submit" /></form></html>');
  124. $form = new Form($dom->getElementsByTagName('input')->item(0));
  125. $this->assertSame($dom->getElementsByTagName('form')->item(0), $form->getFormNode(), '->getFormNode() returns the form node associated with this form');
  126. }
  127. public function testGetMethod()
  128. {
  129. $form = $this->createForm('<form><input type="submit" /></form>');
  130. $this->assertEquals('get', $form->getMethod(), '->getMethod() returns get if no method is defined');
  131. $form = $this->createForm('<form method="post"><input type="submit" /></form>');
  132. $this->assertEquals('post', $form->getMethod(), '->getMethod() returns the method attribute value of the form');
  133. $form = $this->createForm('<form method="post"><input type="submit" /></form>', 'put');
  134. $this->assertEquals('put', $form->getMethod(), '->getMethod() returns the method defined in the constructor if provided');
  135. }
  136. public function testGetSetValue()
  137. {
  138. $form = $this->createForm('<form><input type="text" name="foo" value="foo" /><input type="submit" /></form>');
  139. $this->assertEquals('foo', $form['foo']->getValue(), '->offsetGet() returns the value of a form field');
  140. $form['foo'] = 'bar';
  141. $this->assertEquals('bar', $form['foo']->getValue(), '->offsetSet() changes the value of a form field');
  142. try {
  143. $form['foobar'] = 'bar';
  144. $this->fail('->offsetSet() throws an \InvalidArgumentException exception if the field does not exist');
  145. } catch (\InvalidArgumentException $e) {
  146. $this->assertTrue(true, '->offsetSet() throws an \InvalidArgumentException exception if the field does not exist');
  147. }
  148. try {
  149. $form['foobar'];
  150. $this->fail('->offsetSet() throws an \InvalidArgumentException exception if the field does not exist');
  151. } catch (\InvalidArgumentException $e) {
  152. $this->assertTrue(true, '->offsetSet() throws an \InvalidArgumentException exception if the field does not exist');
  153. }
  154. }
  155. public function testOffsetUnset()
  156. {
  157. $form = $this->createForm('<form><input type="text" name="foo" value="foo" /><input type="submit" /></form>');
  158. unset($form['foo']);
  159. $this->assertFalse(isset($form['foo']), '->offsetUnset() removes a field');
  160. }
  161. public function testOffsetExists()
  162. {
  163. $form = $this->createForm('<form><input type="text" name="foo" value="foo" /><input type="submit" /></form>');
  164. $this->assertTrue(isset($form['foo']), '->offsetExists() return true if the field exists');
  165. $this->assertFalse(isset($form['bar']), '->offsetExists() return false if the field does not exist');
  166. }
  167. public function testGetValues()
  168. {
  169. $form = $this->createForm('<form><input type="text" name="foo[bar]" value="foo" /><input type="text" name="bar" value="bar" /><input type="submit" /></form>');
  170. $this->assertEquals(array('foo[bar]' => 'foo', 'bar' => 'bar'), $form->getValues(), '->getValues() returns all form field values');
  171. $form = $this->createForm('<form><input type="checkbox" name="foo" value="foo" /><input type="text" name="bar" value="bar" /><input type="submit" /></form>');
  172. $this->assertEquals(array('bar' => 'bar'), $form->getValues(), '->getValues() does not include not-checked checkboxes');
  173. $form = $this->createForm('<form><input type="file" name="foo" value="foo" /><input type="text" name="bar" value="bar" /><input type="submit" /></form>');
  174. $this->assertEquals(array('bar' => 'bar'), $form->getValues(), '->getValues() does not include file input fields');
  175. }
  176. public function testSetValues()
  177. {
  178. $form = $this->createForm('<form><input type="checkbox" name="foo" value="foo" checked="checked" /><input type="text" name="bar" value="bar" /><input type="submit" /></form>');
  179. $form->setValues(array('foo' => false, 'bar' => 'foo'));
  180. $this->assertEquals(array('bar' => 'foo'), $form->getValues(), '->setValues() sets the values of fields');
  181. }
  182. public function testGetPhpValues()
  183. {
  184. $form = $this->createForm('<form><input type="text" name="foo[bar]" value="foo" /><input type="text" name="bar" value="bar" /><input type="submit" /></form>');
  185. $this->assertEquals(array('foo' => array('bar' => 'foo'), 'bar' => 'bar'), $form->getPhpValues(), '->getPhpValues() converts keys with [] to arrays');
  186. }
  187. public function testGetFiles()
  188. {
  189. $form = $this->createForm('<form><input type="file" name="foo[bar]" /><input type="text" name="bar" value="bar" /><input type="submit" /></form>');
  190. $this->assertEquals(array(), $form->getFiles(), '->getFiles() returns an empty array if method is get');
  191. $form = $this->createForm('<form method="post"><input type="file" name="foo[bar]" /><input type="text" name="bar" value="bar" /><input type="submit" /></form>');
  192. $this->assertEquals(array('foo[bar]' => array('name' => '', 'type' => '', 'tmp_name' => '', 'error' => 4, 'size' => 0)), $form->getFiles(), '->getFiles() only returns file fields');
  193. }
  194. public function testGetPhpFiles()
  195. {
  196. $form = $this->createForm('<form method="post"><input type="file" name="foo[bar]" /><input type="text" name="bar" value="bar" /><input type="submit" /></form>');
  197. $this->assertEquals(array('foo' => array('bar' => array('name' => '', 'type' => '', 'tmp_name' => '', 'error' => 4, 'size' => 0))), $form->getPhpFiles(), '->getPhpFiles() converts keys with [] to arrays');
  198. }
  199. /**
  200. * @dataProvider provideGetUriValues
  201. */
  202. public function testGetUri($message, $form, $values, $uri)
  203. {
  204. $form = $this->createForm($form);
  205. $form->setValues($values);
  206. $this->assertEquals($uri, $form->getUri(), '->getUri() '.$message);
  207. }
  208. public function testGetUriActionAbsolute()
  209. {
  210. $formHtml='<form id="login_form" action="https://login.foo.com/login.php?login_attempt=1" method="POST"><input type="text" name="foo" value="foo" /><input type="submit" /></form>';
  211. $form = $this->createForm($formHtml);
  212. $this->assertEquals('https://login.foo.com/login.php?login_attempt=1', $form->getUri(), '->getUri() returns absolute URIs set in the action form');
  213. $form = $this->createForm($formHtml, null, 'https://login.foo.com');
  214. $this->assertEquals('https://login.foo.com/login.php?login_attempt=1', $form->getUri(), '->getUri() returns absolute URIs set in the action form');
  215. $form = $this->createForm($formHtml, null, 'https://login.foo.com', '/bar/');
  216. $this->assertEquals('https://login.foo.com/login.php?login_attempt=1', $form->getUri(), '->getUri() returns absolute URIs set in the action form');
  217. // The action URI haven't the same domain Host have an another domain as Host
  218. $form = $this->createForm($formHtml, null, 'https://www.foo.com');
  219. $this->assertEquals('https://login.foo.com/login.php?login_attempt=1', $form->getUri(), '->getUri() returns absolute URIs set in the action form');
  220. $form = $this->createForm($formHtml, null, 'https://www.foo.com', '/bar/');
  221. $this->assertEquals('https://login.foo.com/login.php?login_attempt=1', $form->getUri(), '->getUri() returns absolute URIs set in the action form');
  222. }
  223. public function testGetUriAbsolute()
  224. {
  225. $form = $this->createForm('<form action="foo"><input type="submit" /></form>', null, 'http://localhost', '/foo/');
  226. $this->assertEquals('http://localhost/foo/foo', $form->getUri(true), '->getUri() returns absolute URIs');
  227. $form = $this->createForm('<form action="/foo"><input type="submit" /></form>', null, 'http://localhost', '/foo/');
  228. $this->assertEquals('http://localhost/foo', $form->getUri(true), '->getUri() returns absolute URIs');
  229. $form = $this->createForm('<form action="/foo"><input type="submit" /></form>');
  230. $this->assertEquals('/foo', $form->getUri(true), '->getUri() returns absolute URIs only if the host has been defined in the constructor');
  231. $form = $this->createForm('<form action="foo"><input type="submit" /></form>');
  232. $this->assertEquals('/foo', $form->getUri(true), '->getUri() returns absolute URIs only if the host has been defined in the constructor');
  233. }
  234. public function testGetUriWithOnlyQueryString()
  235. {
  236. $form = $this->createForm('<form action="?get=param"><input type="submit" /></form>', null, 'http://localhost', '/foo/bar');
  237. $this->assertEquals('http://localhost/foo/bar?get=param', $form->getUri(true), '->getUri() returns absolute URIs only if the host has been defined in the constructor');
  238. $this->assertEquals('/foo/bar?get=param', $form->getUri(false), '->getUri() returns absolute URIs only if the host has been defined in the constructor');
  239. }
  240. public function testGetUriWithoutAction()
  241. {
  242. $form = $this->createForm('<form><input type="submit" /></form>', null, 'http://localhost', '/foo/bar');
  243. $this->assertEquals('http://localhost/foo/bar', $form->getUri(true), '->getUri() returns path if no action defined');
  244. $this->assertEquals('/foo/bar', $form->getUri(false), '->getUri() returns path if no action defined');
  245. }
  246. public function provideGetUriValues()
  247. {
  248. return array(
  249. array(
  250. 'returns the URI of the form',
  251. '<form action="/foo"><input type="submit" /></form>',
  252. array(),
  253. '/foo'
  254. ),
  255. array(
  256. 'appends the form values if the method is get',
  257. '<form action="/foo"><input type="text" name="foo" value="foo" /><input type="submit" /></form>',
  258. array(),
  259. '/foo?foo=foo'
  260. ),
  261. array(
  262. 'appends the form values and merges the submitted values',
  263. '<form action="/foo"><input type="text" name="foo" value="foo" /><input type="submit" /></form>',
  264. array('foo' => 'bar'),
  265. '/foo?foo=bar'
  266. ),
  267. array(
  268. 'does not append values if the method is post',
  269. '<form action="/foo" method="post"><input type="text" name="foo" value="foo" /><input type="submit" /></form>',
  270. array(),
  271. '/foo'
  272. ),
  273. array(
  274. 'appends the form values to an existing query string',
  275. '<form action="/foo?bar=bar"><input type="text" name="foo" value="foo" /><input type="submit" /></form>',
  276. array(),
  277. '/foo?bar=bar&foo=foo'
  278. ),
  279. array(
  280. 'returns an empty URI if the action is empty',
  281. '<form><input type="submit" /></form>',
  282. array(),
  283. '/',
  284. ),
  285. array(
  286. 'appends the form values even if the action is empty',
  287. '<form><input type="text" name="foo" value="foo" /><input type="submit" /></form>',
  288. array(),
  289. '/?foo=foo',
  290. ),
  291. array(
  292. 'chooses the path if the action attribute value is a sharp (#)',
  293. '<form action="#" method="post"><input type="text" name="foo" value="foo" /><input type="submit" /></form>',
  294. array(),
  295. '/',
  296. ),
  297. );
  298. }
  299. public function testHas()
  300. {
  301. $form = $this->createForm('<form method="post"><input type="text" name="bar" value="bar" /><input type="submit" /></form>');
  302. $this->assertFalse($form->has('foo'), '->has() returns false if a field is not in the form');
  303. $this->assertTrue($form->has('bar'), '->has() returns true if a field is in the form');
  304. }
  305. public function testRemove()
  306. {
  307. $form = $this->createForm('<form method="post"><input type="text" name="bar" value="bar" /><input type="submit" /></form>');
  308. $form->remove('bar');
  309. $this->assertFalse($form->has('bar'), '->remove() removes a field');
  310. }
  311. public function testGet()
  312. {
  313. $form = $this->createForm('<form method="post"><input type="text" name="bar" value="bar" /><input type="submit" /></form>');
  314. $this->assertEquals('Symfony\\Component\\DomCrawler\\Field\\InputFormField', get_class($form->get('bar')), '->get() returns the field object associated with the given name');
  315. try {
  316. $form->get('foo');
  317. $this->fail('->get() throws an \InvalidArgumentException if the field does not exist');
  318. } catch (\InvalidArgumentException $e) {
  319. $this->assertTrue(true, '->get() throws an \InvalidArgumentException if the field does not exist');
  320. }
  321. }
  322. public function testAll()
  323. {
  324. $form = $this->createForm('<form method="post"><input type="text" name="bar" value="bar" /><input type="submit" /></form>');
  325. $fields = $form->all();
  326. $this->assertEquals(1, count($fields), '->all() return an array of form field objects');
  327. $this->assertEquals('Symfony\\Component\\DomCrawler\\Field\\InputFormField', get_class($fields['bar']), '->all() return an array of form field objects');
  328. }
  329. public function testBase()
  330. {
  331. $dom = new \DOMDocument();
  332. $dom->loadHTML('<html><form method="post" action="foo.php"><input type="text" name="bar" value="bar" /><input type="submit" /></form></html>');
  333. $nodes = $dom->getElementsByTagName('input');
  334. $form = new Form($nodes->item($nodes->length - 1), null, 'http://www.bar.com/foobar/', '/', 'http://www.foo.com/');
  335. $this->assertEquals('http://www.foo.com/foo.php', $form->getUri());
  336. }
  337. protected function createForm($form, $method = null, $host = null, $path = '/')
  338. {
  339. $dom = new \DOMDocument();
  340. $dom->loadHTML('<html>'.$form.'</html>');
  341. $nodes = $dom->getElementsByTagName('input');
  342. return new Form($nodes->item($nodes->length - 1), $method, $host, $path);
  343. }
  344. }