set([ 'testData' => 'Some test data', 'test2' => 'more data', 'test3' => 'even more data', ]); } /** * nocache_tags_with_element method * * @return void */ public function nocache_multiple_element() { $this->set('foo', 'this is foo var'); $this->set('bar', 'this is bar var'); } } /** * ThemePostsController class */ class ThemePostsController extends Controller { /** * index method * * @return void */ public function index() { $this->set('testData', 'Some test data'); $test2 = 'more data'; $test3 = 'even more data'; $this->set(compact('test2', 'test3')); } } /** * TestView class */ class TestView extends AppView { public function initialize() { $this->loadHelper('Html', ['mykey' => 'myval']); } /** * getViewFileName method * * @param string $name Controller action to find template filename for * @return string Template filename */ public function getViewFileName($name = null) { return $this->_getViewFileName($name); } /** * getLayoutFileName method * * @param string $name The name of the layout to find. * @return string Filename for layout file (.ctp). */ public function getLayoutFileName($name = null) { return $this->_getLayoutFileName($name); } /** * paths method * * @param string $plugin Optional plugin name to scan for view files. * @param bool $cached Set to true to force a refresh of view paths. * @return array paths */ public function paths($plugin = null, $cached = true) { return $this->_paths($plugin, $cached); } /** * Setter for extension. * * @param string $ext The extension * @return void */ public function ext($ext) { $this->_ext = $ext; } } /** * TestBeforeAfterHelper class */ class TestBeforeAfterHelper extends Helper { /** * property property * * @var string */ public $property = ''; /** * beforeLayout method * * @param string $viewFile View file name. * @return void */ public function beforeLayout($viewFile) { $this->property = 'Valuation'; } /** * afterLayout method * * @param string $layoutFile Layout file name. * @return void */ public function afterLayout($layoutFile) { $this->_View->append('content', 'modified in the afterlife'); } } /** * TestObjectWithToString * * An object with the magic method __toString() for testing with view blocks. */ class TestObjectWithToString { /** * Return string value. * * @return string */ public function __toString() { return "I'm ObjectWithToString"; } } /** * TestObjectWithoutToString * * An object without the magic method __toString() for testing with view blocks. */ class TestObjectWithoutToString { } /** * TestViewEventListenerInterface * * An event listener to test cakePHP events */ class TestViewEventListenerInterface implements EventListenerInterface { /** * type of view before rendering has occurred * * @var string */ public $beforeRenderViewType; /** * type of view after rendering has occurred * * @var string */ public $afterRenderViewType; /** * implementedEvents method * * @return array */ public function implementedEvents() { return [ 'View.beforeRender' => 'beforeRender', 'View.afterRender' => 'afterRender' ]; } /** * beforeRender method * * @param \Cake\Event\Event $event the event being sent * @return void */ public function beforeRender(Event $event) { $this->beforeRenderViewType = $event->getSubject()->getCurrentType(); } /** * afterRender method * * @param \Cake\Event\Event $event the event being sent * @return void */ public function afterRender(Event $event) { $this->afterRenderViewType = $event->getSubject()->getCurrentType(); } } /** * ViewTest class */ class ViewTest extends TestCase { /** * Fixtures used in this test. * * @var array */ public $fixtures = ['core.posts', 'core.users']; /** * @var \Cake\View\View */ public $View; /** * @var ViewPostsController */ public $PostsController; /** * setUp method * * @return void */ public function setUp() { parent::setUp(); $request = new ServerRequest(); $this->Controller = new Controller($request); $this->PostsController = new ViewPostsController($request); $this->PostsController->index(); $this->View = $this->PostsController->createView(); $this->View->setTemplatePath('Posts'); $themeRequest = new ServerRequest('posts/index'); $this->ThemeController = new Controller($themeRequest); $this->ThemePostsController = new ThemePostsController($themeRequest); $this->ThemePostsController->index(); $this->ThemeView = $this->ThemePostsController->createView(); $this->ThemeView->setTemplatePath('Posts'); Plugin::load(['TestPlugin', 'PluginJs', 'TestTheme', 'Company/TestPluginThree']); Configure::write('debug', true); } /** * tearDown method * * @return void */ public function tearDown() { parent::tearDown(); Plugin::unload(); unset($this->View); unset($this->PostsController); unset($this->Controller); unset($this->ThemeView); unset($this->ThemePostsController); unset($this->ThemeController); } /** * Test getViewFileName method * * @return void */ public function testGetTemplate() { $request = $this->getMockBuilder('Cake\Http\ServerRequest')->getMock(); $response = $this->getMockBuilder('Cake\Http\Response')->getMock(); $viewOptions = [ 'plugin' => null, 'name' => 'Pages', 'viewPath' => 'Pages' ]; $request->action = 'display'; $request->params['pass'] = ['home']; $ThemeView = new TestView(null, null, null, $viewOptions); $ThemeView->theme = 'TestTheme'; $expected = TEST_APP . 'TestApp' . DS . 'Template' . DS . 'Pages' . DS . 'home.ctp'; $result = $ThemeView->getViewFileName('home'); $this->assertPathEquals($expected, $result); $expected = Plugin::path('TestTheme') . 'src' . DS . 'Template' . DS . 'Posts' . DS . 'index.ctp'; $result = $ThemeView->getViewFileName('/Posts/index'); $this->assertPathEquals($expected, $result); $expected = Plugin::path('TestTheme') . 'src' . DS . 'Template' . DS . 'Layout' . DS . 'default.ctp'; $result = $ThemeView->getLayoutFileName(); $this->assertPathEquals($expected, $result); $ThemeView->layoutPath = 'rss'; $expected = TEST_APP . 'TestApp' . DS . 'Template' . DS . 'Layout' . DS . 'rss' . DS . 'default.ctp'; $result = $ThemeView->getLayoutFileName(); $this->assertPathEquals($expected, $result); $ThemeView->layoutPath = 'Email' . DS . 'html'; $expected = TEST_APP . 'TestApp' . DS . 'Template' . DS . 'Layout' . DS . 'Email' . DS . 'html' . DS . 'default.ctp'; $result = $ThemeView->getLayoutFileName(); $this->assertPathEquals($expected, $result); $ThemeView = new TestView(null, null, null, $viewOptions); $ThemeView->theme = 'Company/TestPluginThree'; $expected = Plugin::path('Company/TestPluginThree') . 'src' . DS . 'Template' . DS . 'Layout' . DS . 'default.ctp'; $result = $ThemeView->getLayoutFileName(); $this->assertPathEquals($expected, $result); } /** * Test getLayoutFileName method on plugin * * @return void */ public function testPluginGetTemplate() { $viewOptions = ['plugin' => 'TestPlugin', 'name' => 'TestPlugin', 'viewPath' => 'Tests', 'view' => 'index' ]; $View = new TestView(null, null, null, $viewOptions); $expected = Plugin::path('TestPlugin') . 'src' . DS . 'Template' . DS . 'Tests' . DS . 'index.ctp'; $result = $View->getViewFileName('index'); $this->assertEquals($expected, $result); $expected = Plugin::path('TestPlugin') . 'src' . DS . 'Template' . DS . 'Layout' . DS . 'default.ctp'; $result = $View->getLayoutFileName(); $this->assertEquals($expected, $result); } /** * Test that plugin files with absolute file paths are scoped * to the plugin and do now allow any file path. * * @return void */ public function testPluginGetTemplateAbsoluteFail() { $this->expectException(\Cake\View\Exception\MissingTemplateException::class); $request = $this->getMockBuilder('Cake\Http\ServerRequest')->getMock(); $response = $this->getMockBuilder('Cake\Http\Response')->getMock(); $viewOptions = [ 'plugin' => null, 'name' => 'Pages', 'viewPath' => 'Pages' ]; $request->action = 'display'; $request->params['pass'] = ['home']; $view = new TestView(null, null, null, $viewOptions); $expected = TEST_APP . 'Plugin' . DS . 'Company' . DS . 'TestPluginThree' . DS . 'src' . DS . 'Template' . DS . 'Pages' . DS . 'index.ctp'; $result = $view->getViewFileName('Company/TestPluginThree./Pages/index'); $this->assertPathEquals($expected, $result); $view->getViewFileName('Company/TestPluginThree./etc/passwd'); } /** * Test getViewFileName method on plugin * * @return void */ public function testPluginThemedGetTemplate() { $viewOptions = ['plugin' => 'TestPlugin', 'name' => 'TestPlugin', 'viewPath' => 'Tests', 'view' => 'index', 'theme' => 'TestTheme' ]; $ThemeView = new TestView(null, null, null, $viewOptions); $themePath = Plugin::path('TestTheme') . 'src' . DS . 'Template' . DS; $expected = $themePath . 'Plugin' . DS . 'TestPlugin' . DS . 'Tests' . DS . 'index.ctp'; $result = $ThemeView->getViewFileName('index'); $this->assertPathEquals($expected, $result); $expected = $themePath . 'Plugin' . DS . 'TestPlugin' . DS . 'Layout' . DS . 'plugin_default.ctp'; $result = $ThemeView->getLayoutFileName('plugin_default'); $this->assertPathEquals($expected, $result); $expected = $themePath . 'Layout' . DS . 'default.ctp'; $result = $ThemeView->getLayoutFileName('default'); $this->assertPathEquals($expected, $result); } /** * Test that plugin/$plugin_name is only appended to the paths it should be. * * @return void */ public function testPathPluginGeneration() { $viewOptions = ['plugin' => 'TestPlugin', 'name' => 'TestPlugin', 'viewPath' => 'Tests', 'view' => 'index' ]; $View = new TestView(null, null, null, $viewOptions); $paths = $View->paths(); $expected = array_merge(App::path('Template'), App::core('Template')); $this->assertEquals($expected, $paths); $paths = $View->paths('TestPlugin'); $pluginPath = Plugin::path('TestPlugin'); $expected = [ TEST_APP . 'TestApp' . DS . 'Template' . DS . 'Plugin' . DS . 'TestPlugin' . DS, $pluginPath . 'src' . DS . 'Template' . DS, TEST_APP . 'TestApp' . DS . 'Template' . DS, CAKE . 'Template' . DS, ]; $this->assertPathEquals($expected, $paths); } /** * Test that themed plugin paths are generated correctly. * * @return void */ public function testPathThemedPluginGeneration() { $viewOptions = ['plugin' => 'TestPlugin', 'name' => 'TestPlugin', 'viewPath' => 'Tests', 'view' => 'index', 'theme' => 'TestTheme' ]; $View = new TestView(null, null, null, $viewOptions); $paths = $View->paths('TestPlugin'); $pluginPath = Plugin::path('TestPlugin'); $themePath = Plugin::path('TestTheme'); $expected = [ $themePath . 'src' . DS . 'Template' . DS . 'Plugin' . DS . 'TestPlugin' . DS, $themePath . 'src' . DS . 'Template' . DS, TEST_APP . 'TestApp' . DS . 'Template' . DS . 'Plugin' . DS . 'TestPlugin' . DS, $pluginPath . 'src' . DS . 'Template' . DS, TEST_APP . 'TestApp' . DS . 'Template' . DS, CAKE . 'Template' . DS, ]; $this->assertPathEquals($expected, $paths); } /** * Test that multiple paths can be used in App.paths.templates. * * @return void */ public function testMultipleAppPaths() { $viewOptions = ['plugin' => 'TestPlugin', 'name' => 'TestPlugin', 'viewPath' => 'Tests', 'view' => 'index', 'theme' => 'TestTheme' ]; $paths = Configure::read('App.paths.templates'); $paths[] = Plugin::classPath('TestPlugin') . 'Template' . DS; Configure::write('App.paths.templates', $paths); $View = new TestView(null, null, null, $viewOptions); $paths = $View->paths('TestPlugin'); $pluginPath = Plugin::path('TestPlugin'); $themePath = Plugin::path('TestTheme'); $expected = [ $themePath . 'src' . DS . 'Template' . DS . 'Plugin' . DS . 'TestPlugin' . DS, $themePath . 'src' . DS . 'Template' . DS, TEST_APP . 'TestApp' . DS . 'Template' . DS . 'Plugin' . DS . 'TestPlugin' . DS, $pluginPath . 'src' . DS . 'Template' . DS . 'Plugin' . DS . 'TestPlugin' . DS, $pluginPath . 'src' . DS . 'Template' . DS, TEST_APP . 'TestApp' . DS . 'Template' . DS, TEST_APP . 'Plugin' . DS . 'TestPlugin' . DS . 'src' . DS . 'Template' . DS, CAKE . 'Template' . DS, ]; $this->assertPathEquals($expected, $paths); } /** * Test that CamelCase'd plugins still find their view files. * * @return void */ public function testCamelCasePluginGetTemplate() { $viewOptions = ['plugin' => 'TestPlugin', 'name' => 'TestPlugin', 'viewPath' => 'Tests', 'view' => 'index' ]; $View = new TestView(null, null, null, $viewOptions); $pluginPath = Plugin::path('TestPlugin'); $expected = TEST_APP . 'Plugin' . DS . 'TestPlugin' . DS . 'src' . DS . 'Template' . DS . 'Tests' . DS . 'index.ctp'; $result = $View->getViewFileName('index'); $this->assertPathEquals($expected, $result); $expected = $pluginPath . 'src' . DS . 'Template' . DS . 'Layout' . DS . 'default.ctp'; $result = $View->getLayoutFileName(); $this->assertPathEquals($expected, $result); } /** * Test getViewFileName method * * @return void */ public function testGetViewFileNames() { $viewOptions = [ 'plugin' => null, 'name' => 'Pages', 'viewPath' => 'Pages' ]; $request = $this->getMockBuilder('Cake\Http\ServerRequest')->getMock(); $response = $this->getMockBuilder('Cake\Http\Response')->getMock(); $View = new TestView(null, null, null, $viewOptions); $expected = TEST_APP . 'TestApp' . DS . 'Template' . DS . 'Pages' . DS . 'home.ctp'; $result = $View->getViewFileName('home'); $this->assertPathEquals($expected, $result); $expected = TEST_APP . 'TestApp' . DS . 'Template' . DS . 'Posts' . DS . 'index.ctp'; $result = $View->getViewFileName('/Posts/index'); $this->assertPathEquals($expected, $result); $expected = TEST_APP . 'TestApp' . DS . 'Template' . DS . 'Posts' . DS . 'index.ctp'; $result = $View->getViewFileName('../Posts/index'); $this->assertPathEquals($expected, $result); $expected = TEST_APP . 'TestApp' . DS . 'Template' . DS . 'Pages' . DS . 'page.home.ctp'; $result = $View->getViewFileName('page.home'); $this->assertPathEquals($expected, $result, 'Should not ruin files with dots.'); Plugin::load('TestPlugin'); $expected = TEST_APP . 'TestApp' . DS . 'Template' . DS . 'Pages' . DS . 'home.ctp'; $result = $View->getViewFileName('TestPlugin.home'); $this->assertPathEquals($expected, $result, 'Plugin is missing the view, cascade to app.'); $View->setTemplatePath('Tests'); $expected = TEST_APP . 'Plugin' . DS . 'TestPlugin' . DS . 'src' . DS . 'Template' . DS . 'Tests' . DS . 'index.ctp'; $result = $View->getViewFileName('TestPlugin.index'); $this->assertPathEquals($expected, $result); } /** * Test that getViewFileName() protects against malicious directory traversal. * * @return void */ public function testGetViewFileNameDirectoryTraversal() { $this->expectException(\InvalidArgumentException::class); $viewOptions = [ 'plugin' => null, 'name' => 'Pages', 'viewPath' => 'Pages', ]; $request = $this->getMockBuilder('Cake\Http\ServerRequest')->getMock(); $response = $this->getMockBuilder('Cake\Http\Response')->getMock(); $view = new TestView(null, null, null, $viewOptions); $view->ext('.php'); $view->getViewFileName('../../../../bootstrap'); } /** * Test getViewFileName doesn't re-apply existing subdirectories * * @return void */ public function testGetViewFileNameSubDir() { $viewOptions = [ 'plugin' => null, 'name' => 'Posts', 'viewPath' => 'Posts/json', 'layoutPath' => 'json', ]; $view = new TestView(null, null, null, $viewOptions); $expected = TEST_APP . 'TestApp' . DS . 'Template' . DS . 'Posts' . DS . 'json' . DS . 'index.ctp'; $result = $view->getViewFileName('index'); $this->assertPathEquals($expected, $result); $view->subDir = 'json'; $result = $view->getViewFileName('index'); $expected = TEST_APP . 'TestApp' . DS . 'Template' . DS . 'Posts' . DS . 'json' . DS . 'index.ctp'; $this->assertPathEquals($expected, $result); } /** * Test getting layout filenames * * @return void */ public function testGetLayoutFileName() { $viewOptions = ['plugin' => null, 'name' => 'Pages', 'viewPath' => 'Pages', 'action' => 'display' ]; $View = new TestView(null, null, null, $viewOptions); $expected = TEST_APP . 'TestApp' . DS . 'Template' . DS . 'Layout' . DS . 'default.ctp'; $result = $View->getLayoutFileName(); $this->assertPathEquals($expected, $result); $View->layoutPath = 'rss'; $expected = TEST_APP . 'TestApp' . DS . 'Template' . DS . 'Layout' . DS . 'rss' . DS . 'default.ctp'; $result = $View->getLayoutFileName(); $this->assertPathEquals($expected, $result); $View->layoutPath = 'Email' . DS . 'html'; $expected = TEST_APP . 'TestApp' . DS . 'Template' . DS . 'Layout' . DS . 'Email' . DS . 'html' . DS . 'default.ctp'; $result = $View->getLayoutFileName(); $this->assertPathEquals($expected, $result); } /** * Test getting layout filenames for plugins. * * @return void */ public function testGetLayoutFileNamePlugin() { $viewOptions = ['plugin' => null, 'name' => 'Pages', 'viewPath' => 'Pages', 'action' => 'display' ]; $View = new TestView(null, null, null, $viewOptions); Plugin::load('TestPlugin'); $expected = TEST_APP . 'Plugin' . DS . 'TestPlugin' . DS . 'src' . DS . 'Template' . DS . 'Layout' . DS . 'default.ctp'; $result = $View->getLayoutFileName('TestPlugin.default'); $this->assertPathEquals($expected, $result); $View->plugin = 'TestPlugin'; $expected = TEST_APP . 'Plugin' . DS . 'TestPlugin' . DS . 'src' . DS . 'Template' . DS . 'Layout' . DS . 'default.ctp'; $result = $View->getLayoutFileName('default'); $this->assertPathEquals($expected, $result); } /** * Test getting layout filenames for prefix * * @return void */ public function testGetLayoutFileNamePrefix() { $View = new TestView(); // Prefix specific layout $View->request->params['prefix'] = 'foo_prefix'; $expected = TEST_APP . 'TestApp' . DS . 'Template' . DS . 'FooPrefix' . DS . 'Layout' . DS . 'default.ctp'; $result = $View->getLayoutFileName(); $this->assertPathEquals($expected, $result); $View->request->params['prefix'] = 'FooPrefix'; $result = $View->getLayoutFileName(); $this->assertPathEquals($expected, $result); // Nested prefix layout $View->request->params['prefix'] = 'foo_prefix/bar_prefix'; $expected = TEST_APP . 'TestApp' . DS . 'Template' . DS . 'FooPrefix' . DS . 'BarPrefix' . DS . 'Layout' . DS . 'default.ctp'; $result = $View->getLayoutFileName(); $this->assertPathEquals($expected, $result); $View->request->params['prefix'] = 'foo_prefix/bar_prefix'; $expected = TEST_APP . 'TestApp' . DS . 'Template' . DS . 'FooPrefix' . DS . 'Layout' . DS . 'nested_prefix_cascade.ctp'; $result = $View->getLayoutFileName('nested_prefix_cascade'); $this->assertPathEquals($expected, $result); // Fallback to app's layout $View->request->params['prefix'] = 'Admin'; $expected = TEST_APP . 'TestApp' . DS . 'Template' . DS . 'Layout' . DS . 'default.ctp'; $result = $View->getLayoutFileName(); $this->assertPathEquals($expected, $result); } /** * Test that getLayoutFileName() protects against malicious directory traversal. * * @return void */ public function testGetLayoutFileNameDirectoryTraversal() { $this->expectException(\InvalidArgumentException::class); $viewOptions = [ 'plugin' => null, 'name' => 'Pages', 'viewPath' => 'Pages', ]; $request = $this->getMockBuilder('Cake\Http\ServerRequest')->getMock(); $response = $this->getMockBuilder('Cake\Http\Response')->getMock(); $view = new TestView(null, null, null, $viewOptions); $view->ext('.php'); $view->getLayoutFileName('../../../../bootstrap'); } /** * Test for missing views * * @return void */ public function testMissingTemplate() { $this->expectException(\Cake\View\Exception\MissingTemplateException::class); $viewOptions = ['plugin' => null, 'name' => 'Pages', 'viewPath' => 'Pages' ]; $request = $this->getMockBuilder('Cake\Http\ServerRequest')->getMock(); $response = $this->getMockBuilder('Cake\Http\Response')->getMock(); $View = new TestView($request, $response, null, $viewOptions); $View->getViewFileName('does_not_exist'); } /** * Test for missing layouts * * @return void */ public function testMissingLayout() { $this->expectException(\Cake\View\Exception\MissingLayoutException::class); $viewOptions = ['plugin' => null, 'name' => 'Pages', 'viewPath' => 'Pages', 'layout' => 'whatever' ]; $View = new TestView(null, null, null, $viewOptions); $View->getLayoutFileName(); } /** * Test viewVars method * * @return void */ public function testViewVars() { $this->assertEquals(['testData' => 'Some test data', 'test2' => 'more data', 'test3' => 'even more data'], $this->View->viewVars); } /** * Test generation of UUIDs method * * @return void */ public function testUUIDGeneration() { Router::connect('/:controller', ['action' => 'index']); $result = $this->View->uuid('form', ['controller' => 'posts', 'action' => 'index']); $this->assertEquals('form5988016017', $result); $result = $this->View->uuid('form', ['controller' => 'posts', 'action' => 'index']); $this->assertEquals('formc3dc6be854', $result); $result = $this->View->uuid('form', ['controller' => 'posts', 'action' => 'index']); $this->assertEquals('form28f92cc87f', $result); } /** * Test elementExists method * * @return void */ public function testElementExists() { $result = $this->View->elementExists('test_element'); $this->assertTrue($result); $result = $this->View->elementExists('TestPlugin.plugin_element'); $this->assertTrue($result); $result = $this->View->elementExists('non_existent_element'); $this->assertFalse($result); $result = $this->View->elementExists('TestPlugin.element'); $this->assertFalse($result); $this->View->plugin = 'TestPlugin'; $result = $this->View->elementExists('plugin_element'); $this->assertTrue($result); } /** * Test element method * * @return void */ public function testElement() { $result = $this->View->element('test_element'); $this->assertEquals('this is the test element', $result); $result = $this->View->element('TestPlugin.plugin_element'); $this->assertEquals("Element in the TestPlugin\n", $result); $this->View->plugin = 'TestPlugin'; $result = $this->View->element('plugin_element'); $this->assertEquals("Element in the TestPlugin\n", $result); $result = $this->View->element('plugin_element', [], ['plugin' => false]); $this->assertEquals("Plugin element overridden in app\n", $result); } /** * Test element method with a prefix * * @return void */ public function testPrefixElement() { $this->View->request->params['prefix'] = 'Admin'; $result = $this->View->element('prefix_element'); $this->assertEquals('this is a prefixed test element', $result); $result = $this->View->element('TestPlugin.plugin_element'); $this->assertEquals('this is the plugin prefixed element using params[plugin]', $result); $this->View->plugin = 'TestPlugin'; $result = $this->View->element('test_plugin_element'); $this->assertEquals('this is the test set using View::$plugin plugin prefixed element', $result); $this->View->request->params['prefix'] = 'FooPrefix/BarPrefix'; $result = $this->View->element('prefix_element'); $this->assertEquals('this is a nested prefixed test element', $result); $this->View->request->params['prefix'] = 'FooPrefix/BarPrefix'; $result = $this->View->element('prefix_element_in_parent'); $this->assertEquals('this is a nested prefixed test element in first level element', $result); } /** * Test loading non-existent view element * * @expectedException \Cake\View\Exception\MissingElementException * @expectedExceptionMessageRegExp $Element file \"Element[\\|/]non_existent_element\.ctp\" is missing$ * @return void */ public function testElementNonExistent() { $this->View->element('non_existent_element'); } /** * Test loading non-existent plugin view element * * @expectedException \Cake\View\Exception\MissingElementException * @expectedExceptionMessageRegExp $Element file "test_plugin\.Element[\\|/]plugin_element\.ctp\" is missing$ * @return void */ public function testElementInexistentPluginElement() { $this->View->element('test_plugin.plugin_element'); } /** * Test that elements can have callbacks * * @return void */ public function testElementCallbacks() { $count = 0; $callback = function (Event $event, $file) use (&$count) { $count++; }; $events = $this->View->getEventManager(); $events->on('View.beforeRender', $callback); $events->on('View.afterRender', $callback); $this->View->element('test_element', [], ['callbacks' => true]); $this->assertEquals(2, $count); } /** * Test that additional element viewVars don't get overwritten with helpers. * * @return void */ public function testElementParamsDontOverwriteHelpers() { $Controller = new ViewPostsController(); $Controller->helpers = ['Form']; $View = $Controller->createView(); $result = $View->element('type_check', ['form' => 'string'], ['callbacks' => true]); $this->assertEquals('string', $result); $View->set('form', 'string'); $result = $View->element('type_check', [], ['callbacks' => true]); $this->assertEquals('string', $result); } /** * Test elementCacheHelperNoCache method * * @return void */ public function testElementCacheHelperNoCache() { $Controller = new ViewPostsController(); $View = $Controller->createView(); $result = $View->element('test_element', ['ram' => 'val', 'test' => ['foo', 'bar']]); $this->assertEquals('this is the test element', $result); } /** * Test elementCache method * * @return void */ public function testElementCache() { Cache::drop('test_view'); Cache::setConfig('test_view', [ 'engine' => 'File', 'duration' => '+1 day', 'path' => CACHE . 'views/', 'prefix' => '' ]); Cache::clear(false, 'test_view'); $View = $this->PostsController->createView(); $View->elementCache = 'test_view'; $result = $View->element('test_element', [], ['cache' => true]); $expected = 'this is the test element'; $this->assertEquals($expected, $result); $result = Cache::read('element__test_element', 'test_view'); $this->assertEquals($expected, $result); $result = $View->element('test_element', ['param' => 'one', 'foo' => 'two'], ['cache' => true]); $this->assertEquals($expected, $result); $result = Cache::read('element__test_element_param_foo', 'test_view'); $this->assertEquals($expected, $result); $View->element('test_element', [ 'param' => 'one', 'foo' => 'two' ], [ 'cache' => ['key' => 'custom_key'] ]); $result = Cache::read('element_custom_key', 'test_view'); $this->assertEquals($expected, $result); $View->elementCache = 'default'; $View->element('test_element', [ 'param' => 'one', 'foo' => 'two' ], [ 'cache' => ['config' => 'test_view'], ]); $result = Cache::read('element__test_element_param_foo', 'test_view'); $this->assertEquals($expected, $result); Cache::clear(true, 'test_view'); Cache::drop('test_view'); } /** * Test element events * * @return void */ public function testViewEvent() { $View = $this->PostsController->createView(); $View->setTemplatePath($this->PostsController->getName()); $View->enableAutoLayout(false); $listener = new TestViewEventListenerInterface(); $View->getEventManager()->on($listener); $View->render('index'); $this->assertEquals(View::TYPE_VIEW, $listener->beforeRenderViewType); $this->assertEquals(View::TYPE_VIEW, $listener->afterRenderViewType); $this->assertEquals($View->getCurrentType(), View::TYPE_VIEW); $View->element('test_element', [], ['callbacks' => true]); $this->assertEquals($View->getCurrentType(), View::TYPE_VIEW); $this->assertEquals(View::TYPE_ELEMENT, $listener->beforeRenderViewType); $this->assertEquals(View::TYPE_ELEMENT, $listener->afterRenderViewType); } /** * Test loading helper using loadHelper(). * * @return void */ public function testLoadHelper() { $View = new View(); $View->loadHelper('Html', ['foo' => 'bar']); $this->assertInstanceOf('Cake\View\Helper\HtmlHelper', $View->Html); $config = $View->Html->getConfig(); $this->assertEquals('bar', $config['foo']); } /** * Test loading helper when duplicate. * * @return void */ public function testLoadHelperDuplicate() { $View = new View(); $this->assertNotEmpty($View->loadHelper('Html', ['foo' => 'bar'])); try { $View->loadHelper('Html', ['test' => 'value']); $this->fail('No exception'); } catch (\RuntimeException $e) { $this->assertContains('The "Html" alias has already been loaded', $e->getMessage()); } } /** * Test loadHelpers method * * @return void */ public function testLoadHelpers() { $View = new View(); $View->helpers = ['Html' => ['foo' => 'bar'], 'Form' => ['foo' => 'baz']]; $result = $View->loadHelpers(); $this->assertSame($View, $result); $this->assertInstanceOf('Cake\View\Helper\HtmlHelper', $View->Html, 'Object type is wrong.'); $this->assertInstanceOf('Cake\View\Helper\FormHelper', $View->Form, 'Object type is wrong.'); $config = $View->Html->getConfig(); $this->assertEquals('bar', $config['foo']); $config = $View->Form->getConfig(); $this->assertEquals('baz', $config['foo']); } /** * Test lazy loading helpers * * @return void */ public function testLazyLoadHelpers() { $View = new View(); $View->helpers = []; $this->assertInstanceOf('Cake\View\Helper\HtmlHelper', $View->Html, 'Object type is wrong.'); $this->assertInstanceOf('Cake\View\Helper\FormHelper', $View->Form, 'Object type is wrong.'); } /** * Test manipulating class properties in initialize() * * @return void */ public function testInitialize() { $View = new TestView(); $config = $View->Html->getConfig(); $this->assertEquals('myval', $config['mykey']); } /** * Test the correct triggering of helper callbacks * * @return void */ public function testHelperCallbackTriggering() { $View = $this->PostsController->createView(); $View->setTemplatePath($this->PostsController->getName()); $manager = $this->getMockBuilder('Cake\Event\EventManager')->getMock(); $View->setEventManager($manager); $manager->expects($this->at(0))->method('dispatch') ->with( $this->logicalAnd( $this->isInstanceOf('Cake\Event\Event'), $this->attributeEqualTo('_name', 'View.beforeRender'), $this->attributeEqualTo('_subject', $View) ) ); $manager->expects($this->at(1))->method('dispatch') ->with( $this->logicalAnd( $this->isInstanceOf('Cake\Event\Event'), $this->attributeEqualTo('_name', 'View.beforeRenderFile'), $this->attributeEqualTo('_subject', $View) ) ); $manager->expects($this->at(2))->method('dispatch') ->with( $this->logicalAnd( $this->isInstanceOf('Cake\Event\Event'), $this->attributeEqualTo('_name', 'View.afterRenderFile'), $this->attributeEqualTo('_subject', $View) ) ); $manager->expects($this->at(3))->method('dispatch') ->with( $this->logicalAnd( $this->isInstanceOf('Cake\Event\Event'), $this->attributeEqualTo('_name', 'View.afterRender'), $this->attributeEqualTo('_subject', $View) ) ); $manager->expects($this->at(4))->method('dispatch') ->with( $this->logicalAnd( $this->isInstanceOf('Cake\Event\Event'), $this->attributeEqualTo('_name', 'View.beforeLayout'), $this->attributeEqualTo('_subject', $View) ) ); $manager->expects($this->at(5))->method('dispatch') ->with( $this->logicalAnd( $this->isInstanceOf('Cake\Event\Event'), $this->attributeEqualTo('_name', 'View.beforeRenderFile'), $this->attributeEqualTo('_subject', $View) ) ); $manager->expects($this->at(6))->method('dispatch') ->with( $this->logicalAnd( $this->isInstanceOf('Cake\Event\Event'), $this->attributeEqualTo('_name', 'View.afterRenderFile'), $this->attributeEqualTo('_subject', $View) ) ); $manager->expects($this->at(7))->method('dispatch') ->with( $this->logicalAnd( $this->isInstanceOf('Cake\Event\Event'), $this->attributeEqualTo('_name', 'View.afterLayout'), $this->attributeEqualTo('_subject', $View) ) ); $View->render('index'); } /** * Test beforeLayout method * * @return void */ public function testBeforeLayout() { $this->PostsController->helpers = [ 'TestBeforeAfter' => ['className' => __NAMESPACE__ . '\TestBeforeAfterHelper'], 'Html' ]; $View = $this->PostsController->createView(); $View->setTemplatePath($this->PostsController->getName()); $View->render('index'); $this->assertEquals('Valuation', $View->helpers()->TestBeforeAfter->property); } /** * Test afterLayout method * * @return void */ public function testAfterLayout() { $this->PostsController->helpers = [ 'TestBeforeAfter' => ['className' => __NAMESPACE__ . '\TestBeforeAfterHelper'], 'Html' ]; $this->PostsController->set('variable', 'values'); $View = $this->PostsController->createView(); $View->setTemplatePath($this->PostsController->getName()); $content = 'This is my view output'; $result = $View->renderLayout($content, 'default'); $this->assertRegExp('/modified in the afterlife/', $result); $this->assertRegExp('/This is my view output/', $result); } /** * Test renderLoadHelper method * * @return void */ public function testRenderLoadHelper() { $this->PostsController->helpers = ['Form', 'Number']; $View = $this->PostsController->createView('Cake\Test\TestCase\View\TestView'); $View->setTemplatePath($this->PostsController->getName()); $result = $View->render('index', false); $this->assertEquals('posts index', $result); $attached = $View->helpers()->loaded(); // HtmlHelper is loaded in TestView::initialize() $this->assertEquals(['Html', 'Form', 'Number'], $attached); $this->PostsController->helpers = ['Html', 'Form', 'Number', 'TestPlugin.PluggedHelper']; $View = $this->PostsController->createView('Cake\Test\TestCase\View\TestView'); $View->setTemplatePath($this->PostsController->getName()); $result = $View->render('index', false); $this->assertEquals('posts index', $result); $attached = $View->helpers()->loaded(); $expected = ['Html', 'Form', 'Number', 'PluggedHelper']; $this->assertEquals($expected, $attached, 'Attached helpers are wrong.'); } /** * Test render method * * @return void */ public function testRender() { $View = $this->PostsController->createView('Cake\Test\TestCase\View\TestView'); $View->setTemplatePath($this->PostsController->getName()); $result = $View->render('index'); $this->assertRegExp("/\s*