PageRenderTime 52ms CodeModel.GetById 19ms RepoModel.GetById 0ms app.codeStats 0ms

/lib/tests/formslib_test.php

http://github.com/moodle/moodle
PHP | 1000 lines | 746 code | 112 blank | 142 comment | 15 complexity | 42675f80ea723b90d3fcb6d432ce182c MD5 | raw file
Possible License(s): MIT, AGPL-3.0, MPL-2.0-no-copyleft-exception, LGPL-3.0, GPL-3.0, Apache-2.0, LGPL-2.1, BSD-3-Clause
  1. <?php
  2. // This file is part of Moodle - http://moodle.org/
  3. //
  4. // Moodle is free software: you can redistribute it and/or modify
  5. // it under the terms of the GNU General Public License as published by
  6. // the Free Software Foundation, either version 3 of the License, or
  7. // (at your option) any later version.
  8. //
  9. // Moodle is distributed in the hope that it will be useful,
  10. // but WITHOUT ANY WARRANTY; without even the implied warranty of
  11. // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  12. // GNU General Public License for more details.
  13. //
  14. // You should have received a copy of the GNU General Public License
  15. // along with Moodle. If not, see <http://www.gnu.org/licenses/>.
  16. /**
  17. * Unit tests for /lib/formslib.php.
  18. *
  19. * @package core_form
  20. * @category phpunit
  21. * @copyright 2011 Sam Hemelryk
  22. * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23. */
  24. defined('MOODLE_INTERNAL') || die();
  25. global $CFG;
  26. require_once($CFG->libdir . '/formslib.php');
  27. require_once($CFG->libdir . '/form/radio.php');
  28. require_once($CFG->libdir . '/form/select.php');
  29. require_once($CFG->libdir . '/form/text.php');
  30. class core_formslib_testcase extends advanced_testcase {
  31. public function test_require_rule() {
  32. global $CFG;
  33. $strictformsrequired = null;
  34. if (isset($CFG->strictformsrequired)) {
  35. $strictformsrequired = $CFG->strictformsrequired;
  36. }
  37. $rule = new MoodleQuickForm_Rule_Required();
  38. // First run the tests with strictformsrequired off.
  39. $CFG->strictformsrequired = false;
  40. // Passes.
  41. $this->assertTrue($rule->validate('Something'));
  42. $this->assertTrue($rule->validate("Something\nmore"));
  43. $this->assertTrue($rule->validate("\nmore"));
  44. $this->assertTrue($rule->validate(" more "));
  45. $this->assertTrue($rule->validate('ш'));
  46. $this->assertTrue($rule->validate("の"));
  47. $this->assertTrue($rule->validate("0"));
  48. $this->assertTrue($rule->validate(0));
  49. $this->assertTrue($rule->validate(true));
  50. $this->assertTrue($rule->validate(' '));
  51. $this->assertTrue($rule->validate(' '));
  52. $this->assertTrue($rule->validate("\t"));
  53. $this->assertTrue($rule->validate("\n"));
  54. $this->assertTrue($rule->validate("\r"));
  55. $this->assertTrue($rule->validate("\r\n"));
  56. $this->assertTrue($rule->validate(" \t \n \r "));
  57. $this->assertTrue($rule->validate('<p></p>'));
  58. $this->assertTrue($rule->validate('<p> </p>'));
  59. $this->assertTrue($rule->validate('<p>x</p>'));
  60. $this->assertTrue($rule->validate('<img src="smile.jpg" alt="smile" />'));
  61. $this->assertTrue($rule->validate('<img src="smile.jpg" alt="smile"/>'));
  62. $this->assertTrue($rule->validate('<img src="smile.jpg" alt="smile"></img>'));
  63. $this->assertTrue($rule->validate('<hr />'));
  64. $this->assertTrue($rule->validate('<hr/>'));
  65. $this->assertTrue($rule->validate('<hr>'));
  66. $this->assertTrue($rule->validate('<hr></hr>'));
  67. $this->assertTrue($rule->validate('<br />'));
  68. $this->assertTrue($rule->validate('<br/>'));
  69. $this->assertTrue($rule->validate('<br>'));
  70. $this->assertTrue($rule->validate('&nbsp;'));
  71. // Fails.
  72. $this->assertFalse($rule->validate(''));
  73. $this->assertFalse($rule->validate(false));
  74. $this->assertFalse($rule->validate(null));
  75. // Now run the same tests with it on to make sure things work as expected.
  76. $CFG->strictformsrequired = true;
  77. // Passes.
  78. $this->assertTrue($rule->validate('Something'));
  79. $this->assertTrue($rule->validate("Something\nmore"));
  80. $this->assertTrue($rule->validate("\nmore"));
  81. $this->assertTrue($rule->validate(" more "));
  82. $this->assertTrue($rule->validate("0"));
  83. $this->assertTrue($rule->validate('ш'));
  84. $this->assertTrue($rule->validate("の"));
  85. $this->assertTrue($rule->validate(0));
  86. $this->assertTrue($rule->validate(true));
  87. $this->assertTrue($rule->validate('<p>x</p>'));
  88. $this->assertTrue($rule->validate('<img src="smile.jpg" alt="smile" />'));
  89. $this->assertTrue($rule->validate('<img src="smile.jpg" alt="smile"/>'));
  90. $this->assertTrue($rule->validate('<img src="smile.jpg" alt="smile"></img>'));
  91. $this->assertTrue($rule->validate('<hr />'));
  92. $this->assertTrue($rule->validate('<hr/>'));
  93. $this->assertTrue($rule->validate('<hr>'));
  94. $this->assertTrue($rule->validate('<hr></hr>'));
  95. // Fails.
  96. $this->assertFalse($rule->validate(' '));
  97. $this->assertFalse($rule->validate(' '));
  98. $this->assertFalse($rule->validate("\t"));
  99. $this->assertFalse($rule->validate("\n"));
  100. $this->assertFalse($rule->validate("\r"));
  101. $this->assertFalse($rule->validate("\r\n"));
  102. $this->assertFalse($rule->validate(" \t \n \r "));
  103. $this->assertFalse($rule->validate('<p></p>'));
  104. $this->assertFalse($rule->validate('<p> </p>'));
  105. $this->assertFalse($rule->validate('<br />'));
  106. $this->assertFalse($rule->validate('<br/>'));
  107. $this->assertFalse($rule->validate('<br>'));
  108. $this->assertFalse($rule->validate('&nbsp;'));
  109. $this->assertFalse($rule->validate(''));
  110. $this->assertFalse($rule->validate(false));
  111. $this->assertFalse($rule->validate(null));
  112. if (isset($strictformsrequired)) {
  113. $CFG->strictformsrequired = $strictformsrequired;
  114. }
  115. }
  116. public function test_range_rule() {
  117. global $CFG;
  118. require_once('HTML/QuickForm/Rule/Range.php'); // Requires this pear stuff.
  119. $strictformsrequired = null;
  120. if (isset($CFG->strictformsrequired)) {
  121. $strictformsrequired = $CFG->strictformsrequired;
  122. }
  123. $rule = new HTML_QuickForm_Rule_Range();
  124. // First run the tests with strictformsrequired off.
  125. $CFG->strictformsrequired = false;
  126. // Passes.
  127. $rule->setName('minlength'); // Let's verify some min lengths.
  128. $this->assertTrue($rule->validate('12', 2));
  129. $this->assertTrue($rule->validate('123', 2));
  130. $this->assertTrue($rule->validate('áé', 2));
  131. $this->assertTrue($rule->validate('áéí', 2));
  132. $rule->setName('maxlength'); // Let's verify some max lengths.
  133. $this->assertTrue($rule->validate('1', 2));
  134. $this->assertTrue($rule->validate('12', 2));
  135. $this->assertTrue($rule->validate('á', 2));
  136. $this->assertTrue($rule->validate('áé', 2));
  137. $rule->setName('----'); // Let's verify some ranges.
  138. $this->assertTrue($rule->validate('', array(0, 2)));
  139. $this->assertTrue($rule->validate('1', array(0, 2)));
  140. $this->assertTrue($rule->validate('12', array(0, 2)));
  141. $this->assertTrue($rule->validate('á', array(0, 2)));
  142. $this->assertTrue($rule->validate('áé', array(0, 2)));
  143. // Fail.
  144. $rule->setName('minlength'); // Let's verify some min lengths.
  145. $this->assertFalse($rule->validate('', 2));
  146. $this->assertFalse($rule->validate('1', 2));
  147. $this->assertFalse($rule->validate('á', 2));
  148. $rule->setName('maxlength'); // Let's verify some max lengths.
  149. $this->assertFalse($rule->validate('123', 2));
  150. $this->assertFalse($rule->validate('áéí', 2));
  151. $rule->setName('----'); // Let's verify some ranges.
  152. $this->assertFalse($rule->validate('', array(1, 2)));
  153. $this->assertFalse($rule->validate('123', array(1, 2)));
  154. $this->assertFalse($rule->validate('áéí', array(1, 2)));
  155. // Now run the same tests with it on to make sure things work as expected.
  156. $CFG->strictformsrequired = true;
  157. // Passes.
  158. $rule->setName('minlength'); // Let's verify some min lengths.
  159. $this->assertTrue($rule->validate('12', 2));
  160. $this->assertTrue($rule->validate('123', 2));
  161. $this->assertTrue($rule->validate('áé', 2));
  162. $this->assertTrue($rule->validate('áéí', 2));
  163. $rule->setName('maxlength'); // Let's verify some min lengths.
  164. $this->assertTrue($rule->validate('1', 2));
  165. $this->assertTrue($rule->validate('12', 2));
  166. $this->assertTrue($rule->validate('á', 2));
  167. $this->assertTrue($rule->validate('áé', 2));
  168. $rule->setName('----'); // Let's verify some ranges.
  169. $this->assertTrue($rule->validate('', array(0, 2)));
  170. $this->assertTrue($rule->validate('1', array(0, 2)));
  171. $this->assertTrue($rule->validate('12', array(0, 2)));
  172. $this->assertTrue($rule->validate('á', array(0, 2)));
  173. $this->assertTrue($rule->validate('áé', array(0, 2)));
  174. // Fail.
  175. $rule->setName('minlength'); // Let's verify some min lengths.
  176. $this->assertFalse($rule->validate('', 2));
  177. $this->assertFalse($rule->validate('1', 2));
  178. $this->assertFalse($rule->validate('á', 2));
  179. $rule->setName('maxlength'); // Let's verify some min lengths.
  180. $this->assertFalse($rule->validate('123', 2));
  181. $this->assertFalse($rule->validate('áéí', 2));
  182. $rule->setName('----'); // Let's verify some ranges.
  183. $this->assertFalse($rule->validate('', array(1, 2)));
  184. $this->assertFalse($rule->validate('123', array(1, 2)));
  185. $this->assertFalse($rule->validate('áéí', array(1, 2)));
  186. if (isset($strictformsrequired)) {
  187. $CFG->strictformsrequired = $strictformsrequired;
  188. }
  189. }
  190. public function test_generate_id_select() {
  191. $el = new MoodleQuickForm_select('choose_one', 'Choose one',
  192. array(1 => 'One', '2' => 'Two'));
  193. $el->_generateId();
  194. $this->assertSame('id_choose_one', $el->getAttribute('id'));
  195. }
  196. public function test_generate_id_like_repeat() {
  197. $el = new MoodleQuickForm_text('text[7]', 'Type something');
  198. $el->_generateId();
  199. $this->assertSame('id_text_7', $el->getAttribute('id'));
  200. }
  201. public function test_can_manually_set_id() {
  202. $el = new MoodleQuickForm_text('elementname', 'Type something',
  203. array('id' => 'customelementid'));
  204. $el->_generateId();
  205. $this->assertSame('customelementid', $el->getAttribute('id'));
  206. }
  207. public function test_generate_id_radio() {
  208. $el = new MoodleQuickForm_radio('radio', 'Label', 'Choice label', 'choice_value');
  209. $el->_generateId();
  210. $this->assertSame('id_radio_choice_value', $el->getAttribute('id'));
  211. }
  212. public function test_radio_can_manually_set_id() {
  213. $el = new MoodleQuickForm_radio('radio2', 'Label', 'Choice label', 'choice_value',
  214. array('id' => 'customelementid2'));
  215. $el->_generateId();
  216. $this->assertSame('customelementid2', $el->getAttribute('id'));
  217. }
  218. public function test_generate_id_radio_like_repeat() {
  219. $el = new MoodleQuickForm_radio('repeatradio[2]', 'Label', 'Choice label', 'val');
  220. $el->_generateId();
  221. $this->assertSame('id_repeatradio_2_val', $el->getAttribute('id'));
  222. }
  223. public function test_rendering() {
  224. $form = new formslib_test_form();
  225. ob_start();
  226. $form->display();
  227. $html = ob_get_clean();
  228. $this->assertTag(array('tag'=>'select', 'id'=>'id_choose_one',
  229. 'attributes'=>array('name'=>'choose_one')), $html);
  230. $this->assertTag(array('tag'=>'input', 'id'=>'id_text_0',
  231. 'attributes'=>array('type'=>'text', 'name'=>'text[0]')), $html);
  232. $this->assertTag(array('tag'=>'input', 'id'=>'id_text_1',
  233. 'attributes'=>array('type'=>'text', 'name'=>'text[1]')), $html);
  234. $this->assertTag(array('tag'=>'input', 'id'=>'id_radio_choice_value',
  235. 'attributes'=>array('type'=>'radio', 'name'=>'radio', 'value'=>'choice_value')), $html);
  236. $this->assertTag(array('tag'=>'input', 'id'=>'customelementid2',
  237. 'attributes'=>array('type'=>'radio', 'name'=>'radio2')), $html);
  238. $this->assertTag(array('tag'=>'input', 'id'=>'id_repeatradio_0_2',
  239. 'attributes'=>array('type'=>'radio', 'name'=>'repeatradio[0]', 'value'=>'2')), $html);
  240. $this->assertTag(array('tag'=>'input', 'id'=>'id_repeatradio_2_1',
  241. 'attributes'=>array('type'=>'radio', 'name'=>'repeatradio[2]', 'value'=>'1')), $html);
  242. $this->assertTag(array('tag'=>'input', 'id'=>'id_repeatradio_2_2',
  243. 'attributes'=>array('type'=>'radio', 'name'=>'repeatradio[2]', 'value'=>'2')), $html);
  244. }
  245. public function test_settype_debugging_text() {
  246. $mform = new formslib_settype_debugging_text();
  247. $this->assertDebuggingCalled("Did you remember to call setType() for 'texttest'? Defaulting to PARAM_RAW cleaning.");
  248. // Check form still there though.
  249. $this->expectOutputRegex('/<input[^>]*type="text[^>]*name="texttest/');
  250. $mform->display();
  251. }
  252. public function test_settype_debugging_hidden() {
  253. $mform = new formslib_settype_debugging_hidden();
  254. $this->assertDebuggingCalled("Did you remember to call setType() for 'hiddentest'? Defaulting to PARAM_RAW cleaning.");
  255. // Check form still there though.
  256. $this->expectOutputRegex('/<input[^>]*name="hiddentest[^>]*type="hidden/');
  257. $mform->display();
  258. }
  259. public function test_settype_debugging_url() {
  260. $this->resetAfterTest(true);
  261. $this->setAdminUser();
  262. $mform = new formslib_settype_debugging_url();
  263. $this->assertDebuggingCalled("Did you remember to call setType() for 'urltest'? Defaulting to PARAM_RAW cleaning.");
  264. // Check form still there though.
  265. $this->expectOutputRegex('/<input[^>]*type="url[^>]*name="urltest"/');
  266. $mform->display();
  267. }
  268. public function test_settype_debugging_repeat() {
  269. $mform = new formslib_settype_debugging_repeat();
  270. $this->assertDebuggingCalled("Did you remember to call setType() for 'repeattest[0]'? Defaulting to PARAM_RAW cleaning.");
  271. // Check form still there though.
  272. $this->expectOutputRegex('/<input[^>]*type="text[^>]*name="repeattest/');
  273. $mform->display();
  274. }
  275. public function test_settype_debugging_repeat_ok() {
  276. $mform = new formslib_settype_debugging_repeat_ok();
  277. // No debugging expected here.
  278. $this->expectOutputRegex('/<input[^>]*type="text[^>]*name="repeattest/');
  279. $mform->display();
  280. }
  281. public function test_settype_debugging_group() {
  282. $mform = new formslib_settype_debugging_group();
  283. $this->assertDebuggingCalled("Did you remember to call setType() for 'groupel1'? Defaulting to PARAM_RAW cleaning.");
  284. $this->expectOutputRegex('/<input[^>]*type="text[^>]*name="groupel1"/');
  285. $this->expectOutputRegex('/<input[^>]*type="text[^>]*name="groupel2"/');
  286. $mform->display();
  287. }
  288. public function test_settype_debugging_namedgroup() {
  289. $mform = new formslib_settype_debugging_namedgroup();
  290. $this->assertDebuggingCalled("Did you remember to call setType() for 'namedgroup[groupel1]'? Defaulting to PARAM_RAW cleaning.");
  291. $this->expectOutputRegex('/<input[^>]*type="text[^>]*name="namedgroup\[groupel1\]"/');
  292. $this->expectOutputRegex('/<input[^>]*type="text[^>]*name="namedgroup\[groupel2\]"/');
  293. $mform->display();
  294. }
  295. public function test_settype_debugging_funky_name() {
  296. $mform = new formslib_settype_debugging_funky_name();
  297. $this->assertDebuggingCalled("Did you remember to call setType() for 'blah[foo][bar][1]'? Defaulting to PARAM_RAW cleaning.");
  298. $this->expectOutputRegex('/<input[^>]*type="text[^>]*name="blah\[foo\]\[bar\]\[0\]"/');
  299. $this->expectOutputRegex('/<input[^>]*type="text[^>]*name="blah\[foo\]\[bar\]\[1\]"/');
  300. $mform->display();
  301. }
  302. public function test_settype_debugging_type_inheritance() {
  303. $mform = new formslib_settype_debugging_type_inheritance();
  304. $this->expectOutputRegex('/<input[^>]*type="text[^>]*name="blah\[foo\]\[bar\]\[0\]"/');
  305. $this->expectOutputRegex('/<input[^>]*type="text[^>]*name="blah\[bar\]\[foo\]\[1\]"/');
  306. $this->expectOutputRegex('/<input[^>]*type="text[^>]*name="blah\[any\]\[other\]\[2\]"/');
  307. $mform->display();
  308. }
  309. public function test_settype_debugging_type_group_in_repeat() {
  310. $mform = new formslib_settype_debugging_type_group_in_repeat();
  311. $this->assertDebuggingCalled("Did you remember to call setType() for 'test2[0]'? Defaulting to PARAM_RAW cleaning.");
  312. $this->expectOutputRegex('/<input[^>]*type="text[^>]*name="test1\[0\]"/');
  313. $this->expectOutputRegex('/<input[^>]*type="text[^>]*name="test2\[0\]"/');
  314. $mform->display();
  315. }
  316. public function test_settype_debugging_type_namedgroup_in_repeat() {
  317. $mform = new formslib_settype_debugging_type_namedgroup_in_repeat();
  318. $this->assertDebuggingCalled("Did you remember to call setType() for 'namedgroup[0][test2]'? Defaulting to PARAM_RAW cleaning.");
  319. $this->expectOutputRegex('/<input[^>]*type="text[^>]*name="namedgroup\[0\]\[test1\]"/');
  320. $this->expectOutputRegex('/<input[^>]*type="text[^>]*name="namedgroup\[0\]\[test2\]"/');
  321. $mform->display();
  322. }
  323. public function test_type_cleaning() {
  324. $expectedtypes = array(
  325. 'simpleel' => PARAM_INT,
  326. 'groupel1' => PARAM_INT,
  327. 'groupel2' => PARAM_FLOAT,
  328. 'groupel3' => PARAM_INT,
  329. 'namedgroup' => array(
  330. 'sndgroupel1' => PARAM_INT,
  331. 'sndgroupel2' => PARAM_FLOAT,
  332. 'sndgroupel3' => PARAM_INT
  333. ),
  334. 'namedgroupinherit' => array(
  335. 'thdgroupel1' => PARAM_INT,
  336. 'thdgroupel2' => PARAM_INT
  337. ),
  338. 'repeatedel' => array(
  339. 0 => PARAM_INT,
  340. 1 => PARAM_INT
  341. ),
  342. 'repeatedelinherit' => array(
  343. 0 => PARAM_INT,
  344. 1 => PARAM_INT
  345. ),
  346. 'squaretest' => array(
  347. 0 => PARAM_INT
  348. ),
  349. 'nested' => array(
  350. 0 => array(
  351. 'bob' => array(
  352. 123 => PARAM_INT,
  353. 'foo' => PARAM_FLOAT
  354. ),
  355. 'xyz' => PARAM_RAW
  356. ),
  357. 1 => PARAM_INT
  358. ),
  359. 'repeatgroupel1' => array(
  360. 0 => PARAM_INT,
  361. 1 => PARAM_INT
  362. ),
  363. 'repeatgroupel2' => array(
  364. 0 => PARAM_INT,
  365. 1 => PARAM_INT
  366. ),
  367. 'repeatnamedgroup' => array(
  368. 0 => array(
  369. 'repeatnamedgroupel1' => PARAM_INT,
  370. 'repeatnamedgroupel2' => PARAM_INT
  371. ),
  372. 1 => array(
  373. 'repeatnamedgroupel1' => PARAM_INT,
  374. 'repeatnamedgroupel2' => PARAM_INT
  375. )
  376. )
  377. );
  378. $valuessubmitted = array(
  379. 'simpleel' => '11.01',
  380. 'groupel1' => '11.01',
  381. 'groupel2' => '11.01',
  382. 'groupel3' => '11.01',
  383. 'namedgroup' => array(
  384. 'sndgroupel1' => '11.01',
  385. 'sndgroupel2' => '11.01',
  386. 'sndgroupel3' => '11.01'
  387. ),
  388. 'namedgroupinherit' => array(
  389. 'thdgroupel1' => '11.01',
  390. 'thdgroupel2' => '11.01'
  391. ),
  392. 'repeatedel' => array(
  393. 0 => '11.01',
  394. 1 => '11.01'
  395. ),
  396. 'repeatedelinherit' => array(
  397. 0 => '11.01',
  398. 1 => '11.01'
  399. ),
  400. 'squaretest' => array(
  401. 0 => '11.01'
  402. ),
  403. 'nested' => array(
  404. 0 => array(
  405. 'bob' => array(
  406. 123 => '11.01',
  407. 'foo' => '11.01'
  408. ),
  409. 'xyz' => '11.01'
  410. ),
  411. 1 => '11.01'
  412. ),
  413. 'repeatgroupel1' => array(
  414. 0 => '11.01',
  415. 1 => '11.01'
  416. ),
  417. 'repeatgroupel2' => array(
  418. 0 => '11.01',
  419. 1 => '11.01'
  420. ),
  421. 'repeatnamedgroup' => array(
  422. 0 => array(
  423. 'repeatnamedgroupel1' => '11.01',
  424. 'repeatnamedgroupel2' => '11.01'
  425. ),
  426. 1 => array(
  427. 'repeatnamedgroupel1' => '11.01',
  428. 'repeatnamedgroupel2' => '11.01'
  429. )
  430. )
  431. );
  432. $expectedvalues = array(
  433. 'simpleel' => 11,
  434. 'groupel1' => 11,
  435. 'groupel2' => 11.01,
  436. 'groupel3' => 11,
  437. 'namedgroup' => array(
  438. 'sndgroupel1' => 11,
  439. 'sndgroupel2' => 11.01,
  440. 'sndgroupel3' => 11
  441. ),
  442. 'namedgroupinherit' => array(
  443. 'thdgroupel1' => 11,
  444. 'thdgroupel2' => 11
  445. ),
  446. 'repeatable' => 2,
  447. 'repeatedel' => array(
  448. 0 => 11,
  449. 1 => 11
  450. ),
  451. 'repeatableinherit' => 2,
  452. 'repeatedelinherit' => array(
  453. 0 => 11,
  454. 1 => 11
  455. ),
  456. 'squaretest' => array(
  457. 0 => 11
  458. ),
  459. 'nested' => array(
  460. 0 => array(
  461. 'bob' => array(
  462. 123 => 11,
  463. 'foo' => 11.01
  464. ),
  465. 'xyz' => '11.01'
  466. ),
  467. 1 => 11
  468. ),
  469. 'repeatablegroup' => 2,
  470. 'repeatgroupel1' => array(
  471. 0 => 11,
  472. 1 => 11
  473. ),
  474. 'repeatgroupel2' => array(
  475. 0 => 11,
  476. 1 => 11
  477. ),
  478. 'repeatablenamedgroup' => 2,
  479. 'repeatnamedgroup' => array(
  480. 0 => array(
  481. 'repeatnamedgroupel1' => 11,
  482. 'repeatnamedgroupel2' => 11
  483. ),
  484. 1 => array(
  485. 'repeatnamedgroupel1' => 11,
  486. 'repeatnamedgroupel2' => 11
  487. )
  488. )
  489. );
  490. $mform = new formslib_clean_value();
  491. $mform->get_form()->updateSubmission($valuessubmitted, null);
  492. foreach ($expectedtypes as $elementname => $expected) {
  493. $actual = $mform->get_form()->getCleanType($elementname, $valuessubmitted[$elementname]);
  494. $this->assertSame($expected, $actual, "Failed validating clean type of '$elementname'");
  495. }
  496. $data = $mform->get_data();
  497. $this->assertSame($expectedvalues, (array) $data);
  498. }
  499. /**
  500. * MDL-52873
  501. */
  502. public function test_multiple_modgrade_fields() {
  503. global $CFG;
  504. $this->resetAfterTest(true);
  505. $CFG->theme = 'classic';
  506. $form = new formslib_multiple_modgrade_form();
  507. ob_start();
  508. $form->display();
  509. $html = ob_get_clean();
  510. $this->assertTag(array('id' => 'fitem_fgroup_id_grade1'), $html);
  511. $this->assertTag(array('id' => 'id_grade1_modgrade_type'), $html);
  512. $this->assertTag(array('id' => 'id_grade1_modgrade_point'), $html);
  513. $this->assertTag(array('id' => 'id_grade1_modgrade_scale'), $html);
  514. $this->assertTag(array('id' => 'fitem_fgroup_id_grade2'), $html);
  515. $this->assertTag(array('id' => 'id_grade2_modgrade_type'), $html);
  516. $this->assertTag(array('id' => 'id_grade2_modgrade_point'), $html);
  517. $this->assertTag(array('id' => 'id_grade2_modgrade_scale'), $html);
  518. $this->assertTag(array('id' => 'fitem_fgroup_id_grade_3'), $html);
  519. $this->assertTag(array('id' => 'id_grade_3_modgrade_type'), $html);
  520. $this->assertTag(array('id' => 'id_grade_3_modgrade_point'), $html);
  521. $this->assertTag(array('id' => 'id_grade_3_modgrade_scale'), $html);
  522. }
  523. /**
  524. * Test persistant freeze elements have different id's.
  525. */
  526. public function test_persistantrreeze_element() {
  527. global $CFG;
  528. $this->resetAfterTest(true);
  529. $CFG->theme = 'classic';
  530. $form = new formslib_persistantrreeze_element();
  531. ob_start();
  532. $form->display();
  533. $html = ob_get_clean();
  534. // Test advcheckbox id's.
  535. $this->assertTag(array('id' => 'id_advcheckboxpersistant'), $html);
  536. $this->assertTag(array('id' => 'id_advcheckboxnotpersistant'), $html);
  537. $this->assertNotTag(array('id' => 'id_advcheckboxnotpersistant_persistant'), $html);
  538. $this->assertTag(array('id' => 'id_advcheckboxfrozen'), $html);
  539. // Check text element id's.
  540. $this->assertTag(array('id' => 'id_textpersistant'), $html);
  541. $this->assertTag(array('id' => 'id_textnotpersistant'), $html);
  542. $this->assertNotTag(array('id' => 'id_textnotpersistant_persistant'), $html);
  543. $this->assertTag(array('id' => 'id_textfrozen'), $html);
  544. $this->assertNotTag(array('id' => 'id_textfrozen_persistant'), $html);
  545. }
  546. /**
  547. * Ensure a validation can run at least once per object. See MDL-56259.
  548. */
  549. public function test_multiple_validation() {
  550. $this->resetAfterTest(true);
  551. // It should be valid.
  552. formslib_multiple_validation_form::mock_submit(['somenumber' => '10']);
  553. $form = new formslib_multiple_validation_form();
  554. $this->assertTrue($form->is_validated());
  555. $this->assertEquals(10, $form->get_data()->somenumber);
  556. // It should not validate.
  557. formslib_multiple_validation_form::mock_submit(['somenumber' => '-5']);
  558. $form = new formslib_multiple_validation_form();
  559. $this->assertFalse($form->is_validated());
  560. $this->assertNull($form->get_data());
  561. }
  562. /**
  563. * MDL-56233 - Tests mocking a form inside a namespace.
  564. */
  565. public function test_mock_submit() {
  566. require_once(__DIR__.'/fixtures/namespaced_form.php');
  567. \local_unittests\namespaced_form\exampleform::mock_submit(['title' => 'Mocked Value']);
  568. $form = new \local_unittests\namespaced_form\exampleform();
  569. // Here is the problem, this is the expected hidden field name.
  570. $expected = '_qf__local_unittests_namespaced_form_exampleform';
  571. self::assertArrayHasKey($expected, $_POST);
  572. // This should work now, before it would fail.
  573. self::assertTrue($form->is_submitted());
  574. self::assertSame('Mocked Value', $form->get_data()->title);
  575. }
  576. }
  577. /**
  578. * Test form to be used by {@link formslib_test::test_rendering()}.
  579. */
  580. class formslib_test_form extends moodleform {
  581. public function definition() {
  582. $this->_form->addElement('select', 'choose_one', 'Choose one',
  583. array(1 => 'One', '2' => 'Two'));
  584. $repeatels = array(
  585. $this->_form->createElement('text', 'text', 'Type something')
  586. );
  587. // TODO: The repeat_elements() is far from perfect. Everything should be
  588. // repeated auto-magically by default with options only defining exceptions.
  589. // Surely this is caused because we are storing some element information OUT
  590. // from the element (type...) at form level. Anyway, the method should do its
  591. // work better, no matter of that.
  592. $this->repeat_elements($repeatels, 2, array('text' => array('type' => PARAM_RAW)), 'numtexts', 'addtexts');
  593. $this->_form->addElement('radio', 'radio', 'Label', 'Choice label', 'choice_value');
  594. $this->_form->addElement('radio', 'radio2', 'Label', 'Choice label', 'choice_value',
  595. array('id' => 'customelementid2'));
  596. $repeatels = array(
  597. $this->_form->createElement('radio', 'repeatradio', 'Choose {no}', 'One', 1),
  598. $this->_form->createElement('radio', 'repeatradio', 'Choose {no}', 'Two', 2),
  599. );
  600. $this->repeat_elements($repeatels, 3, array(), 'numradios', 'addradios');
  601. }
  602. }
  603. /**
  604. * Used to test debugging is called when text added without setType.
  605. */
  606. class formslib_settype_debugging_text extends moodleform {
  607. public function definition() {
  608. $mform = $this->_form;
  609. $mform->addElement('text', 'texttest', 'test123', 'testing123');
  610. }
  611. }
  612. /**
  613. * Used to test debugging is called when hidden added without setType.
  614. */
  615. class formslib_settype_debugging_hidden extends moodleform {
  616. public function definition() {
  617. $mform = $this->_form;
  618. $mform->addElement('hidden', 'hiddentest', '1');
  619. }
  620. }
  621. /**
  622. * Used to test debugging is called when hidden added without setType.
  623. */
  624. class formslib_settype_debugging_url extends moodleform {
  625. public function definition() {
  626. $mform = $this->_form;
  627. $mform->addElement('url', 'urltest', 'urltest');
  628. }
  629. }
  630. /**
  631. * Used to test debugging is called when repeated text added without setType.
  632. */
  633. class formslib_settype_debugging_repeat extends moodleform {
  634. public function definition() {
  635. $mform = $this->_form;
  636. $repeatels = array(
  637. $mform->createElement('text', 'repeattest', 'Type something')
  638. );
  639. $this->repeat_elements($repeatels, 1, array(), 'numtexts', 'addtexts');
  640. }
  641. }
  642. /**
  643. * Used to no debugging is called when correctly test.
  644. */
  645. class formslib_settype_debugging_repeat_ok extends moodleform {
  646. public function definition() {
  647. $mform = $this->_form;
  648. $repeatels = array(
  649. $mform->createElement('text', 'repeattest', 'Type something')
  650. );
  651. $this->repeat_elements($repeatels, 2, array('repeattest' => array('type' => PARAM_RAW)), 'numtexts', 'addtexts');
  652. }
  653. }
  654. /**
  655. * Used to test if debugging is called when a group contains elements without type.
  656. */
  657. class formslib_settype_debugging_group extends moodleform {
  658. public function definition() {
  659. $mform = $this->_form;
  660. $group = array(
  661. $mform->createElement('text', 'groupel1', 'groupel1'),
  662. $mform->createElement('text', 'groupel2', 'groupel2')
  663. );
  664. $mform->addGroup($group);
  665. $mform->setType('groupel2', PARAM_INT);
  666. }
  667. }
  668. /**
  669. * Used to test if debugging is called when a named group contains elements without type.
  670. */
  671. class formslib_settype_debugging_namedgroup extends moodleform {
  672. public function definition() {
  673. $mform = $this->_form;
  674. $group = array(
  675. $mform->createElement('text', 'groupel1', 'groupel1'),
  676. $mform->createElement('text', 'groupel2', 'groupel2')
  677. );
  678. $mform->addGroup($group, 'namedgroup');
  679. $mform->setType('namedgroup[groupel2]', PARAM_INT);
  680. }
  681. }
  682. /**
  683. * Used to test if debugging is called when has a funky name.
  684. */
  685. class formslib_settype_debugging_funky_name extends moodleform {
  686. public function definition() {
  687. $mform = $this->_form;
  688. $mform->addElement('text', 'blah[foo][bar][0]', 'test', 'test');
  689. $mform->addElement('text', 'blah[foo][bar][1]', 'test', 'test');
  690. $mform->setType('blah[foo][bar][0]', PARAM_INT);
  691. }
  692. }
  693. /**
  694. * Used to test that debugging is not called with type inheritance.
  695. */
  696. class formslib_settype_debugging_type_inheritance extends moodleform {
  697. public function definition() {
  698. $mform = $this->_form;
  699. $mform->addElement('text', 'blah[foo][bar][0]', 'test1', 'test');
  700. $mform->addElement('text', 'blah[bar][foo][1]', 'test2', 'test');
  701. $mform->addElement('text', 'blah[any][other][2]', 'test3', 'test');
  702. $mform->setType('blah[foo][bar]', PARAM_INT);
  703. $mform->setType('blah[bar]', PARAM_FLOAT);
  704. $mform->setType('blah', PARAM_TEXT);
  705. }
  706. }
  707. /**
  708. * Used to test the debugging when using groups in repeated elements.
  709. */
  710. class formslib_settype_debugging_type_group_in_repeat extends moodleform {
  711. public function definition() {
  712. $mform = $this->_form;
  713. $groupelements = array(
  714. $mform->createElement('text', 'test1', 'test1', 'test'),
  715. $mform->createElement('text', 'test2', 'test2', 'test')
  716. );
  717. $group = $mform->createElement('group', null, 'group1', $groupelements, null, false);
  718. $this->repeat_elements(array($group), 1, array('test1' => array('type' => PARAM_INT)), 'hidden', 'button');
  719. }
  720. }
  721. /**
  722. * Used to test the debugging when using named groups in repeated elements.
  723. */
  724. class formslib_settype_debugging_type_namedgroup_in_repeat extends moodleform {
  725. public function definition() {
  726. $mform = $this->_form;
  727. $groupelements = array(
  728. $mform->createElement('text', 'test1', 'test1', 'test'),
  729. $mform->createElement('text', 'test2', 'test2', 'test')
  730. );
  731. $group = $mform->createElement('group', 'namedgroup', 'group1', $groupelements, null, true);
  732. $this->repeat_elements(array($group), 1, array('namedgroup[test1]' => array('type' => PARAM_INT)), 'hidden', 'button');
  733. }
  734. }
  735. /**
  736. * Used to check value cleaning.
  737. */
  738. class formslib_clean_value extends moodleform {
  739. public function get_form() {
  740. return $this->_form;
  741. }
  742. public function definition() {
  743. $mform = $this->_form;
  744. // Add a simple int.
  745. $mform->addElement('text', 'simpleel', 'simpleel');
  746. $mform->setType('simpleel', PARAM_INT);
  747. // Add a non-named group.
  748. $group = array(
  749. $mform->createElement('text', 'groupel1', 'groupel1'),
  750. $mform->createElement('text', 'groupel2', 'groupel2'),
  751. $mform->createElement('text', 'groupel3', 'groupel3')
  752. );
  753. $mform->setType('groupel1', PARAM_INT);
  754. $mform->setType('groupel2', PARAM_FLOAT);
  755. $mform->setType('groupel3', PARAM_INT);
  756. $mform->addGroup($group);
  757. // Add a named group.
  758. $group = array(
  759. $mform->createElement('text', 'sndgroupel1', 'sndgroupel1'),
  760. $mform->createElement('text', 'sndgroupel2', 'sndgroupel2'),
  761. $mform->createElement('text', 'sndgroupel3', 'sndgroupel3')
  762. );
  763. $mform->addGroup($group, 'namedgroup');
  764. $mform->setType('namedgroup[sndgroupel1]', PARAM_INT);
  765. $mform->setType('namedgroup[sndgroupel2]', PARAM_FLOAT);
  766. $mform->setType('namedgroup[sndgroupel3]', PARAM_INT);
  767. // Add a named group, with inheritance.
  768. $group = array(
  769. $mform->createElement('text', 'thdgroupel1', 'thdgroupel1'),
  770. $mform->createElement('text', 'thdgroupel2', 'thdgroupel2')
  771. );
  772. $mform->addGroup($group, 'namedgroupinherit');
  773. $mform->setType('namedgroupinherit', PARAM_INT);
  774. // Add a repetition.
  775. $repeat = $mform->createElement('text', 'repeatedel', 'repeatedel');
  776. $this->repeat_elements(array($repeat), 2, array('repeatedel' => array('type' => PARAM_INT)), 'repeatable', 'add', 0);
  777. // Add a repetition, with inheritance.
  778. $repeat = $mform->createElement('text', 'repeatedelinherit', 'repeatedelinherit');
  779. $this->repeat_elements(array($repeat), 2, array(), 'repeatableinherit', 'add', 0);
  780. $mform->setType('repeatedelinherit', PARAM_INT);
  781. // Add an arbitrary named element.
  782. $mform->addElement('text', 'squaretest[0]', 'squaretest[0]');
  783. $mform->setType('squaretest[0]', PARAM_INT);
  784. // Add an arbitrary nested array named element.
  785. $mform->addElement('text', 'nested[0][bob][123]', 'nested[0][bob][123]');
  786. $mform->setType('nested[0][bob][123]', PARAM_INT);
  787. // Add inheritance test cases.
  788. $mform->setType('nested', PARAM_INT);
  789. $mform->setType('nested[0]', PARAM_RAW);
  790. $mform->setType('nested[0][bob]', PARAM_FLOAT);
  791. $mform->addElement('text', 'nested[1]', 'nested[1]');
  792. $mform->addElement('text', 'nested[0][xyz]', 'nested[0][xyz]');
  793. $mform->addElement('text', 'nested[0][bob][foo]', 'nested[0][bob][foo]');
  794. // Add group in repeated element (with extra inheritance).
  795. $groupelements = array(
  796. $mform->createElement('text', 'repeatgroupel1', 'repeatgroupel1'),
  797. $mform->createElement('text', 'repeatgroupel2', 'repeatgroupel2')
  798. );
  799. $group = $mform->createElement('group', 'repeatgroup', 'repeatgroup', $groupelements, null, false);
  800. $this->repeat_elements(array($group), 2, array('repeatgroupel1' => array('type' => PARAM_INT),
  801. 'repeatgroupel2' => array('type' => PARAM_INT)), 'repeatablegroup', 'add', 0);
  802. // Add named group in repeated element.
  803. $groupelements = array(
  804. $mform->createElement('text', 'repeatnamedgroupel1', 'repeatnamedgroupel1'),
  805. $mform->createElement('text', 'repeatnamedgroupel2', 'repeatnamedgroupel2')
  806. );
  807. $group = $mform->createElement('group', 'repeatnamedgroup', 'repeatnamedgroup', $groupelements, null, true);
  808. $this->repeat_elements(array($group), 2, array('repeatnamedgroup[repeatnamedgroupel1]' => array('type' => PARAM_INT),
  809. 'repeatnamedgroup[repeatnamedgroupel2]' => array('type' => PARAM_INT)), 'repeatablenamedgroup', 'add', 0);
  810. }
  811. }
  812. /**
  813. * Used to test that modgrade fields get unique id attributes.
  814. */
  815. class formslib_multiple_modgrade_form extends moodleform {
  816. public function definition() {
  817. $mform = $this->_form;
  818. $mform->addElement('modgrade', 'grade1', 'Grade 1');
  819. $mform->addElement('modgrade', 'grade2', 'Grade 2');
  820. $mform->addElement('modgrade', 'grade[3]', 'Grade 3');
  821. }
  822. }
  823. /**
  824. * Used to test frozen elements get unique id attributes.
  825. */
  826. class formslib_persistantrreeze_element extends moodleform {
  827. public function definition() {
  828. $mform = $this->_form;
  829. // Create advanced checkbox.
  830. // Persistant.
  831. $advcheckboxpersistant = $mform->addElement('advcheckbox', 'advcheckboxpersistant', 'advcheckbox');
  832. $mform->setType('advcheckboxpersistant', PARAM_BOOL);
  833. $advcheckboxpersistant->setChecked(true);
  834. $advcheckboxpersistant->freeze();
  835. $advcheckboxpersistant->setPersistantFreeze(true);
  836. // Frozen.
  837. $advcheckboxfrozen = $mform->addElement('advcheckbox', 'advcheckboxfrozen', 'advcheckbox');
  838. $mform->setType('advcheckboxfrozen', PARAM_BOOL);
  839. $advcheckboxfrozen->setChecked(true);
  840. $advcheckboxfrozen->freeze();
  841. // Neither persistant nor Frozen.
  842. $mform->addElement('advcheckbox', 'advcheckboxnotpersistant', 'advcheckbox');
  843. $mform->setType('advcheckboxnotpersistant', PARAM_BOOL);
  844. // Create text fields.
  845. // Persistant.
  846. $elpersistant = $mform->addElement('text', 'textpersistant', 'test', 'test');
  847. $mform->setType('textpersistant', PARAM_TEXT);
  848. $elpersistant->freeze();
  849. $elpersistant->setPersistantFreeze(true);
  850. // Frozen.
  851. $elfrozen = $mform->addElement('text', 'textfrozen', 'test', 'test');
  852. $mform->setType('textfrozen', PARAM_TEXT);
  853. $elfrozen->freeze();
  854. // Neither persistant nor Frozen.
  855. $mform->addElement('text', 'textnotpersistant', 'test', 'test');
  856. $mform->setType('textnotpersistant', PARAM_TEXT);
  857. }
  858. }
  859. /**
  860. * Used to test that you can validate a form more than once. See MDL-56250.
  861. * @package core_form
  862. * @author Daniel Thee Roperto <daniel.roperto@catalyst-au.net>
  863. * @copyright 2016 Catalyst IT
  864. * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  865. */
  866. class formslib_multiple_validation_form extends moodleform {
  867. /**
  868. * Simple definition, one text field which can have a number.
  869. */
  870. public function definition() {
  871. $mform = $this->_form;
  872. $mform->addElement('text', 'somenumber');
  873. $mform->setType('somenumber', PARAM_INT);
  874. }
  875. /**
  876. * The number cannot be negative.
  877. * @param array $data An array of form data
  878. * @param array $files An array of form files
  879. * @return array Error messages
  880. */
  881. public function validation($data, $files) {
  882. $errors = parent::validation($data, $files);
  883. if ($data['somenumber'] < 0) {
  884. $errors['somenumber'] = 'The number cannot be negative.';
  885. }
  886. return $errors;
  887. }
  888. }