ViewTest.php 65 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173
  1. <?php
  2. /**
  3. * CakePHP(tm) : Rapid Development Framework (https://cakephp.org)
  4. * Copyright (c) Cake Software Foundation, Inc. (https://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. (https://cakefoundation.org)
  11. * @link https://cakephp.org CakePHP(tm) Project
  12. * @since 1.2.0
  13. * @license https://opensource.org/licenses/mit-license.php MIT License
  14. */
  15. namespace Cake\Test\TestCase\View;
  16. use Cake\Cache\Cache;
  17. use Cake\Controller\Controller;
  18. use Cake\Core\App;
  19. use Cake\Core\Configure;
  20. use Cake\Core\Plugin;
  21. use Cake\Event\Event;
  22. use Cake\Event\EventListenerInterface;
  23. use Cake\Http\ServerRequest;
  24. use Cake\Routing\Router;
  25. use Cake\TestSuite\TestCase;
  26. use Cake\View\Helper;
  27. use Cake\View\View;
  28. use TestApp\View\AppView;
  29. /**
  30. * ViewPostsController class
  31. */
  32. class ViewPostsController extends Controller
  33. {
  34. /**
  35. * name property
  36. *
  37. * @var string
  38. */
  39. public $name = 'Posts';
  40. /**
  41. * index method
  42. *
  43. * @return void
  44. */
  45. public function index()
  46. {
  47. $this->set([
  48. 'testData' => 'Some test data',
  49. 'test2' => 'more data',
  50. 'test3' => 'even more data',
  51. ]);
  52. }
  53. /**
  54. * nocache_tags_with_element method
  55. *
  56. * @return void
  57. */
  58. public function nocache_multiple_element()
  59. {
  60. $this->set('foo', 'this is foo var');
  61. $this->set('bar', 'this is bar var');
  62. }
  63. }
  64. /**
  65. * ThemePostsController class
  66. */
  67. class ThemePostsController extends Controller
  68. {
  69. /**
  70. * index method
  71. *
  72. * @return void
  73. */
  74. public function index()
  75. {
  76. $this->set('testData', 'Some test data');
  77. $test2 = 'more data';
  78. $test3 = 'even more data';
  79. $this->set(compact('test2', 'test3'));
  80. }
  81. }
  82. /**
  83. * TestView class
  84. */
  85. class TestView extends AppView
  86. {
  87. public function initialize()
  88. {
  89. $this->loadHelper('Html', ['mykey' => 'myval']);
  90. }
  91. /**
  92. * getViewFileName method
  93. *
  94. * @param string $name Controller action to find template filename for
  95. * @return string Template filename
  96. */
  97. public function getViewFileName($name = null)
  98. {
  99. return $this->_getViewFileName($name);
  100. }
  101. /**
  102. * getLayoutFileName method
  103. *
  104. * @param string $name The name of the layout to find.
  105. * @return string Filename for layout file (.ctp).
  106. */
  107. public function getLayoutFileName($name = null)
  108. {
  109. return $this->_getLayoutFileName($name);
  110. }
  111. /**
  112. * paths method
  113. *
  114. * @param string $plugin Optional plugin name to scan for view files.
  115. * @param bool $cached Set to true to force a refresh of view paths.
  116. * @return array paths
  117. */
  118. public function paths($plugin = null, $cached = true)
  119. {
  120. return $this->_paths($plugin, $cached);
  121. }
  122. /**
  123. * Setter for extension.
  124. *
  125. * @param string $ext The extension
  126. * @return void
  127. */
  128. public function ext($ext)
  129. {
  130. $this->_ext = $ext;
  131. }
  132. }
  133. /**
  134. * TestBeforeAfterHelper class
  135. */
  136. class TestBeforeAfterHelper extends Helper
  137. {
  138. /**
  139. * property property
  140. *
  141. * @var string
  142. */
  143. public $property = '';
  144. /**
  145. * beforeLayout method
  146. *
  147. * @param string $viewFile View file name.
  148. * @return void
  149. */
  150. public function beforeLayout($viewFile)
  151. {
  152. $this->property = 'Valuation';
  153. }
  154. /**
  155. * afterLayout method
  156. *
  157. * @param string $layoutFile Layout file name.
  158. * @return void
  159. */
  160. public function afterLayout($layoutFile)
  161. {
  162. $this->_View->append('content', 'modified in the afterlife');
  163. }
  164. }
  165. /**
  166. * TestObjectWithToString
  167. *
  168. * An object with the magic method __toString() for testing with view blocks.
  169. */
  170. class TestObjectWithToString
  171. {
  172. /**
  173. * Return string value.
  174. *
  175. * @return string
  176. */
  177. public function __toString()
  178. {
  179. return "I'm ObjectWithToString";
  180. }
  181. }
  182. /**
  183. * TestObjectWithoutToString
  184. *
  185. * An object without the magic method __toString() for testing with view blocks.
  186. */
  187. class TestObjectWithoutToString
  188. {
  189. }
  190. /**
  191. * TestViewEventListenerInterface
  192. *
  193. * An event listener to test cakePHP events
  194. */
  195. class TestViewEventListenerInterface implements EventListenerInterface
  196. {
  197. /**
  198. * type of view before rendering has occurred
  199. *
  200. * @var string
  201. */
  202. public $beforeRenderViewType;
  203. /**
  204. * type of view after rendering has occurred
  205. *
  206. * @var string
  207. */
  208. public $afterRenderViewType;
  209. /**
  210. * implementedEvents method
  211. *
  212. * @return array
  213. */
  214. public function implementedEvents()
  215. {
  216. return [
  217. 'View.beforeRender' => 'beforeRender',
  218. 'View.afterRender' => 'afterRender'
  219. ];
  220. }
  221. /**
  222. * beforeRender method
  223. *
  224. * @param \Cake\Event\Event $event the event being sent
  225. * @return void
  226. */
  227. public function beforeRender(Event $event)
  228. {
  229. $this->beforeRenderViewType = $event->getSubject()->getCurrentType();
  230. }
  231. /**
  232. * afterRender method
  233. *
  234. * @param \Cake\Event\Event $event the event being sent
  235. * @return void
  236. */
  237. public function afterRender(Event $event)
  238. {
  239. $this->afterRenderViewType = $event->getSubject()->getCurrentType();
  240. }
  241. }
  242. /**
  243. * ViewTest class
  244. */
  245. class ViewTest extends TestCase
  246. {
  247. /**
  248. * Fixtures used in this test.
  249. *
  250. * @var array
  251. */
  252. public $fixtures = ['core.posts', 'core.users'];
  253. /**
  254. * @var \Cake\View\View
  255. */
  256. public $View;
  257. /**
  258. * @var ViewPostsController
  259. */
  260. public $PostsController;
  261. /**
  262. * setUp method
  263. *
  264. * @return void
  265. */
  266. public function setUp()
  267. {
  268. parent::setUp();
  269. $request = new ServerRequest();
  270. $this->Controller = new Controller($request);
  271. $this->PostsController = new ViewPostsController($request);
  272. $this->PostsController->index();
  273. $this->View = $this->PostsController->createView();
  274. $this->View->setTemplatePath('Posts');
  275. $themeRequest = new ServerRequest('posts/index');
  276. $this->ThemeController = new Controller($themeRequest);
  277. $this->ThemePostsController = new ThemePostsController($themeRequest);
  278. $this->ThemePostsController->index();
  279. $this->ThemeView = $this->ThemePostsController->createView();
  280. $this->ThemeView->setTemplatePath('Posts');
  281. Plugin::load(['TestPlugin', 'PluginJs', 'TestTheme', 'Company/TestPluginThree']);
  282. Configure::write('debug', true);
  283. }
  284. /**
  285. * tearDown method
  286. *
  287. * @return void
  288. */
  289. public function tearDown()
  290. {
  291. parent::tearDown();
  292. Plugin::unload();
  293. unset($this->View);
  294. unset($this->PostsController);
  295. unset($this->Controller);
  296. unset($this->ThemeView);
  297. unset($this->ThemePostsController);
  298. unset($this->ThemeController);
  299. }
  300. /**
  301. * Test getViewFileName method
  302. *
  303. * @return void
  304. */
  305. public function testGetTemplate()
  306. {
  307. $viewOptions = [
  308. 'plugin' => null,
  309. 'name' => 'Pages',
  310. 'viewPath' => 'Pages'
  311. ];
  312. $ThemeView = new TestView(null, null, null, $viewOptions);
  313. $ThemeView->setTheme('TestTheme');
  314. $expected = TEST_APP . 'TestApp' . DS . 'Template' . DS . 'Pages' . DS . 'home.ctp';
  315. $result = $ThemeView->getViewFileName('home');
  316. $this->assertPathEquals($expected, $result);
  317. $expected = Plugin::path('TestTheme') . 'src' . DS . 'Template' . DS . 'Posts' . DS . 'index.ctp';
  318. $result = $ThemeView->getViewFileName('/Posts/index');
  319. $this->assertPathEquals($expected, $result);
  320. $expected = Plugin::path('TestTheme') . 'src' . DS . 'Template' . DS . 'Layout' . DS . 'default.ctp';
  321. $result = $ThemeView->getLayoutFileName();
  322. $this->assertPathEquals($expected, $result);
  323. $ThemeView->setLayoutPath('rss');
  324. $expected = TEST_APP . 'TestApp' . DS . 'Template' . DS . 'Layout' . DS . 'rss' . DS . 'default.ctp';
  325. $result = $ThemeView->getLayoutFileName();
  326. $this->assertPathEquals($expected, $result);
  327. $ThemeView->setLayoutPath('Email' . DS . 'html');
  328. $expected = TEST_APP . 'TestApp' . DS . 'Template' . DS . 'Layout' . DS . 'Email' . DS . 'html' . DS . 'default.ctp';
  329. $result = $ThemeView->getLayoutFileName();
  330. $this->assertPathEquals($expected, $result);
  331. $ThemeView = new TestView(null, null, null, $viewOptions);
  332. $ThemeView->setTheme('Company/TestPluginThree');
  333. $expected = Plugin::path('Company/TestPluginThree') . 'src' . DS . 'Template' . DS . 'Layout' . DS . 'default.ctp';
  334. $result = $ThemeView->getLayoutFileName();
  335. $this->assertPathEquals($expected, $result);
  336. }
  337. /**
  338. * Test getLayoutFileName method on plugin
  339. *
  340. * @return void
  341. */
  342. public function testPluginGetTemplate()
  343. {
  344. $viewOptions = ['plugin' => 'TestPlugin',
  345. 'name' => 'TestPlugin',
  346. 'viewPath' => 'Tests',
  347. 'view' => 'index'
  348. ];
  349. $View = new TestView(null, null, null, $viewOptions);
  350. $expected = Plugin::path('TestPlugin') . 'src' . DS . 'Template' . DS . 'Tests' . DS . 'index.ctp';
  351. $result = $View->getViewFileName('index');
  352. $this->assertEquals($expected, $result);
  353. $expected = Plugin::path('TestPlugin') . 'src' . DS . 'Template' . DS . 'Layout' . DS . 'default.ctp';
  354. $result = $View->getLayoutFileName();
  355. $this->assertEquals($expected, $result);
  356. }
  357. /**
  358. * Test that plugin files with absolute file paths are scoped
  359. * to the plugin and do now allow any file path.
  360. *
  361. * @return void
  362. */
  363. public function testPluginGetTemplateAbsoluteFail()
  364. {
  365. $this->expectException(\Cake\View\Exception\MissingTemplateException::class);
  366. $viewOptions = [
  367. 'plugin' => null,
  368. 'name' => 'Pages',
  369. 'viewPath' => 'Pages'
  370. ];
  371. $view = new TestView(null, null, null, $viewOptions);
  372. $expected = TEST_APP . 'Plugin' . DS . 'Company' . DS . 'TestPluginThree' . DS . 'src' . DS . 'Template' . DS . 'Pages' . DS . 'index.ctp';
  373. $result = $view->getViewFileName('Company/TestPluginThree./Pages/index');
  374. $this->assertPathEquals($expected, $result);
  375. $view->getViewFileName('Company/TestPluginThree./etc/passwd');
  376. }
  377. /**
  378. * Test getViewFileName method on plugin
  379. *
  380. * @return void
  381. */
  382. public function testPluginThemedGetTemplate()
  383. {
  384. $viewOptions = ['plugin' => 'TestPlugin',
  385. 'name' => 'TestPlugin',
  386. 'viewPath' => 'Tests',
  387. 'view' => 'index',
  388. 'theme' => 'TestTheme'
  389. ];
  390. $ThemeView = new TestView(null, null, null, $viewOptions);
  391. $themePath = Plugin::path('TestTheme') . 'src' . DS . 'Template' . DS;
  392. $expected = $themePath . 'Plugin' . DS . 'TestPlugin' . DS . 'Tests' . DS . 'index.ctp';
  393. $result = $ThemeView->getViewFileName('index');
  394. $this->assertPathEquals($expected, $result);
  395. $expected = $themePath . 'Plugin' . DS . 'TestPlugin' . DS . 'Layout' . DS . 'plugin_default.ctp';
  396. $result = $ThemeView->getLayoutFileName('plugin_default');
  397. $this->assertPathEquals($expected, $result);
  398. $expected = $themePath . 'Layout' . DS . 'default.ctp';
  399. $result = $ThemeView->getLayoutFileName('default');
  400. $this->assertPathEquals($expected, $result);
  401. }
  402. /**
  403. * Test that plugin/$plugin_name is only appended to the paths it should be.
  404. *
  405. * @return void
  406. */
  407. public function testPathPluginGeneration()
  408. {
  409. $viewOptions = ['plugin' => 'TestPlugin',
  410. 'name' => 'TestPlugin',
  411. 'viewPath' => 'Tests',
  412. 'view' => 'index'
  413. ];
  414. $View = new TestView(null, null, null, $viewOptions);
  415. $paths = $View->paths();
  416. $expected = array_merge(App::path('Template'), App::core('Template'));
  417. $this->assertEquals($expected, $paths);
  418. $paths = $View->paths('TestPlugin');
  419. $pluginPath = Plugin::path('TestPlugin');
  420. $expected = [
  421. TEST_APP . 'TestApp' . DS . 'Template' . DS . 'Plugin' . DS . 'TestPlugin' . DS,
  422. $pluginPath . 'src' . DS . 'Template' . DS,
  423. TEST_APP . 'TestApp' . DS . 'Template' . DS,
  424. CAKE . 'Template' . DS,
  425. ];
  426. $this->assertPathEquals($expected, $paths);
  427. }
  428. /**
  429. * Test that themed plugin paths are generated correctly.
  430. *
  431. * @return void
  432. */
  433. public function testPathThemedPluginGeneration()
  434. {
  435. $viewOptions = ['plugin' => 'TestPlugin',
  436. 'name' => 'TestPlugin',
  437. 'viewPath' => 'Tests',
  438. 'view' => 'index',
  439. 'theme' => 'TestTheme'
  440. ];
  441. $View = new TestView(null, null, null, $viewOptions);
  442. $paths = $View->paths('TestPlugin');
  443. $pluginPath = Plugin::path('TestPlugin');
  444. $themePath = Plugin::path('TestTheme');
  445. $expected = [
  446. $themePath . 'src' . DS . 'Template' . DS . 'Plugin' . DS . 'TestPlugin' . DS,
  447. $themePath . 'src' . DS . 'Template' . DS,
  448. TEST_APP . 'TestApp' . DS . 'Template' . DS . 'Plugin' . DS . 'TestPlugin' . DS,
  449. $pluginPath . 'src' . DS . 'Template' . DS,
  450. TEST_APP . 'TestApp' . DS . 'Template' . DS,
  451. CAKE . 'Template' . DS,
  452. ];
  453. $this->assertPathEquals($expected, $paths);
  454. }
  455. /**
  456. * Test that multiple paths can be used in App.paths.templates.
  457. *
  458. * @return void
  459. */
  460. public function testMultipleAppPaths()
  461. {
  462. $viewOptions = ['plugin' => 'TestPlugin',
  463. 'name' => 'TestPlugin',
  464. 'viewPath' => 'Tests',
  465. 'view' => 'index',
  466. 'theme' => 'TestTheme'
  467. ];
  468. $paths = Configure::read('App.paths.templates');
  469. $paths[] = Plugin::classPath('TestPlugin') . 'Template' . DS;
  470. Configure::write('App.paths.templates', $paths);
  471. $View = new TestView(null, null, null, $viewOptions);
  472. $paths = $View->paths('TestPlugin');
  473. $pluginPath = Plugin::path('TestPlugin');
  474. $themePath = Plugin::path('TestTheme');
  475. $expected = [
  476. $themePath . 'src' . DS . 'Template' . DS . 'Plugin' . DS . 'TestPlugin' . DS,
  477. $themePath . 'src' . DS . 'Template' . DS,
  478. TEST_APP . 'TestApp' . DS . 'Template' . DS . 'Plugin' . DS . 'TestPlugin' . DS,
  479. $pluginPath . 'src' . DS . 'Template' . DS . 'Plugin' . DS . 'TestPlugin' . DS,
  480. $pluginPath . 'src' . DS . 'Template' . DS,
  481. TEST_APP . 'TestApp' . DS . 'Template' . DS,
  482. TEST_APP . 'Plugin' . DS . 'TestPlugin' . DS . 'src' . DS . 'Template' . DS,
  483. CAKE . 'Template' . DS,
  484. ];
  485. $this->assertPathEquals($expected, $paths);
  486. }
  487. /**
  488. * Test that CamelCase'd plugins still find their view files.
  489. *
  490. * @return void
  491. */
  492. public function testCamelCasePluginGetTemplate()
  493. {
  494. $viewOptions = ['plugin' => 'TestPlugin',
  495. 'name' => 'TestPlugin',
  496. 'viewPath' => 'Tests',
  497. 'view' => 'index'
  498. ];
  499. $View = new TestView(null, null, null, $viewOptions);
  500. $pluginPath = Plugin::path('TestPlugin');
  501. $expected = TEST_APP . 'Plugin' . DS . 'TestPlugin' . DS . 'src' . DS .
  502. 'Template' . DS . 'Tests' . DS . 'index.ctp';
  503. $result = $View->getViewFileName('index');
  504. $this->assertPathEquals($expected, $result);
  505. $expected = $pluginPath . 'src' . DS . 'Template' . DS . 'Layout' . DS . 'default.ctp';
  506. $result = $View->getLayoutFileName();
  507. $this->assertPathEquals($expected, $result);
  508. }
  509. /**
  510. * Test getViewFileName method
  511. *
  512. * @return void
  513. */
  514. public function testGetViewFileNames()
  515. {
  516. $viewOptions = [
  517. 'plugin' => null,
  518. 'name' => 'Pages',
  519. 'viewPath' => 'Pages'
  520. ];
  521. $request = $this->getMockBuilder('Cake\Http\ServerRequest')->getMock();
  522. $response = $this->getMockBuilder('Cake\Http\Response')->getMock();
  523. $View = new TestView(null, null, null, $viewOptions);
  524. $expected = TEST_APP . 'TestApp' . DS . 'Template' . DS . 'Pages' . DS . 'home.ctp';
  525. $result = $View->getViewFileName('home');
  526. $this->assertPathEquals($expected, $result);
  527. $expected = TEST_APP . 'TestApp' . DS . 'Template' . DS . 'Posts' . DS . 'index.ctp';
  528. $result = $View->getViewFileName('/Posts/index');
  529. $this->assertPathEquals($expected, $result);
  530. $expected = TEST_APP . 'TestApp' . DS . 'Template' . DS . 'Posts' . DS . 'index.ctp';
  531. $result = $View->getViewFileName('../Posts/index');
  532. $this->assertPathEquals($expected, $result);
  533. $expected = TEST_APP . 'TestApp' . DS . 'Template' . DS . 'Pages' . DS . 'page.home.ctp';
  534. $result = $View->getViewFileName('page.home');
  535. $this->assertPathEquals($expected, $result, 'Should not ruin files with dots.');
  536. Plugin::load('TestPlugin');
  537. $expected = TEST_APP . 'TestApp' . DS . 'Template' . DS . 'Pages' . DS . 'home.ctp';
  538. $result = $View->getViewFileName('TestPlugin.home');
  539. $this->assertPathEquals($expected, $result, 'Plugin is missing the view, cascade to app.');
  540. $View->setTemplatePath('Tests');
  541. $expected = TEST_APP . 'Plugin' . DS . 'TestPlugin' . DS . 'src' . DS .
  542. 'Template' . DS . 'Tests' . DS . 'index.ctp';
  543. $result = $View->getViewFileName('TestPlugin.index');
  544. $this->assertPathEquals($expected, $result);
  545. }
  546. /**
  547. * Test that getViewFileName() protects against malicious directory traversal.
  548. *
  549. * @return void
  550. */
  551. public function testGetViewFileNameDirectoryTraversal()
  552. {
  553. $this->expectException(\InvalidArgumentException::class);
  554. $viewOptions = [
  555. 'plugin' => null,
  556. 'name' => 'Pages',
  557. 'viewPath' => 'Pages',
  558. ];
  559. $request = $this->getMockBuilder('Cake\Http\ServerRequest')->getMock();
  560. $response = $this->getMockBuilder('Cake\Http\Response')->getMock();
  561. $view = new TestView(null, null, null, $viewOptions);
  562. $view->ext('.php');
  563. $view->getViewFileName('../../../../bootstrap');
  564. }
  565. /**
  566. * Test getViewFileName doesn't re-apply existing subdirectories
  567. *
  568. * @return void
  569. */
  570. public function testGetViewFileNameSubDir()
  571. {
  572. $viewOptions = [
  573. 'plugin' => null,
  574. 'name' => 'Posts',
  575. 'viewPath' => 'Posts/json',
  576. 'layoutPath' => 'json',
  577. ];
  578. $view = new TestView(null, null, null, $viewOptions);
  579. $expected = TEST_APP . 'TestApp' . DS . 'Template' . DS . 'Posts' . DS . 'json' . DS . 'index.ctp';
  580. $result = $view->getViewFileName('index');
  581. $this->assertPathEquals($expected, $result);
  582. $view->setSubDir('json');
  583. $result = $view->getViewFileName('index');
  584. $expected = TEST_APP . 'TestApp' . DS . 'Template' . DS . 'Posts' . DS . 'json' . DS . 'index.ctp';
  585. $this->assertPathEquals($expected, $result);
  586. }
  587. /**
  588. * Test getViewFileName applies subdirectories on equal length names
  589. *
  590. * @return void
  591. */
  592. public function testGetViewFileNameSubDirLength()
  593. {
  594. $viewOptions = [
  595. 'plugin' => null,
  596. 'name' => 'Jobs',
  597. 'viewPath' => 'Jobs',
  598. 'layoutPath' => 'json',
  599. ];
  600. $view = new TestView(null, null, null, $viewOptions);
  601. $view->setSubDir('json');
  602. $result = $view->getViewFileName('index');
  603. $expected = TEST_APP . 'TestApp' . DS . 'Template' . DS . 'Jobs' . DS . 'json' . DS . 'index.ctp';
  604. $this->assertPathEquals($expected, $result);
  605. }
  606. /**
  607. * Test getting layout filenames
  608. *
  609. * @return void
  610. */
  611. public function testGetLayoutFileName()
  612. {
  613. $viewOptions = ['plugin' => null,
  614. 'name' => 'Pages',
  615. 'viewPath' => 'Pages',
  616. 'action' => 'display'
  617. ];
  618. $View = new TestView(null, null, null, $viewOptions);
  619. $expected = TEST_APP . 'TestApp' . DS . 'Template' . DS . 'Layout' . DS . 'default.ctp';
  620. $result = $View->getLayoutFileName();
  621. $this->assertPathEquals($expected, $result);
  622. $View->setLayoutPath('rss');
  623. $expected = TEST_APP . 'TestApp' . DS . 'Template' . DS . 'Layout' . DS . 'rss' . DS . 'default.ctp';
  624. $result = $View->getLayoutFileName();
  625. $this->assertPathEquals($expected, $result);
  626. $View->setLayoutPath('Email' . DS . 'html');
  627. $expected = TEST_APP . 'TestApp' . DS . 'Template' . DS . 'Layout' . DS . 'Email' . DS . 'html' . DS . 'default.ctp';
  628. $result = $View->getLayoutFileName();
  629. $this->assertPathEquals($expected, $result);
  630. }
  631. /**
  632. * Test getting layout filenames for plugins.
  633. *
  634. * @return void
  635. */
  636. public function testGetLayoutFileNamePlugin()
  637. {
  638. $viewOptions = ['plugin' => null,
  639. 'name' => 'Pages',
  640. 'viewPath' => 'Pages',
  641. 'action' => 'display'
  642. ];
  643. $View = new TestView(null, null, null, $viewOptions);
  644. Plugin::load('TestPlugin');
  645. $expected = TEST_APP . 'Plugin' . DS . 'TestPlugin' . DS . 'src' . DS .
  646. 'Template' . DS . 'Layout' . DS . 'default.ctp';
  647. $result = $View->getLayoutFileName('TestPlugin.default');
  648. $this->assertPathEquals($expected, $result);
  649. $View->setRequest($View->getRequest()->withParam('plugin', 'TestPlugin'));
  650. $expected = TEST_APP . 'Plugin' . DS . 'TestPlugin' . DS . 'src' . DS .
  651. 'Template' . DS . 'Layout' . DS . 'default.ctp';
  652. $result = $View->getLayoutFileName('default');
  653. $this->assertPathEquals($expected, $result);
  654. }
  655. /**
  656. * Test getting layout filenames for prefix
  657. *
  658. * @return void
  659. */
  660. public function testGetLayoutFileNamePrefix()
  661. {
  662. $View = new TestView();
  663. // Prefix specific layout
  664. $View->setRequest($View->getRequest()->withParam('prefix', 'foo_prefix'));
  665. $expected = TEST_APP . 'TestApp' . DS . 'Template' . DS .
  666. 'FooPrefix' . DS . 'Layout' . DS . 'default.ctp';
  667. $result = $View->getLayoutFileName();
  668. $this->assertPathEquals($expected, $result);
  669. $View->setRequest($View->getRequest()->withParam('prefix', 'FooPrefix'));
  670. $result = $View->getLayoutFileName();
  671. $this->assertPathEquals($expected, $result);
  672. // Nested prefix layout
  673. $View->setRequest($View->getRequest()->withParam('prefix', 'foo_prefix/bar_prefix'));
  674. $expected = TEST_APP . 'TestApp' . DS . 'Template' . DS .
  675. 'FooPrefix' . DS . 'BarPrefix' . DS . 'Layout' . DS . 'default.ctp';
  676. $result = $View->getLayoutFileName();
  677. $this->assertPathEquals($expected, $result);
  678. $expected = TEST_APP . 'TestApp' . DS . 'Template' . DS .
  679. 'FooPrefix' . DS . 'Layout' . DS . 'nested_prefix_cascade.ctp';
  680. $result = $View->getLayoutFileName('nested_prefix_cascade');
  681. $this->assertPathEquals($expected, $result);
  682. // Fallback to app's layout
  683. $View->setRequest($View->getRequest()->withParam('prefix', 'Admin'));
  684. $expected = TEST_APP . 'TestApp' . DS . 'Template' . DS .
  685. 'Layout' . DS . 'default.ctp';
  686. $result = $View->getLayoutFileName();
  687. $this->assertPathEquals($expected, $result);
  688. }
  689. /**
  690. * Test that getLayoutFileName() protects against malicious directory traversal.
  691. *
  692. * @return void
  693. */
  694. public function testGetLayoutFileNameDirectoryTraversal()
  695. {
  696. $this->expectException(\InvalidArgumentException::class);
  697. $viewOptions = [
  698. 'plugin' => null,
  699. 'name' => 'Pages',
  700. 'viewPath' => 'Pages',
  701. ];
  702. $request = $this->getMockBuilder('Cake\Http\ServerRequest')->getMock();
  703. $response = $this->getMockBuilder('Cake\Http\Response')->getMock();
  704. $view = new TestView(null, null, null, $viewOptions);
  705. $view->ext('.php');
  706. $view->getLayoutFileName('../../../../bootstrap');
  707. }
  708. /**
  709. * Test for missing views
  710. *
  711. * @return void
  712. */
  713. public function testMissingTemplate()
  714. {
  715. $this->expectException(\Cake\View\Exception\MissingTemplateException::class);
  716. $viewOptions = ['plugin' => null,
  717. 'name' => 'Pages',
  718. 'viewPath' => 'Pages'
  719. ];
  720. $request = $this->getMockBuilder('Cake\Http\ServerRequest')->getMock();
  721. $response = $this->getMockBuilder('Cake\Http\Response')->getMock();
  722. $View = new TestView($request, $response, null, $viewOptions);
  723. $View->getViewFileName('does_not_exist');
  724. }
  725. /**
  726. * Test for missing layouts
  727. *
  728. * @return void
  729. */
  730. public function testMissingLayout()
  731. {
  732. $this->expectException(\Cake\View\Exception\MissingLayoutException::class);
  733. $viewOptions = ['plugin' => null,
  734. 'name' => 'Pages',
  735. 'viewPath' => 'Pages',
  736. 'layout' => 'whatever'
  737. ];
  738. $View = new TestView(null, null, null, $viewOptions);
  739. $View->getLayoutFileName();
  740. }
  741. /**
  742. * Test viewVars method
  743. *
  744. * @return void
  745. */
  746. public function testViewVars()
  747. {
  748. $this->assertEquals(['testData' => 'Some test data', 'test2' => 'more data', 'test3' => 'even more data'], $this->View->viewVars);
  749. }
  750. /**
  751. * Test generation of UUIDs method
  752. *
  753. * @return void
  754. */
  755. public function testUUIDGeneration()
  756. {
  757. $this->deprecated(function () {
  758. Router::connect('/:controller', ['action' => 'index']);
  759. $result = $this->View->uuid('form', ['controller' => 'posts', 'action' => 'index']);
  760. $this->assertEquals('form5988016017', $result);
  761. $result = $this->View->uuid('form', ['controller' => 'posts', 'action' => 'index']);
  762. $this->assertEquals('formc3dc6be854', $result);
  763. $result = $this->View->uuid('form', ['controller' => 'posts', 'action' => 'index']);
  764. $this->assertEquals('form28f92cc87f', $result);
  765. });
  766. }
  767. /**
  768. * Test elementExists method
  769. *
  770. * @return void
  771. */
  772. public function testElementExists()
  773. {
  774. $result = $this->View->elementExists('test_element');
  775. $this->assertTrue($result);
  776. $result = $this->View->elementExists('TestPlugin.plugin_element');
  777. $this->assertTrue($result);
  778. $result = $this->View->elementExists('non_existent_element');
  779. $this->assertFalse($result);
  780. $result = $this->View->elementExists('TestPlugin.element');
  781. $this->assertFalse($result);
  782. $this->View->setRequest($this->View->getRequest()->withParam('plugin', 'TestPlugin'));
  783. $result = $this->View->elementExists('plugin_element');
  784. $this->assertTrue($result);
  785. }
  786. /**
  787. * Test element method
  788. *
  789. * @return void
  790. */
  791. public function testElement()
  792. {
  793. $result = $this->View->element('test_element');
  794. $this->assertEquals('this is the test element', $result);
  795. $result = $this->View->element('TestPlugin.plugin_element');
  796. $this->assertEquals("Element in the TestPlugin\n", $result);
  797. $this->View->setRequest($this->View->getRequest()->withParam('plugin', 'TestPlugin'));
  798. $result = $this->View->element('plugin_element');
  799. $this->assertEquals("Element in the TestPlugin\n", $result);
  800. $result = $this->View->element('plugin_element', [], ['plugin' => false]);
  801. $this->assertEquals("Plugin element overridden in app\n", $result);
  802. }
  803. /**
  804. * Test element method with a prefix
  805. *
  806. * @return void
  807. */
  808. public function testPrefixElement()
  809. {
  810. $this->View->setRequest($this->View->getRequest()->withParam('prefix', 'Admin'));
  811. $result = $this->View->element('prefix_element');
  812. $this->assertEquals('this is a prefixed test element', $result);
  813. $result = $this->View->element('TestPlugin.plugin_element');
  814. $this->assertEquals('this is the plugin prefixed element using params[plugin]', $result);
  815. $this->View->setRequest($this->View->getRequest()->withParam('plugin', 'TestPlugin'));
  816. $result = $this->View->element('test_plugin_element');
  817. $this->assertEquals('this is the test set using View::$plugin plugin prefixed element', $result);
  818. $this->View->setRequest($this->View->getRequest()->withParam('prefix', 'FooPrefix/BarPrefix'));
  819. $result = $this->View->element('prefix_element');
  820. $this->assertEquals('this is a nested prefixed test element', $result);
  821. $result = $this->View->element('prefix_element_in_parent');
  822. $this->assertEquals('this is a nested prefixed test element in first level element', $result);
  823. }
  824. /**
  825. * Test loading non-existent view element
  826. *
  827. * @return void
  828. */
  829. public function testElementNonExistent()
  830. {
  831. $this->expectException(\Cake\View\Exception\MissingElementException::class);
  832. $this->expectExceptionMessageRegExp('#^Element file "Element[\\\\/]non_existent_element\.ctp" is missing\.$#');
  833. $this->View->element('non_existent_element');
  834. }
  835. /**
  836. * Test loading non-existent plugin view element
  837. *
  838. * @return void
  839. */
  840. public function testElementInexistentPluginElement()
  841. {
  842. $this->expectException(\Cake\View\Exception\MissingElementException::class);
  843. $this->expectExceptionMessageRegExp('#^Element file "test_plugin\.Element[\\\\/]plugin_element\.ctp" is missing\.$#');
  844. $this->View->element('test_plugin.plugin_element');
  845. }
  846. /**
  847. * Test that elements can have callbacks
  848. *
  849. * @return void
  850. */
  851. public function testElementCallbacks()
  852. {
  853. $count = 0;
  854. $callback = function (Event $event, $file) use (&$count) {
  855. $count++;
  856. };
  857. $events = $this->View->getEventManager();
  858. $events->on('View.beforeRender', $callback);
  859. $events->on('View.afterRender', $callback);
  860. $this->View->element('test_element', [], ['callbacks' => true]);
  861. $this->assertEquals(2, $count);
  862. }
  863. /**
  864. * Test that additional element viewVars don't get overwritten with helpers.
  865. *
  866. * @return void
  867. */
  868. public function testElementParamsDontOverwriteHelpers()
  869. {
  870. $Controller = new ViewPostsController();
  871. $Controller->helpers = ['Form'];
  872. $View = $Controller->createView();
  873. $result = $View->element('type_check', ['form' => 'string'], ['callbacks' => true]);
  874. $this->assertEquals('string', $result);
  875. $View->set('form', 'string');
  876. $result = $View->element('type_check', [], ['callbacks' => true]);
  877. $this->assertEquals('string', $result);
  878. }
  879. /**
  880. * Test elementCacheHelperNoCache method
  881. *
  882. * @return void
  883. */
  884. public function testElementCacheHelperNoCache()
  885. {
  886. $Controller = new ViewPostsController();
  887. $View = $Controller->createView();
  888. $result = $View->element('test_element', ['ram' => 'val', 'test' => ['foo', 'bar']]);
  889. $this->assertEquals('this is the test element', $result);
  890. }
  891. /**
  892. * Test elementCache method
  893. *
  894. * @return void
  895. */
  896. public function testElementCache()
  897. {
  898. Cache::drop('test_view');
  899. Cache::setConfig('test_view', [
  900. 'engine' => 'File',
  901. 'duration' => '+1 day',
  902. 'path' => CACHE . 'views/',
  903. 'prefix' => ''
  904. ]);
  905. Cache::clear(false, 'test_view');
  906. $View = $this->PostsController->createView();
  907. $View->setElementCache('test_view');
  908. $result = $View->element('test_element', [], ['cache' => true]);
  909. $expected = 'this is the test element';
  910. $this->assertEquals($expected, $result);
  911. $result = Cache::read('element__test_element', 'test_view');
  912. $this->assertEquals($expected, $result);
  913. $result = $View->element('test_element', ['param' => 'one', 'foo' => 'two'], ['cache' => true]);
  914. $this->assertEquals($expected, $result);
  915. $result = Cache::read('element__test_element_param_foo', 'test_view');
  916. $this->assertEquals($expected, $result);
  917. $View->element('test_element', [
  918. 'param' => 'one',
  919. 'foo' => 'two'
  920. ], [
  921. 'cache' => ['key' => 'custom_key']
  922. ]);
  923. $result = Cache::read('element_custom_key', 'test_view');
  924. $this->assertEquals($expected, $result);
  925. $View->setElementCache('default');
  926. $View->element('test_element', [
  927. 'param' => 'one',
  928. 'foo' => 'two'
  929. ], [
  930. 'cache' => ['config' => 'test_view'],
  931. ]);
  932. $result = Cache::read('element__test_element_param_foo', 'test_view');
  933. $this->assertEquals($expected, $result);
  934. Cache::clear(true, 'test_view');
  935. Cache::drop('test_view');
  936. }
  937. /**
  938. * Test element events
  939. *
  940. * @return void
  941. */
  942. public function testViewEvent()
  943. {
  944. $View = $this->PostsController->createView();
  945. $View->setTemplatePath($this->PostsController->getName());
  946. $View->enableAutoLayout(false);
  947. $listener = new TestViewEventListenerInterface();
  948. $View->getEventManager()->on($listener);
  949. $View->render('index');
  950. $this->assertEquals(View::TYPE_VIEW, $listener->beforeRenderViewType);
  951. $this->assertEquals(View::TYPE_VIEW, $listener->afterRenderViewType);
  952. $this->assertEquals($View->getCurrentType(), View::TYPE_VIEW);
  953. $View->element('test_element', [], ['callbacks' => true]);
  954. $this->assertEquals($View->getCurrentType(), View::TYPE_VIEW);
  955. $this->assertEquals(View::TYPE_ELEMENT, $listener->beforeRenderViewType);
  956. $this->assertEquals(View::TYPE_ELEMENT, $listener->afterRenderViewType);
  957. }
  958. /**
  959. * Test loading helper using loadHelper().
  960. *
  961. * @return void
  962. */
  963. public function testLoadHelper()
  964. {
  965. $View = new View();
  966. $View->loadHelper('Html', ['foo' => 'bar']);
  967. $this->assertInstanceOf('Cake\View\Helper\HtmlHelper', $View->Html);
  968. $config = $View->Html->getConfig();
  969. $this->assertEquals('bar', $config['foo']);
  970. }
  971. /**
  972. * Test loading helper when duplicate.
  973. *
  974. * @return void
  975. */
  976. public function testLoadHelperDuplicate()
  977. {
  978. $View = new View();
  979. $this->assertNotEmpty($View->loadHelper('Html', ['foo' => 'bar']));
  980. try {
  981. $View->loadHelper('Html', ['test' => 'value']);
  982. $this->fail('No exception');
  983. } catch (\RuntimeException $e) {
  984. $this->assertContains('The "Html" alias has already been loaded', $e->getMessage());
  985. }
  986. }
  987. /**
  988. * Test loadHelpers method
  989. *
  990. * @return void
  991. */
  992. public function testLoadHelpers()
  993. {
  994. $View = new View(null, null, null, [
  995. 'helpers' => ['Html' => ['foo' => 'bar'], 'Form' => ['foo' => 'baz']]
  996. ]);
  997. $result = $View->loadHelpers();
  998. $this->assertSame($View, $result);
  999. $this->assertInstanceOf('Cake\View\Helper\HtmlHelper', $View->Html, 'Object type is wrong.');
  1000. $this->assertInstanceOf('Cake\View\Helper\FormHelper', $View->Form, 'Object type is wrong.');
  1001. $config = $View->Html->getConfig();
  1002. $this->assertEquals('bar', $config['foo']);
  1003. $config = $View->Form->getConfig();
  1004. $this->assertEquals('baz', $config['foo']);
  1005. }
  1006. /**
  1007. * Test lazy loading helpers
  1008. *
  1009. * @return void
  1010. */
  1011. public function testLazyLoadHelpers()
  1012. {
  1013. $View = new View();
  1014. $this->assertInstanceOf('Cake\View\Helper\HtmlHelper', $View->Html, 'Object type is wrong.');
  1015. $this->assertInstanceOf('Cake\View\Helper\FormHelper', $View->Form, 'Object type is wrong.');
  1016. }
  1017. /**
  1018. * Test manipulating class properties in initialize()
  1019. *
  1020. * @return void
  1021. */
  1022. public function testInitialize()
  1023. {
  1024. $View = new TestView();
  1025. $config = $View->Html->getConfig();
  1026. $this->assertEquals('myval', $config['mykey']);
  1027. }
  1028. /**
  1029. * Test the correct triggering of helper callbacks
  1030. *
  1031. * @return void
  1032. */
  1033. public function testHelperCallbackTriggering()
  1034. {
  1035. $View = $this->PostsController->createView();
  1036. $View->setTemplatePath($this->PostsController->getName());
  1037. $manager = $this->getMockBuilder('Cake\Event\EventManager')->getMock();
  1038. $View->setEventManager($manager);
  1039. $manager->expects($this->at(0))->method('dispatch')
  1040. ->with(
  1041. $this->logicalAnd(
  1042. $this->isInstanceOf('Cake\Event\Event'),
  1043. $this->attributeEqualTo('_name', 'View.beforeRender'),
  1044. $this->attributeEqualTo('_subject', $View)
  1045. )
  1046. );
  1047. $manager->expects($this->at(1))->method('dispatch')
  1048. ->with(
  1049. $this->logicalAnd(
  1050. $this->isInstanceOf('Cake\Event\Event'),
  1051. $this->attributeEqualTo('_name', 'View.beforeRenderFile'),
  1052. $this->attributeEqualTo('_subject', $View)
  1053. )
  1054. );
  1055. $manager->expects($this->at(2))->method('dispatch')
  1056. ->with(
  1057. $this->logicalAnd(
  1058. $this->isInstanceOf('Cake\Event\Event'),
  1059. $this->attributeEqualTo('_name', 'View.afterRenderFile'),
  1060. $this->attributeEqualTo('_subject', $View)
  1061. )
  1062. );
  1063. $manager->expects($this->at(3))->method('dispatch')
  1064. ->with(
  1065. $this->logicalAnd(
  1066. $this->isInstanceOf('Cake\Event\Event'),
  1067. $this->attributeEqualTo('_name', 'View.afterRender'),
  1068. $this->attributeEqualTo('_subject', $View)
  1069. )
  1070. );
  1071. $manager->expects($this->at(4))->method('dispatch')
  1072. ->with(
  1073. $this->logicalAnd(
  1074. $this->isInstanceOf('Cake\Event\Event'),
  1075. $this->attributeEqualTo('_name', 'View.beforeLayout'),
  1076. $this->attributeEqualTo('_subject', $View)
  1077. )
  1078. );
  1079. $manager->expects($this->at(5))->method('dispatch')
  1080. ->with(
  1081. $this->logicalAnd(
  1082. $this->isInstanceOf('Cake\Event\Event'),
  1083. $this->attributeEqualTo('_name', 'View.beforeRenderFile'),
  1084. $this->attributeEqualTo('_subject', $View)
  1085. )
  1086. );
  1087. $manager->expects($this->at(6))->method('dispatch')
  1088. ->with(
  1089. $this->logicalAnd(
  1090. $this->isInstanceOf('Cake\Event\Event'),
  1091. $this->attributeEqualTo('_name', 'View.afterRenderFile'),
  1092. $this->attributeEqualTo('_subject', $View)
  1093. )
  1094. );
  1095. $manager->expects($this->at(7))->method('dispatch')
  1096. ->with(
  1097. $this->logicalAnd(
  1098. $this->isInstanceOf('Cake\Event\Event'),
  1099. $this->attributeEqualTo('_name', 'View.afterLayout'),
  1100. $this->attributeEqualTo('_subject', $View)
  1101. )
  1102. );
  1103. $View->render('index');
  1104. }
  1105. /**
  1106. * Test beforeLayout method
  1107. *
  1108. * @return void
  1109. */
  1110. public function testBeforeLayout()
  1111. {
  1112. $this->PostsController->helpers = [
  1113. 'TestBeforeAfter' => ['className' => __NAMESPACE__ . '\TestBeforeAfterHelper'],
  1114. 'Html'
  1115. ];
  1116. $View = $this->PostsController->createView();
  1117. $View->setTemplatePath($this->PostsController->getName());
  1118. $View->render('index');
  1119. $this->assertEquals('Valuation', $View->helpers()->TestBeforeAfter->property);
  1120. }
  1121. /**
  1122. * Test afterLayout method
  1123. *
  1124. * @return void
  1125. */
  1126. public function testAfterLayout()
  1127. {
  1128. $this->PostsController->helpers = [
  1129. 'TestBeforeAfter' => ['className' => __NAMESPACE__ . '\TestBeforeAfterHelper'],
  1130. 'Html'
  1131. ];
  1132. $this->PostsController->set('variable', 'values');
  1133. $View = $this->PostsController->createView();
  1134. $View->setTemplatePath($this->PostsController->getName());
  1135. $content = 'This is my view output';
  1136. $result = $View->renderLayout($content, 'default');
  1137. $this->assertRegExp('/modified in the afterlife/', $result);
  1138. $this->assertRegExp('/This is my view output/', $result);
  1139. }
  1140. /**
  1141. * Test renderLoadHelper method
  1142. *
  1143. * @return void
  1144. */
  1145. public function testRenderLoadHelper()
  1146. {
  1147. $this->PostsController->helpers = ['Form', 'Number'];
  1148. $View = $this->PostsController->createView('Cake\Test\TestCase\View\TestView');
  1149. $View->setTemplatePath($this->PostsController->getName());
  1150. $result = $View->render('index', false);
  1151. $this->assertEquals('posts index', $result);
  1152. $attached = $View->helpers()->loaded();
  1153. // HtmlHelper is loaded in TestView::initialize()
  1154. $this->assertEquals(['Html', 'Form', 'Number'], $attached);
  1155. $this->PostsController->helpers = ['Html', 'Form', 'Number', 'TestPlugin.PluggedHelper'];
  1156. $View = $this->PostsController->createView('Cake\Test\TestCase\View\TestView');
  1157. $View->setTemplatePath($this->PostsController->getName());
  1158. $result = $View->render('index', false);
  1159. $this->assertEquals('posts index', $result);
  1160. $attached = $View->helpers()->loaded();
  1161. $expected = ['Html', 'Form', 'Number', 'PluggedHelper'];
  1162. $this->assertEquals($expected, $attached, 'Attached helpers are wrong.');
  1163. }
  1164. /**
  1165. * Test render method
  1166. *
  1167. * @return void
  1168. */
  1169. public function testRender()
  1170. {
  1171. $View = $this->PostsController->createView('Cake\Test\TestCase\View\TestView');
  1172. $View->setTemplatePath($this->PostsController->getName());
  1173. $result = $View->render('index');
  1174. $this->assertRegExp("/<meta charset=\"utf-8\"\/>\s*<title>/", $result);
  1175. $this->assertRegExp("/<div id=\"content\">\s*posts index\s*<\/div>/", $result);
  1176. $this->assertRegExp("/<div id=\"content\">\s*posts index\s*<\/div>/", $result);
  1177. $View = $this->PostsController->createView('Cake\Test\TestCase\View\TestView');
  1178. $result = $View->render(false, 'ajax2');
  1179. $this->assertRegExp('/Ajax\!/', $result);
  1180. $this->assertNull($View->render(false, 'ajax2'));
  1181. $this->PostsController->helpers = ['Html'];
  1182. $this->PostsController->setRequest($this->PostsController->getRequest()->withParam('action', 'index'));
  1183. Configure::write('Cache.check', true);
  1184. $View = $this->PostsController->createView('Cake\Test\TestCase\View\TestView');
  1185. $View->setTemplatePath($this->PostsController->getName());
  1186. $result = $View->render('index');
  1187. $this->assertRegExp("/<meta charset=\"utf-8\"\/>\s*<title>/", $result);
  1188. $this->assertRegExp("/<div id=\"content\">\s*posts index\s*<\/div>/", $result);
  1189. }
  1190. /**
  1191. * Test that View::$view works
  1192. *
  1193. * @return void
  1194. */
  1195. public function testRenderUsingViewProperty()
  1196. {
  1197. $View = $this->PostsController->createView('Cake\Test\TestCase\View\TestView');
  1198. $View->setTemplatePath($this->PostsController->getName());
  1199. $View->setTemplate('cache_form');
  1200. $this->assertEquals('cache_form', $View->getTemplate());
  1201. $result = $View->render();
  1202. $this->assertRegExp('/Add User/', $result);
  1203. }
  1204. /**
  1205. * Test that layout set from view file takes precedence over layout set
  1206. * as argument to render().
  1207. *
  1208. * @return void
  1209. */
  1210. public function testRenderUsingLayoutArgument()
  1211. {
  1212. $error = new \PDOException();
  1213. $error->queryString = 'this is sql string';
  1214. $message = 'it works';
  1215. $View = $this->PostsController->createView('Cake\Test\TestCase\View\TestView');
  1216. $View->set(compact('error', 'message'));
  1217. $View->setTemplatePath('Error');
  1218. $result = $View->render('pdo_error', 'error');
  1219. $this->assertRegExp('/this is sql string/', $result);
  1220. $this->assertRegExp('/it works/', $result);
  1221. }
  1222. /**
  1223. * Test render()ing a file in a subdir from a custom viewPath
  1224. * in a plugin.
  1225. *
  1226. * @return void
  1227. */
  1228. public function testGetViewFileNameSubdirWithPluginAndViewPath()
  1229. {
  1230. $this->PostsController->setPlugin('TestPlugin');
  1231. $this->PostsController->setName('Posts');
  1232. $View = $this->PostsController->createView('Cake\Test\TestCase\View\TestView');
  1233. $View->setTemplatePath('Element');
  1234. $pluginPath = TEST_APP . 'Plugin' . DS . 'TestPlugin' . DS;
  1235. $result = $View->getViewFileName('sub_dir/sub_element');
  1236. $expected = $pluginPath . 'src' . DS . 'Template' . DS . 'Element' . DS . 'sub_dir' . DS . 'sub_element.ctp';
  1237. $this->assertPathEquals($expected, $result);
  1238. }
  1239. /**
  1240. * Test that view vars can replace the local helper variables
  1241. * and not overwrite the $this->Helper references
  1242. *
  1243. * @return void
  1244. */
  1245. public function testViewVarOverwritingLocalHelperVar()
  1246. {
  1247. $Controller = new ViewPostsController();
  1248. $Controller->helpers = ['Html'];
  1249. $Controller->set('html', 'I am some test html');
  1250. $View = $Controller->createView();
  1251. $View->setTemplatePath($Controller->getName());
  1252. $result = $View->render('helper_overwrite', false);
  1253. $this->assertRegExp('/I am some test html/', $result);
  1254. $this->assertRegExp('/Test link/', $result);
  1255. }
  1256. /**
  1257. * Test getViewFileName method
  1258. *
  1259. * @return void
  1260. */
  1261. public function testViewFileName()
  1262. {
  1263. $View = $this->PostsController->createView('Cake\Test\TestCase\View\TestView');
  1264. $View->setTemplatePath('Posts');
  1265. $result = $View->getViewFileName('index');
  1266. $this->assertRegExp('/Posts(\/|\\\)index.ctp/', $result);
  1267. $result = $View->getViewFileName('TestPlugin.index');
  1268. $this->assertRegExp('/Posts(\/|\\\)index.ctp/', $result);
  1269. $result = $View->getViewFileName('/Pages/home');
  1270. $this->assertRegExp('/Pages(\/|\\\)home.ctp/', $result);
  1271. $result = $View->getViewFileName('../Element/test_element');
  1272. $this->assertRegExp('/Element(\/|\\\)test_element.ctp/', $result);
  1273. $expected = TEST_APP . 'TestApp' . DS . 'Template' . DS . 'Posts' . DS . 'index.ctp';
  1274. $result = $View->getViewFileName('../Posts/index');
  1275. $this->assertPathEquals($expected, $result);
  1276. }
  1277. /**
  1278. * Test creating a block with capturing output.
  1279. *
  1280. * @return void
  1281. */
  1282. public function testBlockCaptureOverwrite()
  1283. {
  1284. $result = $this->View->start('test');
  1285. $this->assertSame($this->View, $result);
  1286. echo 'Block content';
  1287. $result = $this->View->end();
  1288. $this->assertSame($this->View, $result);
  1289. $this->View->start('test');
  1290. echo 'New content';
  1291. $this->View->end();
  1292. $result = $this->View->fetch('test');
  1293. $this->assertEquals('New content', $result);
  1294. }
  1295. /**
  1296. * Test that blocks can be fetched inside a block with the same name
  1297. *
  1298. * @return void
  1299. */
  1300. public function testBlockExtend()
  1301. {
  1302. $this->View->start('test');
  1303. echo 'Block content';
  1304. $this->View->end();
  1305. $this->View->start('test');
  1306. echo $this->View->fetch('test');
  1307. echo 'New content';
  1308. $this->View->end();
  1309. $result = $this->View->fetch('test');
  1310. $this->assertEquals('Block contentNew content', $result);
  1311. }
  1312. /**
  1313. * Test creating a block with capturing output.
  1314. *
  1315. * @return void
  1316. */
  1317. public function testBlockCapture()
  1318. {
  1319. $this->View->start('test');
  1320. echo 'Block content';
  1321. $this->View->end();
  1322. $result = $this->View->fetch('test');
  1323. $this->assertEquals('Block content', $result);
  1324. }
  1325. /**
  1326. * Test appending to a block with capturing output.
  1327. *
  1328. * @return void
  1329. */
  1330. public function testBlockAppendCapture()
  1331. {
  1332. $this->View->start('test');
  1333. echo 'Content ';
  1334. $this->View->end();
  1335. $result = $this->View->append('test');
  1336. $this->assertSame($this->View, $result);
  1337. echo 'appended';
  1338. $this->View->end();
  1339. $result = $this->View->fetch('test');
  1340. $this->assertEquals('Content appended', $result);
  1341. }
  1342. /**
  1343. * Test setting a block's content.
  1344. *
  1345. * @return void
  1346. */
  1347. public function testBlockSet()
  1348. {
  1349. $result = $this->View->assign('test', 'Block content');
  1350. $this->assertSame($this->View, $result);
  1351. $result = $this->View->fetch('test');
  1352. $this->assertEquals('Block content', $result);
  1353. }
  1354. /**
  1355. * Test resetting a block's content.
  1356. *
  1357. * @return void
  1358. */
  1359. public function testBlockReset()
  1360. {
  1361. $this->View->assign('test', '');
  1362. $result = $this->View->fetch('test', 'This should not be returned');
  1363. $this->assertSame('', $result);
  1364. }
  1365. /**
  1366. * Test resetting a block's content with reset.
  1367. *
  1368. * @return void
  1369. */
  1370. public function testBlockResetFunc()
  1371. {
  1372. $this->View->assign('test', 'Block content');
  1373. $result = $this->View->fetch('test', 'This should not be returned');
  1374. $this->assertSame('Block content', $result);
  1375. $result = $this->View->reset('test');
  1376. $this->assertSame($this->View, $result);
  1377. $result = $this->View->fetch('test', 'This should not be returned');
  1378. $this->assertSame('', $result);
  1379. }
  1380. /**
  1381. * Test checking a block's existence.
  1382. *
  1383. * @return void
  1384. */
  1385. public function testBlockExist()
  1386. {
  1387. $this->assertFalse($this->View->exists('test'));
  1388. $this->View->assign('test', 'Block content');
  1389. $this->assertTrue($this->View->exists('test'));
  1390. }
  1391. /**
  1392. * Test setting a block's content to null
  1393. *
  1394. * @return void
  1395. */
  1396. public function testBlockSetNull()
  1397. {
  1398. $this->View->assign('testWithNull', null);
  1399. $result = $this->View->fetch('testWithNull');
  1400. $this->assertSame('', $result);
  1401. }
  1402. /**
  1403. * Test setting a block's content to an object with __toString magic method
  1404. *
  1405. * @return void
  1406. */
  1407. public function testBlockSetObjectWithToString()
  1408. {
  1409. $objectWithToString = new TestObjectWithToString();
  1410. $this->View->assign('testWithObjectWithToString', $objectWithToString);
  1411. $result = $this->View->fetch('testWithObjectWithToString');
  1412. $this->assertSame("I'm ObjectWithToString", $result);
  1413. }
  1414. /**
  1415. * Test setting a block's content to an object without __toString magic method
  1416. *
  1417. * This should produce a "Object of class TestObjectWithoutToString could not be converted to string" error
  1418. * which gets thrown as a \PHPUnit\Framework\Error\Error Exception by PHPUnit.
  1419. *
  1420. * @return void
  1421. */
  1422. public function testBlockSetObjectWithoutToString()
  1423. {
  1424. $this->expectException(\PHPUnit\Framework\Error\Error::class);
  1425. $objectWithToString = new TestObjectWithoutToString();
  1426. $this->View->assign('testWithObjectWithoutToString', $objectWithToString);
  1427. }
  1428. /**
  1429. * Test setting a block's content to a decimal
  1430. *
  1431. * @return void
  1432. */
  1433. public function testBlockSetDecimal()
  1434. {
  1435. $this->View->assign('testWithDecimal', 1.23456789);
  1436. $result = $this->View->fetch('testWithDecimal');
  1437. $this->assertEquals('1.23456789', $result);
  1438. }
  1439. /**
  1440. * Data provider for block related tests.
  1441. *
  1442. * @return array
  1443. */
  1444. public static function blockValueProvider()
  1445. {
  1446. return [
  1447. 'string' => ['A string value'],
  1448. 'decimal' => [1.23456],
  1449. 'object with __toString' => [new TestObjectWithToString()],
  1450. ];
  1451. }
  1452. /**
  1453. * Test appending to a block with append.
  1454. *
  1455. * @param mixed $value Value
  1456. * @return void
  1457. * @dataProvider blockValueProvider
  1458. */
  1459. public function testBlockAppend($value)
  1460. {
  1461. $this->View->assign('testBlock', 'Block');
  1462. $this->View->append('testBlock', $value);
  1463. $result = $this->View->fetch('testBlock');
  1464. $this->assertSame('Block' . $value, $result);
  1465. }
  1466. /**
  1467. * Test appending an object without __toString magic method to a block with append.
  1468. *
  1469. * This should produce a "Object of class TestObjectWithoutToString could not be converted to string" error
  1470. * which gets thrown as a \PHPUnit\Framework\Error\Error Exception by PHPUnit.
  1471. *
  1472. * @return void
  1473. */
  1474. public function testBlockAppendObjectWithoutToString()
  1475. {
  1476. $this->expectException(\PHPUnit\Framework\Error\Error::class);
  1477. $object = new TestObjectWithoutToString();
  1478. $this->View->assign('testBlock', 'Block ');
  1479. $this->View->append('testBlock', $object);
  1480. }
  1481. /**
  1482. * Test prepending to a block with prepend.
  1483. *
  1484. * @param mixed $value Value
  1485. * @return void
  1486. * @dataProvider blockValueProvider
  1487. */
  1488. public function testBlockPrepend($value)
  1489. {
  1490. $this->View->assign('test', 'Block');
  1491. $result = $this->View->prepend('test', $value);
  1492. $this->assertSame($this->View, $result);
  1493. $result = $this->View->fetch('test');
  1494. $this->assertEquals($value . 'Block', $result);
  1495. }
  1496. /**
  1497. * Test prepending an object without __toString magic method to a block with prepend.
  1498. *
  1499. * This should produce a "Object of class TestObjectWithoutToString could not be converted to string" error
  1500. * which gets thrown as a \PHPUnit\Framework\Error\Error Exception by PHPUnit.
  1501. *
  1502. * @return void
  1503. */
  1504. public function testBlockPrependObjectWithoutToString()
  1505. {
  1506. $this->expectException(\PHPUnit\Framework\Error\Error::class);
  1507. $object = new TestObjectWithoutToString();
  1508. $this->View->assign('test', 'Block ');
  1509. $this->View->prepend('test', $object);
  1510. }
  1511. /**
  1512. * You should be able to append to undefined blocks.
  1513. *
  1514. * @return void
  1515. */
  1516. public function testBlockAppendUndefined()
  1517. {
  1518. $result = $this->View->append('test', 'Unknown');
  1519. $this->assertSame($this->View, $result);
  1520. $result = $this->View->fetch('test');
  1521. $this->assertEquals('Unknown', $result);
  1522. }
  1523. /**
  1524. * You should be able to prepend to undefined blocks.
  1525. *
  1526. * @return void
  1527. */
  1528. public function testBlockPrependUndefined()
  1529. {
  1530. $this->View->prepend('test', 'Unknown');
  1531. $result = $this->View->fetch('test');
  1532. $this->assertEquals('Unknown', $result);
  1533. }
  1534. /**
  1535. * Test getting block names
  1536. *
  1537. * @return void
  1538. */
  1539. public function testBlocks()
  1540. {
  1541. $this->View->append('test', 'one');
  1542. $this->View->assign('test1', 'one');
  1543. $this->assertEquals(['test', 'test1'], $this->View->blocks());
  1544. }
  1545. /**
  1546. * Test that blocks can be nested.
  1547. *
  1548. * @return void
  1549. */
  1550. public function testNestedBlocks()
  1551. {
  1552. $this->View->start('first');
  1553. echo 'In first ';
  1554. $this->View->start('second');
  1555. echo 'In second';
  1556. $this->View->end();
  1557. echo 'In first';
  1558. $this->View->end();
  1559. $this->assertEquals('In first In first', $this->View->fetch('first'));
  1560. $this->assertEquals('In second', $this->View->fetch('second'));
  1561. }
  1562. /**
  1563. * Test that starting the same block twice throws an exception
  1564. *
  1565. * @return void
  1566. */
  1567. public function testStartBlocksTwice()
  1568. {
  1569. try {
  1570. $this->View->start('first');
  1571. $this->View->start('first');
  1572. $this->fail('No exception');
  1573. } catch (\Cake\Core\Exception\Exception $e) {
  1574. ob_end_clean();
  1575. $this->assertTrue(true);
  1576. }
  1577. }
  1578. /**
  1579. * Test that an exception gets thrown when you leave a block open at the end
  1580. * of a view.
  1581. *
  1582. * @return void
  1583. */
  1584. public function testExceptionOnOpenBlock()
  1585. {
  1586. try {
  1587. $this->View->render('open_block');
  1588. $this->fail('No exception');
  1589. } catch (\LogicException $e) {
  1590. ob_end_clean();
  1591. $this->assertContains('The "no_close" block was left open', $e->getMessage());
  1592. }
  1593. }
  1594. /**
  1595. * Test nested extended views.
  1596. *
  1597. * @return void
  1598. */
  1599. public function testExtendNested()
  1600. {
  1601. $this->View->setLayout(false);
  1602. $content = $this->View->render('nested_extends');
  1603. $expected = <<<TEXT
  1604. This is the second parent.
  1605. This is the first parent.
  1606. This is the first template.
  1607. Sidebar Content.
  1608. TEXT;
  1609. $this->assertEquals($expected, $content);
  1610. }
  1611. /**
  1612. * Make sure that extending the current view with itself causes an exception
  1613. *
  1614. * @return void
  1615. */
  1616. public function testExtendSelf()
  1617. {
  1618. try {
  1619. $this->View->setLayout(false);
  1620. $this->View->render('extend_self');
  1621. $this->fail('No exception');
  1622. } catch (\LogicException $e) {
  1623. ob_end_clean();
  1624. $this->assertContains('cannot have views extend themselves', $e->getMessage());
  1625. }
  1626. }
  1627. /**
  1628. * Make sure that extending in a loop causes an exception
  1629. *
  1630. * @return void
  1631. */
  1632. public function testExtendLoop()
  1633. {
  1634. try {
  1635. $this->View->setLayout(false);
  1636. $this->View->render('extend_loop');
  1637. $this->fail('No exception');
  1638. } catch (\LogicException $e) {
  1639. ob_end_clean();
  1640. $this->assertContains('cannot have views extend in a loop', $e->getMessage());
  1641. }
  1642. }
  1643. /**
  1644. * Test extend() in an element and a view.
  1645. *
  1646. * @return void
  1647. */
  1648. public function testExtendElement()
  1649. {
  1650. $this->View->setLayout(false);
  1651. $content = $this->View->render('extend_element');
  1652. $expected = <<<TEXT
  1653. Parent View.
  1654. View content.
  1655. Parent Element.
  1656. Element content.
  1657. TEXT;
  1658. $this->assertEquals($expected, $content);
  1659. }
  1660. /**
  1661. * Test extend() in an element and a view.
  1662. *
  1663. * @return void
  1664. */
  1665. public function testExtendPrefixElement()
  1666. {
  1667. $this->View->setRequest($this->View->getRequest()->withParam('prefix', 'Admin'));
  1668. $this->View->setLayout(false);
  1669. $content = $this->View->render('extend_element');
  1670. $expected = <<<TEXT
  1671. Parent View.
  1672. View content.
  1673. Parent Element.
  1674. Prefix Element content.
  1675. TEXT;
  1676. $this->assertEquals($expected, $content);
  1677. }
  1678. /**
  1679. * Extending an element which doesn't exist should throw a missing view exception
  1680. *
  1681. * @return void
  1682. */
  1683. public function testExtendMissingElement()
  1684. {
  1685. try {
  1686. $this->View->setLayout(false);
  1687. $this->View->render('extend_missing_element');
  1688. $this->fail('No exception');
  1689. } catch (\LogicException $e) {
  1690. ob_end_clean();
  1691. ob_end_clean();
  1692. $this->assertContains('element', $e->getMessage());
  1693. }
  1694. }
  1695. /**
  1696. * Test extend() preceeded by an element()
  1697. *
  1698. * @return void
  1699. */
  1700. public function testExtendWithElementBeforeExtend()
  1701. {
  1702. $this->View->setLayout(false);
  1703. $result = $this->View->render('extend_with_element');
  1704. $expected = <<<TEXT
  1705. Parent View.
  1706. this is the test elementThe view
  1707. TEXT;
  1708. $this->assertEquals($expected, $result);
  1709. }
  1710. /**
  1711. * Test extend() preceeded by an element()
  1712. *
  1713. * @return void
  1714. */
  1715. public function testExtendWithPrefixElementBeforeExtend()
  1716. {
  1717. $this->View->setRequest($this->View->getRequest()->withParam('prefix', 'Admin'));
  1718. $this->View->setLayout(false);
  1719. $result = $this->View->render('extend_with_element');
  1720. $expected = <<<TEXT
  1721. Parent View.
  1722. this is the test prefix elementThe view
  1723. TEXT;
  1724. $this->assertEquals($expected, $result);
  1725. }
  1726. /**
  1727. * Test memory leaks that existed in _paths at one point.
  1728. *
  1729. * @return void
  1730. */
  1731. public function testMemoryLeakInPaths()
  1732. {
  1733. $this->skipIf(env('CODECOVERAGE') == 1, 'Running coverage this causes this tests to fail sometimes.');
  1734. $this->ThemeController->setPlugin(null);
  1735. $this->ThemeController->setName('Posts');
  1736. $View = $this->ThemeController->createView();
  1737. $View->setTemplatePath('Posts');
  1738. $View->setLayout('whatever');
  1739. $View->setTheme('TestTheme');
  1740. $View->element('test_element');
  1741. $start = memory_get_usage();
  1742. for ($i = 0; $i < 10; $i++) {
  1743. $View->element('test_element');
  1744. }
  1745. $end = memory_get_usage();
  1746. $this->assertLessThanOrEqual($start + 15000, $end);
  1747. }
  1748. /**
  1749. * Tests that a view block uses default value when not assigned and uses assigned value when it is
  1750. *
  1751. * @return void
  1752. */
  1753. public function testBlockDefaultValue()
  1754. {
  1755. $default = 'Default';
  1756. $result = $this->View->fetch('title', $default);
  1757. $this->assertEquals($default, $result);
  1758. $expected = 'My Title';
  1759. $this->View->assign('title', $expected);
  1760. $result = $this->View->fetch('title', $default);
  1761. $this->assertEquals($expected, $result);
  1762. }
  1763. /**
  1764. * Tests that a view variable uses default value when not assigned and uses assigned value when it is
  1765. *
  1766. * @return void
  1767. */
  1768. public function testViewVarDefaultValue()
  1769. {
  1770. $default = 'Default';
  1771. $result = $this->View->get('title', $default);
  1772. $this->assertEquals($default, $result);
  1773. $expected = 'Back to the Future';
  1774. $this->View->set('title', $expected);
  1775. $result = $this->View->get('title', $default);
  1776. $this->assertEquals($expected, $result);
  1777. }
  1778. /**
  1779. * Test the helpers() method.
  1780. *
  1781. * @return void
  1782. */
  1783. public function testHelpers()
  1784. {
  1785. $this->assertInstanceOf('Cake\View\HelperRegistry', $this->View->helpers());
  1786. $result = $this->View->helpers();
  1787. $this->assertSame($result, $this->View->helpers());
  1788. }
  1789. /**
  1790. * Test getTemplatePath() and setTemplatePath().
  1791. *
  1792. * @return void
  1793. */
  1794. public function testGetSetTemplatePath()
  1795. {
  1796. $result = $this->View->setTemplatePath('foo');
  1797. $this->assertSame($this->View, $result);
  1798. $templatePath = $this->View->getTemplatePath();
  1799. $this->assertSame($templatePath, 'foo');
  1800. }
  1801. /**
  1802. * Test getLayoutPath() and setLayoutPath().
  1803. *
  1804. * @return void
  1805. */
  1806. public function testGetSetLayoutPath()
  1807. {
  1808. $result = $this->View->setLayoutPath('foo');
  1809. $this->assertSame($this->View, $result);
  1810. $layoutPath = $this->View->getLayoutPath();
  1811. $this->assertSame($layoutPath, 'foo');
  1812. }
  1813. /**
  1814. * Test isAutoLayoutEnabled() and enableAutoLayout().
  1815. *
  1816. * @return void
  1817. */
  1818. public function testAutoLayout()
  1819. {
  1820. $result = $this->View->enableAutoLayout(false);
  1821. $this->assertSame($this->View, $result);
  1822. $autoLayout = $this->View->isAutoLayoutEnabled();
  1823. $this->assertSame($autoLayout, false);
  1824. $this->View->enableAutoLayout();
  1825. $autoLayout = $this->View->isAutoLayoutEnabled();
  1826. $this->assertSame($autoLayout, true);
  1827. }
  1828. /**
  1829. * Test getTheme() and setTheme().
  1830. *
  1831. * @return void
  1832. */
  1833. public function testGetSetTheme()
  1834. {
  1835. $result = $this->View->setTheme('foo');
  1836. $this->assertSame($this->View, $result);
  1837. $theme = $this->View->getTheme();
  1838. $this->assertSame($theme, 'foo');
  1839. }
  1840. /**
  1841. * Test getTemplate() and setTemplate().
  1842. *
  1843. * @return void
  1844. */
  1845. public function testGetSetTemplate()
  1846. {
  1847. $result = $this->View->setTemplate('foo');
  1848. $this->assertSame($this->View, $result);
  1849. $template = $this->View->getTemplate();
  1850. $this->assertSame($template, 'foo');
  1851. }
  1852. /**
  1853. * Test setLayout() and getLayout().
  1854. *
  1855. * @return void
  1856. */
  1857. public function testGetSetLayout()
  1858. {
  1859. $result = $this->View->setLayout('foo');
  1860. $this->assertSame($this->View, $result);
  1861. $layout = $this->View->getLayout();
  1862. $this->assertSame($layout, 'foo');
  1863. }
  1864. /**
  1865. * Test testHasRendered()
  1866. *
  1867. * @return void
  1868. */
  1869. public function testHasRendered()
  1870. {
  1871. $this->assertFalse($this->View->hasRendered());
  1872. $this->View->render('index');
  1873. $this->assertTrue($this->View->hasRendered());
  1874. }
  1875. /**
  1876. * Test magic getter and setter for removed properties.
  1877. *
  1878. * @group deprecated
  1879. * @return void
  1880. */
  1881. public function testMagicGetterSetter()
  1882. {
  1883. $this->deprecated(function () {
  1884. $View = $this->View;
  1885. $View->view = 'myview';
  1886. $this->assertEquals('myview', $View->template());
  1887. $this->assertEquals('myview', $View->view);
  1888. $View->viewPath = 'mypath';
  1889. $this->assertEquals('mypath', $View->templatePath());
  1890. $this->assertEquals('mypath', $View->templatePath);
  1891. });
  1892. }
  1893. }