EntityContextTest.php 27 KB

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