EntityContextTest.php 26 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042
  1. <?php
  2. /**
  3. * CakePHP(tm) : Rapid Development Framework (http://cakephp.org)
  4. * Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
  5. *
  6. * Licensed under The MIT License
  7. * For full copyright and license information, please see the LICENSE.txt
  8. * Redistributions of files must retain the above copyright notice.
  9. *
  10. * @copyright Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
  11. * @link http://cakephp.org CakePHP(tm) Project
  12. * @since 3.0.0
  13. * @license http://www.opensource.org/licenses/mit-license.php MIT License
  14. */
  15. namespace Cake\Test\TestCase\View\Form;
  16. use ArrayIterator;
  17. use ArrayObject;
  18. use Cake\Collection\Collection;
  19. use Cake\Network\Request;
  20. use Cake\ORM\Entity;
  21. use Cake\ORM\Table;
  22. use Cake\ORM\TableRegistry;
  23. use Cake\TestSuite\TestCase;
  24. use Cake\Validation\Validator;
  25. use Cake\View\Form\EntityContext;
  26. /**
  27. * Test stub.
  28. */
  29. class Article extends Entity {
  30. }
  31. /**
  32. * Entity context test case.
  33. */
  34. class EntityContextTest extends TestCase {
  35. /**
  36. * Fixtures to use.
  37. *
  38. * @var array
  39. */
  40. public $fixtures = ['core.articles', 'core.comments'];
  41. /**
  42. * setup method.
  43. *
  44. * @return void
  45. */
  46. public function setUp() {
  47. parent::setUp();
  48. $this->request = new Request();
  49. }
  50. /**
  51. * Test getting primary key data.
  52. *
  53. * @return void
  54. */
  55. public function testPrimaryKey() {
  56. $row = new Article();
  57. $context = new EntityContext($this->request, [
  58. 'entity' => $row,
  59. ]);
  60. $this->assertEquals(['id'], $context->primaryKey());
  61. }
  62. /**
  63. * Test isPrimaryKey
  64. *
  65. * @return void
  66. */
  67. public function testIsPrimaryKey() {
  68. $row = new Article();
  69. $context = new EntityContext($this->request, [
  70. 'entity' => $row,
  71. ]);
  72. $this->assertTrue($context->isPrimaryKey('id'));
  73. $this->assertFalse($context->isPrimaryKey('title'));
  74. $this->assertTrue($context->isPrimaryKey('1.id'));
  75. $this->assertTrue($context->isPrimaryKey('Articles.1.id'));
  76. $this->assertTrue($context->isPrimaryKey('comments.0.id'));
  77. $this->assertTrue($context->isPrimaryKey('1.comments.0.id'));
  78. $this->assertFalse($context->isPrimaryKey('1.comments.0.comment'));
  79. $this->assertFalse($context->isPrimaryKey('Articles.1.comments.0.comment'));
  80. }
  81. /**
  82. * Test isCreate on a single entity.
  83. *
  84. * @return void
  85. */
  86. public function testIsCreateSingle() {
  87. $row = new Article();
  88. $context = new EntityContext($this->request, [
  89. 'entity' => $row,
  90. ]);
  91. $this->assertTrue($context->isCreate());
  92. $row->isNew(false);
  93. $this->assertFalse($context->isCreate());
  94. $row->isNew(true);
  95. $this->assertTrue($context->isCreate());
  96. }
  97. /**
  98. * Test isCreate on a collection.
  99. *
  100. * @dataProvider collectionProvider
  101. * @return void
  102. */
  103. public function testIsCreateCollection($collection) {
  104. $context = new EntityContext($this->request, [
  105. 'entity' => $collection,
  106. ]);
  107. $this->assertTrue($context->isCreate());
  108. }
  109. /**
  110. * Test an invalid table scope throws an error.
  111. *
  112. * @expectedException \RuntimeException
  113. * @expectedExceptionMessage Unable to find table class for current entity
  114. */
  115. public function testInvalidTable() {
  116. $row = new \StdClass();
  117. $context = new EntityContext($this->request, [
  118. 'entity' => $row,
  119. ]);
  120. }
  121. /**
  122. * Tests that passing a plain entity will give an error as it cannot be matched
  123. *
  124. * @expectedException \RuntimeException
  125. * @expectedExceptionMessage Unable to find table class for current entity
  126. */
  127. public function testDefaultEntityError() {
  128. $context = new EntityContext($this->request, [
  129. 'entity' => new \Cake\ORM\Entity,
  130. ]);
  131. }
  132. /**
  133. * Tests that the table can be derived from the entity source if it is present
  134. *
  135. * @return void
  136. */
  137. public function testTableFromEntitySource() {
  138. $entity = new Entity;
  139. $entity->source('Articles');
  140. $context = new EntityContext($this->request, [
  141. 'entity' => $entity,
  142. ]);
  143. $expected = ['id', 'author_id', 'title', 'body', 'published'];
  144. $this->assertEquals($expected, $context->fieldNames());
  145. }
  146. /**
  147. * Test operations with no entity.
  148. *
  149. * @return void
  150. */
  151. public function testOperationsNoEntity() {
  152. $context = new EntityContext($this->request, [
  153. 'table' => 'Articles'
  154. ]);
  155. $this->assertNull($context->val('title'));
  156. $this->assertFalse($context->isRequired('title'));
  157. $this->assertFalse($context->hasError('title'));
  158. $this->assertEquals('string', $context->type('title'));
  159. $this->assertEquals([], $context->error('title'));
  160. $attrs = $context->attributes('title');
  161. $this->assertArrayHasKey('length', $attrs);
  162. $this->assertArrayHasKey('precision', $attrs);
  163. }
  164. /**
  165. * Test operations that lack a table argument.
  166. *
  167. * @return void
  168. */
  169. public function testOperationsNoTableArg() {
  170. $row = new Article([
  171. 'title' => 'Test entity',
  172. 'body' => 'Something new'
  173. ]);
  174. $row->errors('title', ['Title is required.']);
  175. $context = new EntityContext($this->request, [
  176. 'entity' => $row,
  177. ]);
  178. $result = $context->val('title');
  179. $this->assertEquals($row->title, $result);
  180. $result = $context->error('title');
  181. $this->assertEquals($row->errors('title'), $result);
  182. $this->assertTrue($context->hasError('title'));
  183. }
  184. /**
  185. * Test collection operations that lack a table argument.
  186. *
  187. * @dataProvider collectionProvider
  188. * @return void
  189. */
  190. public function testCollectionOperationsNoTableArg($collection) {
  191. $context = new EntityContext($this->request, [
  192. 'entity' => $collection,
  193. ]);
  194. $result = $context->val('0.title');
  195. $this->assertEquals('First post', $result);
  196. $result = $context->error('1.body');
  197. $this->assertEquals(['Not long enough'], $result);
  198. }
  199. /**
  200. * Data provider for testing collections.
  201. *
  202. * @return array
  203. */
  204. public static function collectionProvider() {
  205. $one = new Article([
  206. 'title' => 'First post',
  207. 'body' => 'Stuff',
  208. 'user' => new Entity(['username' => 'mark'])
  209. ]);
  210. $one->errors('title', 'Required field');
  211. $two = new Article([
  212. 'title' => 'Second post',
  213. 'body' => 'Some text',
  214. 'user' => new Entity(['username' => 'jose'])
  215. ]);
  216. $two->errors('body', 'Not long enough');
  217. return [
  218. 'array' => [[$one, $two]],
  219. 'basic iterator' => [new ArrayObject([$one, $two])],
  220. 'array iterator' => [new ArrayIterator([$one, $two])],
  221. 'collection' => [new Collection([$one, $two])],
  222. ];
  223. }
  224. /**
  225. * Test operations on a collection of entities.
  226. *
  227. * @dataProvider collectionProvider
  228. * @return void
  229. */
  230. public function testValOnCollections($collection) {
  231. $context = new EntityContext($this->request, [
  232. 'entity' => $collection,
  233. 'table' => 'Articles',
  234. ]);
  235. $result = $context->val('0.title');
  236. $this->assertEquals('First post', $result);
  237. $result = $context->val('0.user.username');
  238. $this->assertEquals('mark', $result);
  239. $result = $context->val('1.title');
  240. $this->assertEquals('Second post', $result);
  241. $result = $context->val('1.user.username');
  242. $this->assertEquals('jose', $result);
  243. $this->assertNull($context->val('nope'));
  244. $this->assertNull($context->val('99.title'));
  245. }
  246. /**
  247. * Test operations on a collection of entities when prefixing with the
  248. * table name
  249. *
  250. * @dataProvider collectionProvider
  251. * @return void
  252. */
  253. public function testValOnCollectionsWithRootName($collection) {
  254. $context = new EntityContext($this->request, [
  255. 'entity' => $collection,
  256. 'table' => 'Articles',
  257. ]);
  258. $result = $context->val('Articles.0.title');
  259. $this->assertEquals('First post', $result);
  260. $result = $context->val('Articles.0.user.username');
  261. $this->assertEquals('mark', $result);
  262. $result = $context->val('Articles.1.title');
  263. $this->assertEquals('Second post', $result);
  264. $result = $context->val('Articles.1.user.username');
  265. $this->assertEquals('jose', $result);
  266. $this->assertNull($context->val('Articles.99.title'));
  267. }
  268. /**
  269. * Test error operations on a collection of entities.
  270. *
  271. * @dataProvider collectionProvider
  272. * @return void
  273. */
  274. public function testErrorsOnCollections($collection) {
  275. $context = new EntityContext($this->request, [
  276. 'entity' => $collection,
  277. 'table' => 'Articles',
  278. ]);
  279. $this->assertTrue($context->hasError('0.title'));
  280. $this->assertEquals(['Required field'], $context->error('0.title'));
  281. $this->assertFalse($context->hasError('0.body'));
  282. $this->assertFalse($context->hasError('1.title'));
  283. $this->assertEquals(['Not long enough'], $context->error('1.body'));
  284. $this->assertTrue($context->hasError('1.body'));
  285. $this->assertFalse($context->hasError('nope'));
  286. $this->assertFalse($context->hasError('99.title'));
  287. }
  288. /**
  289. * Test schema operations on a collection of entities.
  290. *
  291. * @dataProvider collectionProvider
  292. * @return void
  293. */
  294. public function testSchemaOnCollections($collection) {
  295. $this->_setupTables();
  296. $context = new EntityContext($this->request, [
  297. 'entity' => $collection,
  298. 'table' => 'Articles',
  299. ]);
  300. $this->assertEquals('string', $context->type('0.title'));
  301. $this->assertEquals('text', $context->type('1.body'));
  302. $this->assertEquals('string', $context->type('0.user.username'));
  303. $this->assertEquals('string', $context->type('1.user.username'));
  304. $this->assertEquals('string', $context->type('99.title'));
  305. $this->assertNull($context->type('0.nope'));
  306. $expected = ['length' => 255, 'precision' => null];
  307. $this->assertEquals($expected, $context->attributes('0.user.username'));
  308. }
  309. /**
  310. * Test validation operations on a collection of entities.
  311. *
  312. * @dataProvider collectionProvider
  313. * @return void
  314. */
  315. public function testValidatorsOnCollections($collection) {
  316. $this->_setupTables();
  317. $context = new EntityContext($this->request, [
  318. 'entity' => $collection,
  319. 'table' => 'Articles',
  320. 'validator' => [
  321. 'Articles' => 'create',
  322. 'Users' => 'custom',
  323. ]
  324. ]);
  325. $this->assertFalse($context->isRequired('nope'));
  326. $this->assertTrue($context->isRequired('0.title'));
  327. $this->assertTrue($context->isRequired('0.user.username'));
  328. $this->assertFalse($context->isRequired('1.body'));
  329. $this->assertTrue($context->isRequired('99.title'));
  330. $this->assertFalse($context->isRequired('99.nope'));
  331. }
  332. /**
  333. * Test reading data.
  334. *
  335. * @return void
  336. */
  337. public function testValBasic() {
  338. $row = new Article([
  339. 'title' => 'Test entity',
  340. 'body' => 'Something new'
  341. ]);
  342. $context = new EntityContext($this->request, [
  343. 'entity' => $row,
  344. 'table' => 'Articles',
  345. ]);
  346. $result = $context->val('title');
  347. $this->assertEquals($row->title, $result);
  348. $result = $context->val('body');
  349. $this->assertEquals($row->body, $result);
  350. $result = $context->val('nope');
  351. $this->assertNull($result);
  352. }
  353. /**
  354. * Test reading array values from an entity.
  355. *
  356. * @return void
  357. */
  358. public function testValGetArrayValue() {
  359. $row = new Article([
  360. 'title' => 'Test entity',
  361. 'types' => [1, 2, 3],
  362. 'author' => new Entity([
  363. 'roles' => ['admin', 'publisher']
  364. ])
  365. ]);
  366. $context = new EntityContext($this->request, [
  367. 'entity' => $row,
  368. 'table' => 'Articles',
  369. ]);
  370. $result = $context->val('types');
  371. $this->assertEquals($row->types, $result);
  372. $result = $context->val('author.roles');
  373. $this->assertEquals($row->author->roles, $result);
  374. }
  375. /**
  376. * Test that val() reads from the request.
  377. *
  378. * @return void
  379. */
  380. public function testValReadsRequest() {
  381. $this->request->data = [
  382. 'title' => 'New title',
  383. 'notInEntity' => 'yes',
  384. ];
  385. $row = new Article([
  386. 'title' => 'Test entity',
  387. 'body' => 'Something new'
  388. ]);
  389. $context = new EntityContext($this->request, [
  390. 'entity' => $row,
  391. 'table' => 'Articles',
  392. ]);
  393. $this->assertEquals('New title', $context->val('title'));
  394. $this->assertEquals('yes', $context->val('notInEntity'));
  395. $this->assertEquals($row->body, $context->val('body'));
  396. }
  397. /**
  398. * Test reading values from associated entities.
  399. *
  400. * @return void
  401. */
  402. public function testValAssociated() {
  403. $row = new Article([
  404. 'title' => 'Test entity',
  405. 'user' => new Entity([
  406. 'username' => 'mark',
  407. 'fname' => 'Mark'
  408. ]),
  409. 'comments' => [
  410. new Entity(['comment' => 'Test comment']),
  411. new Entity(['comment' => 'Second comment']),
  412. ]
  413. ]);
  414. $context = new EntityContext($this->request, [
  415. 'entity' => $row,
  416. 'table' => 'Articles',
  417. ]);
  418. $result = $context->val('user.fname');
  419. $this->assertEquals($row->user->fname, $result);
  420. $result = $context->val('comments.0.comment');
  421. $this->assertEquals($row->comments[0]->comment, $result);
  422. $result = $context->val('comments.1.comment');
  423. $this->assertEquals($row->comments[1]->comment, $result);
  424. $result = $context->val('comments.0.nope');
  425. $this->assertNull($result);
  426. $result = $context->val('comments.0.nope.no_way');
  427. $this->assertNull($result);
  428. }
  429. /**
  430. * Tests that trying to get values from missing associations returns null
  431. *
  432. * @return void
  433. */
  434. public function testValMissingAssociation() {
  435. $row = new Article([
  436. 'id' => 1
  437. ]);
  438. $context = new EntityContext($this->request, [
  439. 'entity' => $row,
  440. 'table' => 'Articles',
  441. ]);
  442. $result = $context->val('id');
  443. $this->assertEquals($row->id, $result);
  444. $this->assertNull($context->val('profile.id'));
  445. }
  446. /**
  447. * Test reading values from associated entities.
  448. *
  449. * @return void
  450. */
  451. public function testValAssociatedHasMany() {
  452. $row = new Article([
  453. 'title' => 'First post',
  454. 'user' => new Entity([
  455. 'username' => 'mark',
  456. 'fname' => 'Mark',
  457. 'articles' => [
  458. new Article(['title' => 'First post']),
  459. new Article(['title' => 'Second post']),
  460. ]
  461. ]),
  462. ]);
  463. $context = new EntityContext($this->request, [
  464. 'entity' => $row,
  465. 'table' => 'Articles',
  466. ]);
  467. $result = $context->val('user.articles.0.title');
  468. $this->assertEquals('First post', $result);
  469. $result = $context->val('user.articles.1.title');
  470. $this->assertEquals('Second post', $result);
  471. }
  472. /**
  473. * Test reading values for magic _ids input
  474. *
  475. * @return void
  476. */
  477. public function testValAssociatedDefaultIds() {
  478. $row = new Article([
  479. 'title' => 'First post',
  480. 'user' => new Entity([
  481. 'username' => 'mark',
  482. 'fname' => 'Mark',
  483. 'groups' => [
  484. new Entity(['title' => 'PHP', 'id' => 1]),
  485. new Entity(['title' => 'Javascript', 'id' => 2]),
  486. ]
  487. ]),
  488. ]);
  489. $context = new EntityContext($this->request, [
  490. 'entity' => $row,
  491. 'table' => 'Articles',
  492. ]);
  493. $result = $context->val('user.groups._ids');
  494. $this->assertEquals([1, 2], $result);
  495. }
  496. /**
  497. * Test reading values for magic _ids input
  498. *
  499. * @return void
  500. */
  501. public function testValAssociatedCustomIds() {
  502. $row = new Article([
  503. 'title' => 'First post',
  504. 'user' => new Entity([
  505. 'username' => 'mark',
  506. 'fname' => 'Mark',
  507. 'groups' => [
  508. new Entity(['title' => 'PHP', 'thing' => 1]),
  509. new Entity(['title' => 'Javascript', 'thing' => 4]),
  510. ]
  511. ]),
  512. ]);
  513. $context = new EntityContext($this->request, [
  514. 'entity' => $row,
  515. 'table' => 'Articles',
  516. ]);
  517. TableRegistry::get('Users')->belongsToMany('Groups');
  518. TableRegistry::get('Groups')->primaryKey('thing');
  519. $result = $context->val('user.groups._ids');
  520. $this->assertEquals([1, 4], $result);
  521. }
  522. /**
  523. * Test validator as a string.
  524. *
  525. * @return void
  526. */
  527. public function testIsRequiredStringValidator() {
  528. $this->_setupTables();
  529. $context = new EntityContext($this->request, [
  530. 'entity' => new Entity(),
  531. 'table' => 'Articles',
  532. 'validator' => 'create',
  533. ]);
  534. $this->assertTrue($context->isRequired('title'));
  535. $this->assertFalse($context->isRequired('body'));
  536. $this->assertFalse($context->isRequired('Herp.derp.derp'));
  537. $this->assertFalse($context->isRequired('nope'));
  538. $this->assertFalse($context->isRequired(''));
  539. }
  540. /**
  541. * Test isRequired on associated entities.
  542. *
  543. * @return void
  544. */
  545. public function testIsRequiredAssociatedHasMany() {
  546. $this->_setupTables();
  547. $comments = TableRegistry::get('Comments');
  548. $validator = $comments->validator();
  549. $validator->add('user_id', 'number', [
  550. 'rule' => 'numeric',
  551. ]);
  552. $row = new Article([
  553. 'title' => 'My title',
  554. 'comments' => [
  555. new Entity(['comment' => 'First comment']),
  556. new Entity(['comment' => 'Second comment']),
  557. ]
  558. ]);
  559. $context = new EntityContext($this->request, [
  560. 'entity' => $row,
  561. 'table' => 'Articles',
  562. 'validator' => 'default',
  563. ]);
  564. $this->assertTrue($context->isRequired('comments.0.user_id'));
  565. $this->assertFalse($context->isRequired('comments.0.other'));
  566. $this->assertFalse($context->isRequired('user.0.other'));
  567. $this->assertFalse($context->isRequired(''));
  568. }
  569. /**
  570. * Test isRequired on associated entities.
  571. *
  572. * @return void
  573. */
  574. public function testIsRequiredAssociatedHasManyMissingObject() {
  575. $this->_setupTables();
  576. $comments = TableRegistry::get('Comments');
  577. $validator = $comments->validator();
  578. $validator->allowEmpty('comment', function ($context) {
  579. return $context['providers']['entity']->isNew();
  580. });
  581. $row = new Article([
  582. 'title' => 'My title',
  583. 'comments' => [
  584. new Entity(['comment' => 'First comment'], ['markNew' => false]),
  585. ]
  586. ]);
  587. $context = new EntityContext($this->request, [
  588. 'entity' => $row,
  589. 'table' => 'Articles',
  590. 'validator' => 'default',
  591. ]);
  592. $this->assertTrue(
  593. $context->isRequired('comments.0.comment'),
  594. 'comment is required as object is not new'
  595. );
  596. $this->assertFalse(
  597. $context->isRequired('comments.1.comment'),
  598. 'comment is not required as missing object is "new"'
  599. );
  600. }
  601. /**
  602. * Test isRequired on associated entities with custom validators.
  603. *
  604. * @return void
  605. */
  606. public function testIsRequiredAssociatedValidator() {
  607. $this->_setupTables();
  608. $row = new Article([
  609. 'title' => 'My title',
  610. 'comments' => [
  611. new Entity(['comment' => 'First comment']),
  612. new Entity(['comment' => 'Second comment']),
  613. ]
  614. ]);
  615. $context = new EntityContext($this->request, [
  616. 'entity' => $row,
  617. 'table' => 'Articles',
  618. 'validator' => [
  619. 'Articles' => 'create',
  620. 'Comments' => 'custom'
  621. ]
  622. ]);
  623. $this->assertTrue($context->isRequired('title'));
  624. $this->assertFalse($context->isRequired('body'));
  625. $this->assertTrue($context->isRequired('comments.0.comment'));
  626. $this->assertTrue($context->isRequired('comments.1.comment'));
  627. }
  628. /**
  629. * Test isRequired on associated entities.
  630. *
  631. * @return void
  632. */
  633. public function testIsRequiredAssociatedBelongsTo() {
  634. $this->_setupTables();
  635. $row = new Article([
  636. 'title' => 'My title',
  637. 'user' => new Entity(['username' => 'Mark']),
  638. ]);
  639. $context = new EntityContext($this->request, [
  640. 'entity' => $row,
  641. 'table' => 'Articles',
  642. 'validator' => [
  643. 'Articles' => 'create',
  644. 'Users' => 'custom'
  645. ]
  646. ]);
  647. $this->assertTrue($context->isRequired('user.username'));
  648. $this->assertFalse($context->isRequired('user.first_name'));
  649. }
  650. /**
  651. * Test type() basic
  652. *
  653. * @return void
  654. */
  655. public function testType() {
  656. $this->_setupTables();
  657. $row = new Article([
  658. 'title' => 'My title',
  659. 'body' => 'Some content',
  660. ]);
  661. $context = new EntityContext($this->request, [
  662. 'entity' => $row,
  663. 'table' => 'Articles',
  664. ]);
  665. $this->assertEquals('string', $context->type('title'));
  666. $this->assertEquals('text', $context->type('body'));
  667. $this->assertEquals('integer', $context->type('user_id'));
  668. $this->assertNull($context->type('nope'));
  669. }
  670. /**
  671. * Test getting types for associated records.
  672. *
  673. * @return void
  674. */
  675. public function testTypeAssociated() {
  676. $this->_setupTables();
  677. $row = new Article([
  678. 'title' => 'My title',
  679. 'user' => new Entity(['username' => 'Mark']),
  680. ]);
  681. $context = new EntityContext($this->request, [
  682. 'entity' => $row,
  683. 'table' => 'Articles',
  684. ]);
  685. $this->assertEquals('string', $context->type('user.username'));
  686. $this->assertEquals('text', $context->type('user.bio'));
  687. $this->assertNull($context->type('user.nope'));
  688. }
  689. /**
  690. * Test attributes for fields.
  691. *
  692. * @return void
  693. */
  694. public function testAttributes() {
  695. $this->_setupTables();
  696. $row = new Article([
  697. 'title' => 'My title',
  698. 'user' => new Entity(['username' => 'Mark']),
  699. ]);
  700. $context = new EntityContext($this->request, [
  701. 'entity' => $row,
  702. 'table' => 'Articles',
  703. ]);
  704. $expected = [
  705. 'length' => 255, 'precision' => null
  706. ];
  707. $this->assertEquals($expected, $context->attributes('title'));
  708. $expected = [
  709. 'length' => null, 'precision' => null
  710. ];
  711. $this->assertEquals($expected, $context->attributes('body'));
  712. $expected = [
  713. 'length' => 10, 'precision' => 3
  714. ];
  715. $this->assertEquals($expected, $context->attributes('user.rating'));
  716. }
  717. /**
  718. * Test hasError
  719. *
  720. * @return void
  721. */
  722. public function testHasError() {
  723. $this->_setupTables();
  724. $row = new Article([
  725. 'title' => 'My title',
  726. 'user' => new Entity(['username' => 'Mark']),
  727. ]);
  728. $row->errors('title', []);
  729. $row->errors('body', 'Gotta have one');
  730. $row->errors('user_id', ['Required field']);
  731. $context = new EntityContext($this->request, [
  732. 'entity' => $row,
  733. 'table' => 'Articles',
  734. ]);
  735. $this->assertFalse($context->hasError('title'));
  736. $this->assertFalse($context->hasError('nope'));
  737. $this->assertTrue($context->hasError('body'));
  738. $this->assertTrue($context->hasError('user_id'));
  739. }
  740. /**
  741. * Test hasError on associated records
  742. *
  743. * @return void
  744. */
  745. public function testHasErrorAssociated() {
  746. $this->_setupTables();
  747. $row = new Article([
  748. 'title' => 'My title',
  749. 'user' => new Entity(['username' => 'Mark']),
  750. ]);
  751. $row->errors('title', []);
  752. $row->errors('body', 'Gotta have one');
  753. $row->user->errors('username', ['Required']);
  754. $context = new EntityContext($this->request, [
  755. 'entity' => $row,
  756. 'table' => 'Articles',
  757. ]);
  758. $this->assertTrue($context->hasError('user.username'));
  759. $this->assertFalse($context->hasError('user.nope'));
  760. $this->assertFalse($context->hasError('no.nope'));
  761. }
  762. /**
  763. * Test error
  764. *
  765. * @return void
  766. */
  767. public function testError() {
  768. $this->_setupTables();
  769. $row = new Article([
  770. 'title' => 'My title',
  771. 'user' => new Entity(['username' => 'Mark']),
  772. ]);
  773. $row->errors('title', []);
  774. $row->errors('body', 'Gotta have one');
  775. $row->errors('user_id', ['Required field']);
  776. $row->user->errors('username', ['Required']);
  777. $context = new EntityContext($this->request, [
  778. 'entity' => $row,
  779. 'table' => 'Articles',
  780. ]);
  781. $this->assertEquals([], $context->error('title'));
  782. $expected = ['Gotta have one'];
  783. $this->assertEquals($expected, $context->error('body'));
  784. $expected = ['Required'];
  785. $this->assertEquals($expected, $context->error('user.username'));
  786. }
  787. /**
  788. * Test error on associated entities.
  789. *
  790. * @return void
  791. */
  792. public function testErrorAssociatedHasMany() {
  793. $this->_setupTables();
  794. $comments = TableRegistry::get('Comments');
  795. $row = new Article([
  796. 'title' => 'My title',
  797. 'comments' => [
  798. new Entity(['comment' => '']),
  799. new Entity(['comment' => 'Second comment']),
  800. ]
  801. ]);
  802. $row->comments[0]->errors('comment', ['Is required']);
  803. $context = new EntityContext($this->request, [
  804. 'entity' => $row,
  805. 'table' => 'Articles',
  806. 'validator' => 'default',
  807. ]);
  808. $this->assertEquals([], $context->error('title'));
  809. $this->assertEquals([], $context->error('comments.0.user_id'));
  810. $this->assertEquals([], $context->error('comments.0'));
  811. $this->assertEquals(['Is required'], $context->error('comments.0.comment'));
  812. $this->assertEquals([], $context->error('comments.1'));
  813. $this->assertEquals([], $context->error('comments.1.comment'));
  814. }
  815. /**
  816. * Setup tables for tests.
  817. *
  818. * @return void
  819. */
  820. protected function _setupTables() {
  821. $articles = TableRegistry::get('Articles');
  822. $articles->belongsTo('Users');
  823. $articles->hasMany('Comments');
  824. $comments = TableRegistry::get('Comments');
  825. $users = TableRegistry::get('Users');
  826. $users->hasMany('Articles');
  827. $articles->schema([
  828. 'id' => ['type' => 'integer', 'length' => 11, 'null' => false],
  829. 'title' => ['type' => 'string', 'length' => 255],
  830. 'user_id' => ['type' => 'integer', 'length' => 11, 'null' => false],
  831. 'body' => ['type' => 'text']
  832. ]);
  833. $users->schema([
  834. 'id' => ['type' => 'integer', 'length' => 11],
  835. 'username' => ['type' => 'string', 'length' => 255],
  836. 'bio' => ['type' => 'text'],
  837. 'rating' => ['type' => 'decimal', 'length' => 10, 'precision' => 3],
  838. ]);
  839. $validator = new Validator();
  840. $validator->add('title', 'minlength', [
  841. 'rule' => ['minlength', 10]
  842. ])
  843. ->add('body', 'maxlength', [
  844. 'rule' => ['maxlength', 1000]
  845. ])->allowEmpty('body');
  846. $articles->validator('create', $validator);
  847. $validator = new Validator();
  848. $validator->add('username', 'length', [
  849. 'rule' => ['minlength', 10]
  850. ]);
  851. $users->validator('custom', $validator);
  852. $validator = new Validator();
  853. $validator->add('comment', 'length', [
  854. 'rule' => ['minlength', 10]
  855. ]);
  856. $comments->validator('custom', $validator);
  857. }
  858. /**
  859. * Test the fieldnames method.
  860. *
  861. * @return void
  862. */
  863. public function testFieldNames() {
  864. $context = new EntityContext($this->request, [
  865. 'entity' => new Entity(),
  866. 'table' => 'Articles',
  867. ]);
  868. $articles = TableRegistry::get('Articles');
  869. $this->assertEquals($articles->schema()->columns(), $context->fieldNames());
  870. }
  871. /**
  872. * Test automatic entity provider setting
  873. *
  874. * @return void
  875. */
  876. public function testValidatorEntityProvider() {
  877. $row = new Article([
  878. 'title' => 'Test entity',
  879. 'body' => 'Something new'
  880. ]);
  881. $context = new EntityContext($this->request, [
  882. 'entity' => $row,
  883. 'table' => 'Articles',
  884. ]);
  885. $context->isRequired('title');
  886. $articles = TableRegistry::get('Articles');
  887. $this->assertSame($row, $articles->validator()->provider('entity'));
  888. $row = new Article([
  889. 'title' => 'First post',
  890. 'user' => new Entity([
  891. 'username' => 'mark',
  892. 'fname' => 'Mark',
  893. 'articles' => [
  894. new Article(['title' => 'First post']),
  895. new Article(['title' => 'Second post']),
  896. ]
  897. ]),
  898. ]);
  899. $context = new EntityContext($this->request, [
  900. 'entity' => $row,
  901. 'table' => 'Articles',
  902. ]);
  903. $validator = $articles->validator();
  904. $context->isRequired('user.articles.0.title');
  905. $this->assertSame($row->user->articles[0], $validator->provider('entity'));
  906. $context->isRequired('user.articles.1.title');
  907. $this->assertSame($row->user->articles[1], $validator->provider('entity'));
  908. $context->isRequired('title');
  909. $this->assertSame($row, $validator->provider('entity'));
  910. }
  911. }