Class View

Constants summary

• string
  NAME_ELEMENT ¶
  'Element'
• string
  NAME_TEMPLATE ¶
  'Template'
• string
  TYPE_ELEMENT ¶
  'element'
• string
  TYPE_LAYOUT ¶
  'layout'
• string
  TYPE_TEMPLATE ¶
  'view'
• string
  TYPE_VIEW ¶
  'view'

Properties summary

• $Blocks protected
  Cake\View\ViewBlock
  ViewBlock instance.
• $_current protected
  string
  The currently rendering view file. Used for resolving parent files.
• $_currentType protected
  string

  Currently rendering an element. Used for finding parent fragments for elements.

• $_ext protected
  string
  File extension. Defaults to CakePHP's template ".ctp".
• $_helpers protected
  Cake\View\HelperRegistry
  Helpers collection
• $_parents protected
  array
  The names of views and their parents used with View::extend();
• $_passedVars protected
  array
  List of variables to collect from the associated controller.
• $_paths protected
  array
  Holds an array of paths.
• $_pathsForPlugin protected
  array
  Holds an array of plugin paths.
• $_stack protected
  array
  Content stack, used for nested templates that all use View::extend();
• $_viewBlockClass protected
  string
  ViewBlock class.
• $autoLayout protected
  boolean

  Turns on or off CakePHP's conventional mode of applying layout files. On by default. Setting to off means that layouts will not be automatically applied to rendered templates.

• $elementCache protected
  string

  The Cache configuration View will use to store cached elements. Changing this will change the default configuration elements are stored under. You can also choose a cache config per element.

• $hasRendered public
  boolean
  True when the view has been rendered.
• $helpers protected
  array
  An array of names of built-in helpers to include.
• $layout protected
  string

  The name of the layout file to render the template inside of. The name specified is the filename of the layout in /src/Template/Layout without the .ctp extension.

• $layoutPath protected
  string
  The name of the layouts subfolder containing layouts for this View.
• $name protected
  string
  Name of the controller that created the View if any.
• $passedArgs public
  array
  Current passed params. Passed to View from the creating Controller for convenience.
• $plugin protected
  string|null
  The name of the plugin.
• $request protected
  Cake\Http\ServerRequest

  An instance of a \Cake\Http\ServerRequest object that contains information about the current request. This object contains all the information about a request and several methods for reading additional information about the request.

• $response protected
  Cake\Http\Response
  Reference to the Response object
• $subDir protected
  string

  Sub-directory for this template file. This is often used for extension based routing. Eg. With an xml extension, $subDir would be xml/

• $template protected
  string

  The name of the template file to render. The name specified is the filename in /src/Template/ without the .ctp extension.

• $templatePath protected
  string
  The name of the subfolder containing templates for this View.
• $theme protected
  string|null
  The view theme to use.
• $uuids public
  array
  List of generated DOM UUIDs.

Magic properties summary

• $Blocks public
  Cake\View\ViewBlock
• $Breadcrumbs public
  Cake\View\Helper\BreadcrumbsHelper
• $Flash public
  Cake\View\Helper\FlashHelper
• $Form public
  Cake\View\Helper\FormHelper
• $Html public
  Cake\View\Helper\HtmlHelper
• $Number public
  Cake\View\Helper\NumberHelper
• $Paginator public
  Cake\View\Helper\PaginatorHelper
• $Rss public
  Cake\View\Helper\RssHelper
• $Session public
  Cake\View\Helper\SessionHelper
• $Text public
  Cake\View\Helper\TextHelper
• $Time public
  Cake\View\Helper\TimeHelper
• $Url public
  Cake\View\Helper\UrlHelper
• $view public
  string
• $viewPath public
  string

Inherited Magic Properties

• _validViewOptions

Inherited Properties

• _eventClass, _eventManager _viewBuilder, viewClass, viewVars

Method Summary

• __construct() public

  Constructor

• __get() public

  Magic accessor for helpers.

• __set() public

  Magic setter for deprecated properties.

• _checkFilePath() protected

  Check that a view file path does not go outside of the defined template paths.

• _elementCache() protected

  Generate the cache configuration options for an element.

• _evaluate() protected

  Sandbox method to evaluate a template / view script in.

• _getElementFileName() protected

  Finds an element filename, returns false on failure.

• _getLayoutFileName() protected

  Returns layout filename for this template as a string.

• _getSubPaths() protected

  Find all sub templates path, based on $basePath If a prefix is defined in the current request, this method will prepend the prefixed template path to the $basePath, cascading up in case the prefix is nested. This is essentially used to find prefixed template paths for elements and layouts.

• _getViewFileName() protected

  Returns filename of given action's template file (.ctp) as a string. CamelCased action names will be under_scored by default. This means that you can have LongActionNames that refer to long_action_names.ctp views. You can change the inflection rule by overriding _inflectViewFileName.

• _inflectViewFileName() protected

  Change the name of a view template file into underscored format.

• _paths() protected

  Return all possible paths to find view files in order

• _render() protected

  Renders and returns output for given template filename with its array of data. Handles parent/extended templates.

• _renderElement() protected

  Renders an element and fires the before and afterRender callbacks for it and writes to the cache if a cache is used

• append() public

  Append to an existing or new block.

• assign() public

  Set the content for a block. This will overwrite any existing content.

• autoLayout() public

  Turns on or off CakePHP's conventional mode of applying layout files. On by default. Setting to off means that layouts will not be automatically applied to rendered templates.

• blocks() public

  Get the names of all the existing blocks.

• cache() public

  Create a cached block of view logic.

• disableAutoLayout() public

  Turns off CakePHP's conventional mode of applying layout files.

• element() public

  Renders a piece of PHP with provided parameters and returns HTML, XML, or any other string.

• elementExists() public

  Checks if an element exists

• enableAutoLayout() public

  Turns on or off CakePHP's conventional mode of applying layout files. On by default. Setting to off means that layouts will not be automatically applied to rendered views.

• end() public

  End a capturing block. The compliment to View::start()

• exists() public

  Check if a block exists

• extend() public

  Provides template or element extension/inheritance. Views can extends a parent view and populate blocks in the parent template.

• fetch() public

  Fetch the content for a block. If a block is empty or undefined '' will be returned.

• get() public

  Returns the contents of the given View variable.

• getCurrentType() public

  Retrieve the current view type

• getLayout() public

  Get the name of the layout file to render the template inside of. The name specified is the filename of the layout in /src/Template/Layout without the .ctp extension.

• getLayoutPath() public

  Get path for layout files.

• getName() public

  Returns the View's controller name.

• getPlugin() public

  Returns the plugin name.

• getRequest() public

  Gets the request instance.

• getResponse() public

  Gets the response instance.

• getSubDir() public

  Get sub-directory for this template files.

• getTemplate() public

  Get the name of the template file to render. The name specified is the filename in /src/Template/ without the .ctp extension.

• getTemplatePath() public

  Get path for templates files.

• getTheme() public

  Get the current view theme.

• getVars() public

  Returns a list of variables available in the current View context

• helpers() public

  Get the helper registry in use by this View class.

• initialize() public

  Initialization hook method.

• isAutoLayoutEnabled() public

  Returns if CakePHP's conventional mode of applying layout files is enabled. Disabled means that layouts will not be automatically applied to rendered views.

• layout() public

  Get/set the name of the layout file to render the template inside of. The name specified is the filename of the layout in /src/Template/Layout without the .ctp extension.

• layoutPath() public

  Get/set path for layout files.

• loadHelper() public

  Loads a helper. Delegates to the HelperRegistry::load() to load the helper

• loadHelpers() public

  Interact with the HelperRegistry to load all the helpers.

• pluginSplit() public

  Splits a dot syntax plugin name into its plugin and filename. If $name does not have a dot, then index 0 will be null. It checks if the plugin is loaded, else filename will stay unchanged for filenames containing dot

• prepend() public

  Prepend to an existing or new block.

• render() public

  Renders view for given template file and layout.

• renderLayout() public

  Renders a layout. Returns output from _render(). Returns false on error. Several variables are created for use in layout.

• reset() public

  Reset the content for a block. This will overwrite any existing content.

• setElementCache() public

  Set The cache configuration View will use to store cached elements

• setLayout() public

  Set the name of the layout file to render the template inside of. The name specified is the filename of the layout in /src/Template/Layout without the .ctp extension.

• setLayoutPath() public

  Set path for layout files.

• setPlugin() public

  Sets the plugin name.

• setRequest() public

  Sets the request objects and configures a number of controller properties based on the contents of the request. The properties that get set are:

• setResponse() public

  Sets the response instance.

• setSubDir() public

  Set sub-directory for this template files.

• setTemplate() public

  Set the name of the template file to render. The name specified is the filename in /src/Template/ without the .ctp extension.

• setTemplatePath() public

  Set path for templates files.

• setTheme() public

  Set the view theme to use.

• start() public

  Start capturing output for a 'block'

• template() public

  Get/set the name of the template file to render. The name specified is the filename in /src/Template/ without the .ctp extension.

• templatePath() public

  Get/set path for templates files.

• theme() public

  The view theme to use.

• uuid() public

  Generates a unique, non-random DOM ID for an object, based on the object type and the target URL.

Method Detail

// Append content to an existing block.
$this->start('content');
echo $this->fetch('content');
echo 'Some new content';
$this->end();

// Prepend content to an existing block
$this->start('content');
echo 'Some new content';
echo $this->fetch('content');
$this->end();

Methods used from Cake\View\CellTrait

// Taxonomy\View\Cell\TagCloudCell::smallList()
$cell = $this->cell('Taxonomy.TagCloud::smallList', ['limit' => 10]);

// App\View\Cell\TagCloudCell::smallList()
$cell = $this->cell('TagCloud::smallList', ['limit' => 10]);

// Taxonomy\View\Cell\TagCloudCell::display()
$cell = $this->cell('Taxonomy.TagCloud');

Methods used from Cake\Event\EventDispatcherTrait

Methods used from Cake\Log\LogTrait

Methods used from Cake\Routing\RequestActionTrait

$variables = $this->requestAction('/articles/popular');

$viewHtml = $this->requestAction('/articles/popular', ['return']);

$vars = $this->requestAction(['controller' => 'articles', 'action' => 'popular']);

$vars = $this->requestAction('/articles/popular', [
  'query' => ['page' => 1],
  'cookies' => ['remember_me' => 1],
]);

$vars = $this->requestAction('/articles/popular', [
  'environment' => ['CONTENT_TYPE' => 'application/json']
]);

$vars = $this->requestAction('/articles/popular', [
  'session' => new Session($someSessionConfig)
]);

Methods used from Cake\View\ViewVarsTrait

Magic methods inherited from Cake\Event\EventDispatcherInterface

Properties detail

''

'.ctp'

[]

[
    'viewVars', 'autoLayout', 'helpers', 'template', 'layout', 'name', 'theme',
    'layoutPath', 'templatePath', 'plugin', 'passedArgs'
]

[]

[]

[]

ViewBlock::class

true

'default'

false

[]

'default'

[]

''

[]

Magic properties detail