PageRenderTime 55ms CodeModel.GetById 29ms RepoModel.GetById 0ms app.codeStats 0ms

/lib/tests/formslib_test.php

https://github.com/alfunkso/moodle
PHP | 820 lines | 636 code | 90 blank | 94 comment | 14 complexity | a6a176b928d4e9bd8b0f24ea4d619c09 MD5 | raw file
Possible License(s): Apache-2.0, BSD-3-Clause, LGPL-2.1, GPL-3.0
  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("0"));
  46. $this->assertTrue($rule->validate(0));
  47. $this->assertTrue($rule->validate(true));
  48. $this->assertTrue($rule->validate(' '));
  49. $this->assertTrue($rule->validate(' '));
  50. $this->assertTrue($rule->validate("\t"));
  51. $this->assertTrue($rule->validate("\n"));
  52. $this->assertTrue($rule->validate("\r"));
  53. $this->assertTrue($rule->validate("\r\n"));
  54. $this->assertTrue($rule->validate(" \t \n \r "));
  55. $this->assertTrue($rule->validate('<p></p>'));
  56. $this->assertTrue($rule->validate('<p> </p>'));
  57. $this->assertTrue($rule->validate('<p>x</p>'));
  58. $this->assertTrue($rule->validate('<img src="smile.jpg" alt="smile" />'));
  59. $this->assertTrue($rule->validate('<img src="smile.jpg" alt="smile"/>'));
  60. $this->assertTrue($rule->validate('<img src="smile.jpg" alt="smile"></img>'));
  61. $this->assertTrue($rule->validate('<hr />'));
  62. $this->assertTrue($rule->validate('<hr/>'));
  63. $this->assertTrue($rule->validate('<hr>'));
  64. $this->assertTrue($rule->validate('<hr></hr>'));
  65. $this->assertTrue($rule->validate('<br />'));
  66. $this->assertTrue($rule->validate('<br/>'));
  67. $this->assertTrue($rule->validate('<br>'));
  68. $this->assertTrue($rule->validate('&nbsp;'));
  69. // Fails.
  70. $this->assertFalse($rule->validate(''));
  71. $this->assertFalse($rule->validate(false));
  72. $this->assertFalse($rule->validate(null));
  73. // Now run the same tests with it on to make sure things work as expected.
  74. $CFG->strictformsrequired = true;
  75. // Passes.
  76. $this->assertTrue($rule->validate('Something'));
  77. $this->assertTrue($rule->validate("Something\nmore"));
  78. $this->assertTrue($rule->validate("\nmore"));
  79. $this->assertTrue($rule->validate(" more "));
  80. $this->assertTrue($rule->validate("0"));
  81. $this->assertTrue($rule->validate(0));
  82. $this->assertTrue($rule->validate(true));
  83. $this->assertTrue($rule->validate('<p>x</p>'));
  84. $this->assertTrue($rule->validate('<img src="smile.jpg" alt="smile" />'));
  85. $this->assertTrue($rule->validate('<img src="smile.jpg" alt="smile"/>'));
  86. $this->assertTrue($rule->validate('<img src="smile.jpg" alt="smile"></img>'));
  87. $this->assertTrue($rule->validate('<hr />'));
  88. $this->assertTrue($rule->validate('<hr/>'));
  89. $this->assertTrue($rule->validate('<hr>'));
  90. $this->assertTrue($rule->validate('<hr></hr>'));
  91. // Fails.
  92. $this->assertFalse($rule->validate(' '));
  93. $this->assertFalse($rule->validate(' '));
  94. $this->assertFalse($rule->validate("\t"));
  95. $this->assertFalse($rule->validate("\n"));
  96. $this->assertFalse($rule->validate("\r"));
  97. $this->assertFalse($rule->validate("\r\n"));
  98. $this->assertFalse($rule->validate(" \t \n \r "));
  99. $this->assertFalse($rule->validate('<p></p>'));
  100. $this->assertFalse($rule->validate('<p> </p>'));
  101. $this->assertFalse($rule->validate('<br />'));
  102. $this->assertFalse($rule->validate('<br/>'));
  103. $this->assertFalse($rule->validate('<br>'));
  104. $this->assertFalse($rule->validate('&nbsp;'));
  105. $this->assertFalse($rule->validate(''));
  106. $this->assertFalse($rule->validate(false));
  107. $this->assertFalse($rule->validate(null));
  108. if (isset($strictformsrequired)) {
  109. $CFG->strictformsrequired = $strictformsrequired;
  110. }
  111. }
  112. public function test_range_rule() {
  113. global $CFG;
  114. require_once('HTML/QuickForm/Rule/Range.php'); // Requires this pear stuff.
  115. $strictformsrequired = null;
  116. if (isset($CFG->strictformsrequired)) {
  117. $strictformsrequired = $CFG->strictformsrequired;
  118. }
  119. $rule = new HTML_QuickForm_Rule_Range();
  120. // First run the tests with strictformsrequired off.
  121. $CFG->strictformsrequired = false;
  122. // Passes.
  123. $rule->setName('minlength'); // Let's verify some min lengths.
  124. $this->assertTrue($rule->validate('12', 2));
  125. $this->assertTrue($rule->validate('123', 2));
  126. $this->assertTrue($rule->validate('áé', 2));
  127. $this->assertTrue($rule->validate('áéí', 2));
  128. $rule->setName('maxlength'); // Let's verify some max lengths.
  129. $this->assertTrue($rule->validate('1', 2));
  130. $this->assertTrue($rule->validate('12', 2));
  131. $this->assertTrue($rule->validate('á', 2));
  132. $this->assertTrue($rule->validate('áé', 2));
  133. $rule->setName('----'); // Let's verify some ranges.
  134. $this->assertTrue($rule->validate('', array(0, 2)));
  135. $this->assertTrue($rule->validate('1', array(0, 2)));
  136. $this->assertTrue($rule->validate('12', array(0, 2)));
  137. $this->assertTrue($rule->validate('á', array(0, 2)));
  138. $this->assertTrue($rule->validate('áé', array(0, 2)));
  139. // Fail.
  140. $rule->setName('minlength'); // Let's verify some min lengths.
  141. $this->assertFalse($rule->validate('', 2));
  142. $this->assertFalse($rule->validate('1', 2));
  143. $this->assertFalse($rule->validate('á', 2));
  144. $rule->setName('maxlength'); // Let's verify some max lengths.
  145. $this->assertFalse($rule->validate('123', 2));
  146. $this->assertFalse($rule->validate('áéí', 2));
  147. $rule->setName('----'); // Let's verify some ranges.
  148. $this->assertFalse($rule->validate('', array(1, 2)));
  149. $this->assertFalse($rule->validate('123', array(1, 2)));
  150. $this->assertFalse($rule->validate('áéí', array(1, 2)));
  151. // Now run the same tests with it on to make sure things work as expected.
  152. $CFG->strictformsrequired = true;
  153. // Passes.
  154. $rule->setName('minlength'); // Let's verify some min lengths.
  155. $this->assertTrue($rule->validate('12', 2));
  156. $this->assertTrue($rule->validate('123', 2));
  157. $this->assertTrue($rule->validate('áé', 2));
  158. $this->assertTrue($rule->validate('áéí', 2));
  159. $rule->setName('maxlength'); // Let's verify some min lengths.
  160. $this->assertTrue($rule->validate('1', 2));
  161. $this->assertTrue($rule->validate('12', 2));
  162. $this->assertTrue($rule->validate('á', 2));
  163. $this->assertTrue($rule->validate('áé', 2));
  164. $rule->setName('----'); // Let's verify some ranges.
  165. $this->assertTrue($rule->validate('', array(0, 2)));
  166. $this->assertTrue($rule->validate('1', array(0, 2)));
  167. $this->assertTrue($rule->validate('12', array(0, 2)));
  168. $this->assertTrue($rule->validate('á', array(0, 2)));
  169. $this->assertTrue($rule->validate('áé', array(0, 2)));
  170. // Fail.
  171. $rule->setName('minlength'); // Let's verify some min lengths.
  172. $this->assertFalse($rule->validate('', 2));
  173. $this->assertFalse($rule->validate('1', 2));
  174. $this->assertFalse($rule->validate('á', 2));
  175. $rule->setName('maxlength'); // Let's verify some min lengths.
  176. $this->assertFalse($rule->validate('123', 2));
  177. $this->assertFalse($rule->validate('áéí', 2));
  178. $rule->setName('----'); // Let's verify some ranges.
  179. $this->assertFalse($rule->validate('', array(1, 2)));
  180. $this->assertFalse($rule->validate('123', array(1, 2)));
  181. $this->assertFalse($rule->validate('áéí', array(1, 2)));
  182. if (isset($strictformsrequired)) {
  183. $CFG->strictformsrequired = $strictformsrequired;
  184. }
  185. }
  186. public function test_generate_id_select() {
  187. $el = new MoodleQuickForm_select('choose_one', 'Choose one',
  188. array(1 => 'One', '2' => 'Two'));
  189. $el->_generateId();
  190. $this->assertSame('id_choose_one', $el->getAttribute('id'));
  191. }
  192. public function test_generate_id_like_repeat() {
  193. $el = new MoodleQuickForm_text('text[7]', 'Type something');
  194. $el->_generateId();
  195. $this->assertSame('id_text_7', $el->getAttribute('id'));
  196. }
  197. public function test_can_manually_set_id() {
  198. $el = new MoodleQuickForm_text('elementname', 'Type something',
  199. array('id' => 'customelementid'));
  200. $el->_generateId();
  201. $this->assertSame('customelementid', $el->getAttribute('id'));
  202. }
  203. public function test_generate_id_radio() {
  204. $el = new MoodleQuickForm_radio('radio', 'Label', 'Choice label', 'choice_value');
  205. $el->_generateId();
  206. $this->assertSame('id_radio_choice_value', $el->getAttribute('id'));
  207. }
  208. public function test_radio_can_manually_set_id() {
  209. $el = new MoodleQuickForm_radio('radio2', 'Label', 'Choice label', 'choice_value',
  210. array('id' => 'customelementid2'));
  211. $el->_generateId();
  212. $this->assertSame('customelementid2', $el->getAttribute('id'));
  213. }
  214. public function test_generate_id_radio_like_repeat() {
  215. $el = new MoodleQuickForm_radio('repeatradio[2]', 'Label', 'Choice label', 'val');
  216. $el->_generateId();
  217. $this->assertSame('id_repeatradio_2_val', $el->getAttribute('id'));
  218. }
  219. public function test_rendering() {
  220. $form = new formslib_test_form();
  221. ob_start();
  222. $form->display();
  223. $html = ob_get_clean();
  224. $this->assertTag(array('tag'=>'select', 'id'=>'id_choose_one',
  225. 'attributes'=>array('name'=>'choose_one')), $html);
  226. $this->assertTag(array('tag'=>'input', 'id'=>'id_text_0',
  227. 'attributes'=>array('type'=>'text', 'name'=>'text[0]')), $html);
  228. $this->assertTag(array('tag'=>'input', 'id'=>'id_text_1',
  229. 'attributes'=>array('type'=>'text', 'name'=>'text[1]')), $html);
  230. $this->assertTag(array('tag'=>'input', 'id'=>'id_radio_choice_value',
  231. 'attributes'=>array('type'=>'radio', 'name'=>'radio', 'value'=>'choice_value')), $html);
  232. $this->assertTag(array('tag'=>'input', 'id'=>'customelementid2',
  233. 'attributes'=>array('type'=>'radio', 'name'=>'radio2')), $html);
  234. $this->assertTag(array('tag'=>'input', 'id'=>'id_repeatradio_0_2',
  235. 'attributes'=>array('type'=>'radio', 'name'=>'repeatradio[0]', 'value'=>'2')), $html);
  236. $this->assertTag(array('tag'=>'input', 'id'=>'id_repeatradio_2_1',
  237. 'attributes'=>array('type'=>'radio', 'name'=>'repeatradio[2]', 'value'=>'1')), $html);
  238. $this->assertTag(array('tag'=>'input', 'id'=>'id_repeatradio_2_2',
  239. 'attributes'=>array('type'=>'radio', 'name'=>'repeatradio[2]', 'value'=>'2')), $html);
  240. }
  241. public function test_settype_debugging_text() {
  242. $mform = new formslib_settype_debugging_text();
  243. $this->assertDebuggingCalled("Did you remember to call setType() for 'texttest'? Defaulting to PARAM_RAW cleaning.");
  244. // Check form still there though.
  245. $this->expectOutputRegex('/<input[^>]*name="texttest[^>]*type="text/');
  246. $mform->display();
  247. }
  248. public function test_settype_debugging_hidden() {
  249. $mform = new formslib_settype_debugging_hidden();
  250. $this->assertDebuggingCalled("Did you remember to call setType() for 'hiddentest'? Defaulting to PARAM_RAW cleaning.");
  251. // Check form still there though.
  252. $this->expectOutputRegex('/<input[^>]*name="hiddentest[^>]*type="hidden/');
  253. $mform->display();
  254. }
  255. public function test_settype_debugging_url() {
  256. $this->resetAfterTest(true);
  257. $this->setAdminUser();
  258. $mform = new formslib_settype_debugging_url();
  259. $this->assertDebuggingCalled("Did you remember to call setType() for 'urltest'? Defaulting to PARAM_RAW cleaning.");
  260. // Check form still there though.
  261. $this->expectOutputRegex('/<input[^>]*name="urltest"[^>]*type="text/');
  262. $mform->display();
  263. }
  264. public function test_settype_debugging_repeat() {
  265. $mform = new formslib_settype_debugging_repeat();
  266. $this->assertDebuggingCalled("Did you remember to call setType() for 'repeattest[0]'? Defaulting to PARAM_RAW cleaning.");
  267. // Check form still there though.
  268. $this->expectOutputRegex('/<input[^>]*name="repeattest[^>]*type="text/');
  269. $mform->display();
  270. }
  271. public function test_settype_debugging_repeat_ok() {
  272. $mform = new formslib_settype_debugging_repeat_ok();
  273. // No debugging expected here.
  274. $this->expectOutputRegex('/<input[^>]*name="repeattest[^>]*type="text/');
  275. $mform->display();
  276. }
  277. public function test_settype_debugging_group() {
  278. $mform = new formslib_settype_debugging_group();
  279. $this->assertDebuggingCalled("Did you remember to call setType() for 'groupel1'? Defaulting to PARAM_RAW cleaning.");
  280. $this->expectOutputRegex('/<input[^>]*name="groupel1"[^>]*type="text/');
  281. $this->expectOutputRegex('/<input[^>]*name="groupel2"[^>]*type="text/');
  282. $mform->display();
  283. }
  284. public function test_settype_debugging_namedgroup() {
  285. $mform = new formslib_settype_debugging_namedgroup();
  286. $this->assertDebuggingCalled("Did you remember to call setType() for 'namedgroup[groupel1]'? Defaulting to PARAM_RAW cleaning.");
  287. $this->expectOutputRegex('/<input[^>]*name="namedgroup\[groupel1\]"[^>]*type="text/');
  288. $this->expectOutputRegex('/<input[^>]*name="namedgroup\[groupel2\]"[^>]*type="text/');
  289. $mform->display();
  290. }
  291. public function test_settype_debugging_funky_name() {
  292. $mform = new formslib_settype_debugging_funky_name();
  293. $this->assertDebuggingCalled("Did you remember to call setType() for 'blah[foo][bar][1]'? Defaulting to PARAM_RAW cleaning.");
  294. $this->expectOutputRegex('/<input[^>]*name="blah\[foo\]\[bar\]\[0\]"[^>]*type="text/');
  295. $this->expectOutputRegex('/<input[^>]*name="blah\[foo\]\[bar\]\[1\]"[^>]*type="text/');
  296. $mform->display();
  297. }
  298. public function test_settype_debugging_type_inheritance() {
  299. $mform = new formslib_settype_debugging_type_inheritance();
  300. $this->expectOutputRegex('/<input[^>]*name="blah\[foo\]\[bar\]\[0\]"[^>]*type="text/');
  301. $this->expectOutputRegex('/<input[^>]*name="blah\[bar\]\[foo\]\[1\]"[^>]*type="text/');
  302. $this->expectOutputRegex('/<input[^>]*name="blah\[any\]\[other\]\[2\]"[^>]*type="text/');
  303. $mform->display();
  304. }
  305. public function test_settype_debugging_type_group_in_repeat() {
  306. $mform = new formslib_settype_debugging_type_group_in_repeat();
  307. $this->assertDebuggingCalled("Did you remember to call setType() for 'test2[0]'? Defaulting to PARAM_RAW cleaning.");
  308. $this->expectOutputRegex('/<input[^>]*name="test1\[0\]"[^>]*type="text/');
  309. $this->expectOutputRegex('/<input[^>]*name="test2\[0\]"[^>]*type="text/');
  310. $mform->display();
  311. }
  312. public function test_settype_debugging_type_namedgroup_in_repeat() {
  313. $mform = new formslib_settype_debugging_type_namedgroup_in_repeat();
  314. $this->assertDebuggingCalled("Did you remember to call setType() for 'namedgroup[0][test2]'? Defaulting to PARAM_RAW cleaning.");
  315. $this->expectOutputRegex('/<input[^>]*name="namedgroup\[0\]\[test1\]"[^>]*type="text/');
  316. $this->expectOutputRegex('/<input[^>]*name="namedgroup\[0\]\[test2\]"[^>]*type="text/');
  317. $mform->display();
  318. }
  319. public function test_type_cleaning() {
  320. $expectedtypes = array(
  321. 'simpleel' => PARAM_INT,
  322. 'groupel1' => PARAM_INT,
  323. 'groupel2' => PARAM_FLOAT,
  324. 'groupel3' => PARAM_INT,
  325. 'namedgroup' => array(
  326. 'sndgroupel1' => PARAM_INT,
  327. 'sndgroupel2' => PARAM_FLOAT,
  328. 'sndgroupel3' => PARAM_INT
  329. ),
  330. 'namedgroupinherit' => array(
  331. 'thdgroupel1' => PARAM_INT,
  332. 'thdgroupel2' => PARAM_INT
  333. ),
  334. 'repeatedel' => array(
  335. 0 => PARAM_INT,
  336. 1 => PARAM_INT
  337. ),
  338. 'repeatedelinherit' => array(
  339. 0 => PARAM_INT,
  340. 1 => PARAM_INT
  341. ),
  342. 'squaretest' => array(
  343. 0 => PARAM_INT
  344. ),
  345. 'nested' => array(
  346. 0 => array(
  347. 'bob' => array(
  348. 123 => PARAM_INT,
  349. 'foo' => PARAM_FLOAT
  350. ),
  351. 'xyz' => PARAM_RAW
  352. ),
  353. 1 => PARAM_INT
  354. ),
  355. 'repeatgroupel1' => array(
  356. 0 => PARAM_INT,
  357. 1 => PARAM_INT
  358. ),
  359. 'repeatgroupel2' => array(
  360. 0 => PARAM_INT,
  361. 1 => PARAM_INT
  362. ),
  363. 'repeatnamedgroup' => array(
  364. 0 => array(
  365. 'repeatnamedgroupel1' => PARAM_INT,
  366. 'repeatnamedgroupel2' => PARAM_INT
  367. ),
  368. 1 => array(
  369. 'repeatnamedgroupel1' => PARAM_INT,
  370. 'repeatnamedgroupel2' => PARAM_INT
  371. )
  372. )
  373. );
  374. $valuessubmitted = array(
  375. 'simpleel' => '11.01',
  376. 'groupel1' => '11.01',
  377. 'groupel2' => '11.01',
  378. 'groupel3' => '11.01',
  379. 'namedgroup' => array(
  380. 'sndgroupel1' => '11.01',
  381. 'sndgroupel2' => '11.01',
  382. 'sndgroupel3' => '11.01'
  383. ),
  384. 'namedgroupinherit' => array(
  385. 'thdgroupel1' => '11.01',
  386. 'thdgroupel2' => '11.01'
  387. ),
  388. 'repeatedel' => array(
  389. 0 => '11.01',
  390. 1 => '11.01'
  391. ),
  392. 'repeatedelinherit' => array(
  393. 0 => '11.01',
  394. 1 => '11.01'
  395. ),
  396. 'squaretest' => array(
  397. 0 => '11.01'
  398. ),
  399. 'nested' => array(
  400. 0 => array(
  401. 'bob' => array(
  402. 123 => '11.01',
  403. 'foo' => '11.01'
  404. ),
  405. 'xyz' => '11.01'
  406. ),
  407. 1 => '11.01'
  408. ),
  409. 'repeatgroupel1' => array(
  410. 0 => '11.01',
  411. 1 => '11.01'
  412. ),
  413. 'repeatgroupel2' => array(
  414. 0 => '11.01',
  415. 1 => '11.01'
  416. ),
  417. 'repeatnamedgroup' => array(
  418. 0 => array(
  419. 'repeatnamedgroupel1' => '11.01',
  420. 'repeatnamedgroupel2' => '11.01'
  421. ),
  422. 1 => array(
  423. 'repeatnamedgroupel1' => '11.01',
  424. 'repeatnamedgroupel2' => '11.01'
  425. )
  426. )
  427. );
  428. $expectedvalues = array(
  429. 'simpleel' => 11,
  430. 'groupel1' => 11,
  431. 'groupel2' => 11.01,
  432. 'groupel3' => 11,
  433. 'namedgroup' => array(
  434. 'sndgroupel1' => 11,
  435. 'sndgroupel2' => 11.01,
  436. 'sndgroupel3' => 11
  437. ),
  438. 'namedgroupinherit' => array(
  439. 'thdgroupel1' => 11,
  440. 'thdgroupel2' => 11
  441. ),
  442. 'repeatable' => 2,
  443. 'repeatedel' => array(
  444. 0 => 11,
  445. 1 => 11
  446. ),
  447. 'repeatableinherit' => 2,
  448. 'repeatedelinherit' => array(
  449. 0 => 11,
  450. 1 => 11
  451. ),
  452. 'squaretest' => array(
  453. 0 => 11
  454. ),
  455. 'nested' => array(
  456. 0 => array(
  457. 'bob' => array(
  458. 123 => 11,
  459. 'foo' => 11.01
  460. ),
  461. 'xyz' => '11.01'
  462. ),
  463. 1 => 11
  464. ),
  465. 'repeatablegroup' => 2,
  466. 'repeatgroupel1' => array(
  467. 0 => 11,
  468. 1 => 11
  469. ),
  470. 'repeatgroupel2' => array(
  471. 0 => 11,
  472. 1 => 11
  473. ),
  474. 'repeatablenamedgroup' => 2,
  475. 'repeatnamedgroup' => array(
  476. 0 => array(
  477. 'repeatnamedgroupel1' => 11,
  478. 'repeatnamedgroupel2' => 11
  479. ),
  480. 1 => array(
  481. 'repeatnamedgroupel1' => 11,
  482. 'repeatnamedgroupel2' => 11
  483. )
  484. )
  485. );
  486. $mform = new formslib_clean_value();
  487. $mform->get_form()->updateSubmission($valuessubmitted, null);
  488. foreach ($expectedtypes as $elementname => $expected) {
  489. $actual = $mform->get_form()->getCleanType($elementname, $valuessubmitted[$elementname]);
  490. $this->assertSame($expected, $actual, "Failed validating clean type of '$elementname'");
  491. }
  492. $data = $mform->get_data();
  493. $this->assertSame($expectedvalues, (array) $data);
  494. }
  495. }
  496. /**
  497. * Test form to be used by {@link formslib_test::test_rendering()}.
  498. */
  499. class formslib_test_form extends moodleform {
  500. public function definition() {
  501. $this->_form->addElement('select', 'choose_one', 'Choose one',
  502. array(1 => 'One', '2' => 'Two'));
  503. $repeatels = array(
  504. $this->_form->createElement('text', 'text', 'Type something')
  505. );
  506. // TODO: The repeat_elements() is far from perfect. Everything should be
  507. // repeated auto-magically by default with options only defining exceptions.
  508. // Surely this is caused because we are storing some element information OUT
  509. // from the element (type...) at form level. Anyway, the method should do its
  510. // work better, no matter of that.
  511. $this->repeat_elements($repeatels, 2, array('text' => array('type' => PARAM_RAW)), 'numtexts', 'addtexts');
  512. $this->_form->addElement('radio', 'radio', 'Label', 'Choice label', 'choice_value');
  513. $this->_form->addElement('radio', 'radio2', 'Label', 'Choice label', 'choice_value',
  514. array('id' => 'customelementid2'));
  515. $repeatels = array(
  516. $this->_form->createElement('radio', 'repeatradio', 'Choose {no}', 'One', 1),
  517. $this->_form->createElement('radio', 'repeatradio', 'Choose {no}', 'Two', 2),
  518. );
  519. $this->repeat_elements($repeatels, 3, array(), 'numradios', 'addradios');
  520. }
  521. }
  522. /**
  523. * Used to test debugging is called when text added without setType.
  524. */
  525. class formslib_settype_debugging_text extends moodleform {
  526. public function definition() {
  527. $mform = $this->_form;
  528. $mform->addElement('text', 'texttest', 'test123', 'testing123');
  529. }
  530. }
  531. /**
  532. * Used to test debugging is called when hidden added without setType.
  533. */
  534. class formslib_settype_debugging_hidden extends moodleform {
  535. public function definition() {
  536. $mform = $this->_form;
  537. $mform->addElement('hidden', 'hiddentest', '1');
  538. }
  539. }
  540. /**
  541. * Used to test debugging is called when hidden added without setType.
  542. */
  543. class formslib_settype_debugging_url extends moodleform {
  544. public function definition() {
  545. $mform = $this->_form;
  546. $mform->addElement('url', 'urltest', 'urltest');
  547. }
  548. }
  549. /**
  550. * Used to test debugging is called when repeated text added without setType.
  551. */
  552. class formslib_settype_debugging_repeat extends moodleform {
  553. public function definition() {
  554. $mform = $this->_form;
  555. $repeatels = array(
  556. $mform->createElement('text', 'repeattest', 'Type something')
  557. );
  558. $this->repeat_elements($repeatels, 1, array(), 'numtexts', 'addtexts');
  559. }
  560. }
  561. /**
  562. * Used to no debugging is called when correctly test.
  563. */
  564. class formslib_settype_debugging_repeat_ok extends moodleform {
  565. public function definition() {
  566. $mform = $this->_form;
  567. $repeatels = array(
  568. $mform->createElement('text', 'repeattest', 'Type something')
  569. );
  570. $this->repeat_elements($repeatels, 2, array('repeattest' => array('type' => PARAM_RAW)), 'numtexts', 'addtexts');
  571. }
  572. }
  573. /**
  574. * Used to test if debugging is called when a group contains elements without type.
  575. */
  576. class formslib_settype_debugging_group extends moodleform {
  577. public function definition() {
  578. $mform = $this->_form;
  579. $group = array(
  580. $mform->createElement('text', 'groupel1', 'groupel1'),
  581. $mform->createElement('text', 'groupel2', 'groupel2')
  582. );
  583. $mform->addGroup($group);
  584. $mform->setType('groupel2', PARAM_INT);
  585. }
  586. }
  587. /**
  588. * Used to test if debugging is called when a named group contains elements without type.
  589. */
  590. class formslib_settype_debugging_namedgroup extends moodleform {
  591. public function definition() {
  592. $mform = $this->_form;
  593. $group = array(
  594. $mform->createElement('text', 'groupel1', 'groupel1'),
  595. $mform->createElement('text', 'groupel2', 'groupel2')
  596. );
  597. $mform->addGroup($group, 'namedgroup');
  598. $mform->setType('namedgroup[groupel2]', PARAM_INT);
  599. }
  600. }
  601. /**
  602. * Used to test if debugging is called when has a funky name.
  603. */
  604. class formslib_settype_debugging_funky_name extends moodleform {
  605. public function definition() {
  606. $mform = $this->_form;
  607. $mform->addElement('text', 'blah[foo][bar][0]', 'test', 'test');
  608. $mform->addElement('text', 'blah[foo][bar][1]', 'test', 'test');
  609. $mform->setType('blah[foo][bar][0]', PARAM_INT);
  610. }
  611. }
  612. /**
  613. * Used to test that debugging is not called with type inheritance.
  614. */
  615. class formslib_settype_debugging_type_inheritance extends moodleform {
  616. public function definition() {
  617. $mform = $this->_form;
  618. $mform->addElement('text', 'blah[foo][bar][0]', 'test1', 'test');
  619. $mform->addElement('text', 'blah[bar][foo][1]', 'test2', 'test');
  620. $mform->addElement('text', 'blah[any][other][2]', 'test3', 'test');
  621. $mform->setType('blah[foo][bar]', PARAM_INT);
  622. $mform->setType('blah[bar]', PARAM_FLOAT);
  623. $mform->setType('blah', PARAM_TEXT);
  624. }
  625. }
  626. /**
  627. * Used to test the debugging when using groups in repeated elements.
  628. */
  629. class formslib_settype_debugging_type_group_in_repeat extends moodleform {
  630. public function definition() {
  631. $mform = $this->_form;
  632. $groupelements = array(
  633. $mform->createElement('text', 'test1', 'test1', 'test'),
  634. $mform->createElement('text', 'test2', 'test2', 'test')
  635. );
  636. $group = $mform->createElement('group', null, 'group1', $groupelements, null, false);
  637. $this->repeat_elements(array($group), 1, array('test1' => array('type' => PARAM_INT)), 'hidden', 'button');
  638. }
  639. }
  640. /**
  641. * Used to test the debugging when using named groups in repeated elements.
  642. */
  643. class formslib_settype_debugging_type_namedgroup_in_repeat extends moodleform {
  644. public function definition() {
  645. $mform = $this->_form;
  646. $groupelements = array(
  647. $mform->createElement('text', 'test1', 'test1', 'test'),
  648. $mform->createElement('text', 'test2', 'test2', 'test')
  649. );
  650. $group = $mform->createElement('group', 'namedgroup', 'group1', $groupelements, null, true);
  651. $this->repeat_elements(array($group), 1, array('namedgroup[test1]' => array('type' => PARAM_INT)), 'hidden', 'button');
  652. }
  653. }
  654. /**
  655. * Used to check value cleaning.
  656. */
  657. class formslib_clean_value extends moodleform {
  658. public function get_form() {
  659. return $this->_form;
  660. }
  661. public function definition() {
  662. $mform = $this->_form;
  663. // Add a simple int.
  664. $mform->addElement('text', 'simpleel', 'simpleel');
  665. $mform->setType('simpleel', PARAM_INT);
  666. // Add a non-named group.
  667. $group = array(
  668. $mform->createElement('text', 'groupel1', 'groupel1'),
  669. $mform->createElement('text', 'groupel2', 'groupel2'),
  670. $mform->createElement('text', 'groupel3', 'groupel3')
  671. );
  672. $mform->setType('groupel1', PARAM_INT);
  673. $mform->setType('groupel2', PARAM_FLOAT);
  674. $mform->setType('groupel3', PARAM_INT);
  675. $mform->addGroup($group);
  676. // Add a named group.
  677. $group = array(
  678. $mform->createElement('text', 'sndgroupel1', 'sndgroupel1'),
  679. $mform->createElement('text', 'sndgroupel2', 'sndgroupel2'),
  680. $mform->createElement('text', 'sndgroupel3', 'sndgroupel3')
  681. );
  682. $mform->addGroup($group, 'namedgroup');
  683. $mform->setType('namedgroup[sndgroupel1]', PARAM_INT);
  684. $mform->setType('namedgroup[sndgroupel2]', PARAM_FLOAT);
  685. $mform->setType('namedgroup[sndgroupel3]', PARAM_INT);
  686. // Add a named group, with inheritance.
  687. $group = array(
  688. $mform->createElement('text', 'thdgroupel1', 'thdgroupel1'),
  689. $mform->createElement('text', 'thdgroupel2', 'thdgroupel2')
  690. );
  691. $mform->addGroup($group, 'namedgroupinherit');
  692. $mform->setType('namedgroupinherit', PARAM_INT);
  693. // Add a repetition.
  694. $repeat = $mform->createElement('text', 'repeatedel', 'repeatedel');
  695. $this->repeat_elements(array($repeat), 2, array('repeatedel' => array('type' => PARAM_INT)), 'repeatable', 'add', 0);
  696. // Add a repetition, with inheritance.
  697. $repeat = $mform->createElement('text', 'repeatedelinherit', 'repeatedelinherit');
  698. $this->repeat_elements(array($repeat), 2, array(), 'repeatableinherit', 'add', 0);
  699. $mform->setType('repeatedelinherit', PARAM_INT);
  700. // Add an arbitrary named element.
  701. $mform->addElement('text', 'squaretest[0]', 'squaretest[0]');
  702. $mform->setType('squaretest[0]', PARAM_INT);
  703. // Add an arbitrary nested array named element.
  704. $mform->addElement('text', 'nested[0][bob][123]', 'nested[0][bob][123]');
  705. $mform->setType('nested[0][bob][123]', PARAM_INT);
  706. // Add inheritance test cases.
  707. $mform->setType('nested', PARAM_INT);
  708. $mform->setType('nested[0]', PARAM_RAW);
  709. $mform->setType('nested[0][bob]', PARAM_FLOAT);
  710. $mform->addElement('text', 'nested[1]', 'nested[1]');
  711. $mform->addElement('text', 'nested[0][xyz]', 'nested[0][xyz]');
  712. $mform->addElement('text', 'nested[0][bob][foo]', 'nested[0][bob][foo]');
  713. // Add group in repeated element (with extra inheritance).
  714. $groupelements = array(
  715. $mform->createElement('text', 'repeatgroupel1', 'repeatgroupel1'),
  716. $mform->createElement('text', 'repeatgroupel2', 'repeatgroupel2')
  717. );
  718. $group = $mform->createElement('group', 'repeatgroup', 'repeatgroup', $groupelements, null, false);
  719. $this->repeat_elements(array($group), 2, array('repeatgroupel1' => array('type' => PARAM_INT),
  720. 'repeatgroupel2' => array('type' => PARAM_INT)), 'repeatablegroup', 'add', 0);
  721. // Add named group in repeated element.
  722. $groupelements = array(
  723. $mform->createElement('text', 'repeatnamedgroupel1', 'repeatnamedgroupel1'),
  724. $mform->createElement('text', 'repeatnamedgroupel2', 'repeatnamedgroupel2')
  725. );
  726. $group = $mform->createElement('group', 'repeatnamedgroup', 'repeatnamedgroup', $groupelements, null, true);
  727. $this->repeat_elements(array($group), 2, array('repeatnamedgroup[repeatnamedgroupel1]' => array('type' => PARAM_INT),
  728. 'repeatnamedgroup[repeatnamedgroupel2]' => array('type' => PARAM_INT)), 'repeatablenamedgroup', 'add', 0);
  729. }
  730. }