Class JsonView
A view class that is used for JSON responses.
It allows you to omit templates if you just need to emit JSON string as response.
In your controller, you could do the following:
$this->set(['posts' => $posts]); $this->set('_serialize', true);
When the view is rendered, the $posts
view variable will be serialized into JSON.
You can also set multiple view variables for serialization. This will create a top level object containing all the named view variables:
$this->set(compact('posts', 'users', 'stuff')); $this->set('_serialize', true);
The above would generate a JSON object that looks like:
{"posts": [...], "users": [...]}
You can also set '_serialize'
to a string or array to serialize only the specified view variables.
If you don't use the _serialize
, you will need a view template. You can use extended views to provide layout-like functionality.
You can also enable JSONP support by setting parameter _jsonp
to true or a string to specify custom query string parameter name which will contain the callback function name.
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.
- $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
- $_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.
- $_eventClass protected
string
Default class name for new event objects.
- $_eventManager protected
\Cake\Event\EventManagerInterface|\Cake\Event\EventManager
Instance of the Cake\Event\EventManager this object is using to dispatch inner events.
- $_ext protected
string
File extension. Defaults to CakePHP's template ".ctp".
- $_helpers protected
\Cake\View\HelperRegistry
Helpers collection
- $_parents protected
string[]
The names of views and their parents used with View::extend();
- $_passedVars protected
string[]
List of variables to collect from the associated controller.
- $_paths protected
string[]
Holds an array of paths.
- $_pathsForPlugin protected
string[][]
Holds an array of plugin paths.
- $_responseType protected
string
Response type.
- $_specialVars protected
array
List of special view vars.
- $_stack protected
string[]
Content stack, used for nested templates that all use View::extend();
- $_validViewOptions public
array
- $_viewBlockClass protected
string
ViewBlock class.
- $_viewBuilder protected
\Cake\View\ViewBuilder
The view builder instance being used.
- $autoLayout protected
bool
Turns on or off CakePHP's conventional mode of applying layout files. On by default.
- $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
bool
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
JSON layouts are located in the json sub directory of
Layouts/
- $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.
- $response protected
\Cake\Http\Response
Reference to the Response object
- $subDir protected
string
JSON views are located in the 'json' sub directory for controllers' views.
- $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
string[]
List of generated DOM UUIDs.
- $view public
string
- $viewClass public
string|null
The name of default View class.
- $viewPath public
string
- $viewVars public
array
Variables for the view.
Method Summary
- _checkFilePath() protected
Check that a view file path does not go outside of the defined template paths.
- _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.
- _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
- element() public
Renders a piece of PHP with provided parameters and returns HTML, XML, or any other string.
- extend() public
Provides template or element extension/inheritance. Views can extends a parent view and populate blocks in the parent template.
- getTemplate() public
Get the name of the template file to render. The name specified is the filename in /src/Template/
without the .ctp extension. - isAutoLayoutEnabled() public
Returns if CakePHP's conventional mode of applying layout files is enabled.
- log() public
Convenience method to write a message to Log. See Log::write() for more information on writing to logs.
- requestAction() public
Calls a controller's method from any location. Can be used to connect controllers together or tie plugins into a main application. requestAction can be used to return rendered views or fetch the return value from controller actions.
- 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:
- setTemplate() public
Set the name of the template file to render. The name specified is the filename in /src/Template/
without the .ctp extension. - 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. - uuid() public
Generates a unique, non-random DOM ID for an object, based on the object type and the target URL.
- viewOptions() public
Get/Set valid view options in the object's _validViewOptions property. The property is created as an empty array if it is not set. If called without any parameters it will return the current list of valid view options. See
createView()
.
Method Detail
__construct() public
__construct(\Cake\Http\ServerRequest $request, \Cake\Http\Response $response, \Cake\Event\EventManager $eventManager, array $viewOptions)
Constructor
Parameters
-
\Cake\Http\ServerRequest|null
$request optional Request instance.
-
\Cake\Http\Response|null
$response optional Response instance.
-
\Cake\Event\EventManager|null
$eventManager optional EventManager instance.
-
array
$viewOptions optional An array of view options
__get() public
__get(mixed $name)
Magic accessor for helpers.
Parameters
-
string
$name Name of the attribute to get.
Returns
mixed
__set() public
__set(mixed $name, mixed $value)
Magic setter for deprecated properties.
Parameters
-
string
$name Name to property.
-
mixed
$value Value for property.
_checkFilePath() protected
_checkFilePath(mixed $file, mixed $path)
Check that a view file path does not go outside of the defined template paths.
Only paths that contain ..
will be checked, as they are the ones most likely to have the ability to resolve to files outside of the template paths.
Parameters
-
string
$file The path to the template file.
-
string
$path Base path that $file should be inside of.
Returns
string
The file path
Throws
InvalidArgumentException
_createCell() protected
_createCell(mixed $className, mixed $action, mixed $plugin, mixed $options)
Create and configure the cell instance.
Parameters
-
string
$className The cell classname.
-
string
$action The action name.
-
string
$plugin The plugin name.
-
array
$options The constructor options for the cell.
Returns
\Cake\View\Cell
_dataToSerialize() protected
_dataToSerialize(mixed $serialize)
Returns data to be serialized.
Parameters
-
array|string|bool
$serialize optional The name(s) of the view variable(s) that need(s) to be serialized. If true all available view variables will be used.
Returns
mixed
The data to serialize.
_elementCache() protected
_elementCache(mixed $name, mixed $data, mixed $options)
Generate the cache configuration options for an element.
Parameters
-
string
$name Element name
-
array
$data Data
-
array
$options Element options
Returns
array
Element Cache configuration.
_evaluate() protected
_evaluate(mixed $viewFile, mixed $dataForView)
Sandbox method to evaluate a template / view script in.
Parameters
-
string
$viewFile Filename of the view
-
array
$dataForView Data to include in rendered view.
Returns
string
Rendered output
_getElementFileName() protected
_getElementFileName(mixed $name, mixed $pluginCheck)
Finds an element filename, returns false on failure.
Parameters
-
string
$name The name of the element to find.
-
bool
$pluginCheck optional - if false will ignore the request's plugin if parsed plugin is not loaded
Returns
string|false
Either a string to the element filename or false when one can't be found.
_getLayoutFileName() protected
_getLayoutFileName(mixed $name)
Returns layout filename for this template as a string.
Parameters
-
string|null
$name optional The name of the layout to find.
Returns
string
Filename for layout file (.ctp).
Throws
Cake\View\Exception\MissingLayoutException
when a layout cannot be located
_getSubPaths() protected
_getSubPaths(mixed $basePath)
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.
Parameters
-
string
$basePath Base path on which to get the prefixed one.
Returns
array
Array with all the templates paths.
_getViewFileName() protected
_getViewFileName(mixed $name)
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.
Parameters
-
string|null
$name optional Controller action to find template filename for
Returns
string
Template filename
Throws
Cake\View\Exception\MissingTemplateException
when a view file could not be found.
_inflectViewFileName() protected
_inflectViewFileName(mixed $name)
Change the name of a view template file into underscored format.
Parameters
-
string
$name Name of file which should be inflected.
Returns
string
File name after conversion
_paths() protected
_paths(mixed $plugin, mixed $cached)
Return all possible paths to find view files in order
Parameters
-
string|null
$plugin optional Optional plugin name to scan for view files.
-
bool
$cached optional Set to false to force a refresh of view paths. Default true.
Returns
string[]
paths
_render() protected
_render(mixed $viewFile, mixed $data)
Renders and returns output for given template filename with its array of data. Handles parent/extended templates.
Parameters
-
string
$viewFile Filename of the view
-
array
$data optional Data to include in rendered view. If empty the current View::$viewVars will be used.
Returns
string
Rendered output
Throws
LogicException
When a block is left open.
_renderElement() protected
_renderElement(mixed $file, mixed $data, mixed $options)
Renders an element and fires the before and afterRender callbacks for it and writes to the cache if a cache is used
Parameters
-
string
$file Element file path
-
array
$data Data to render
-
array
$options Element options
Returns
string
_serialize() protected
_serialize(mixed $serialize)
Serialize view vars
Special parameters
_jsonOptions
You can set custom options for json_encode() this way, e.g. JSON_HEX_TAG | JSON_HEX_APOS
.
Parameters
-
array|string|bool
$serialize The name(s) of the view variable(s) that need(s) to be serialized. If true all available view variables.
Returns
string|false
The serialized data, or boolean false if not serializable.
append() public
append(mixed $name, mixed $value)
Append to an existing or new block.
Appending to a new block will create the block.
Parameters
-
string
$name Name of the block
-
mixed
$value optional The content for the block. Value will be type cast to string.
Returns
$this
See Also
assign() public
assign(mixed $name, mixed $value)
Set the content for a block. This will overwrite any existing content.
Parameters
-
string
$name Name of the block
-
mixed
$value The content for the block. Value will be type cast to string.
Returns
$this
See Also
autoLayout() public
autoLayout(mixed $autoLayout)
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.
Parameters
-
bool|null
$autoLayout optional Boolean to turn on/off. If null returns current value.
Returns
bool|null
blocks() public
blocks()
Get the names of all the existing blocks.
Returns
string[]
An array containing the blocks.
See Also
cache() public
cache(callable $block, array $options)
Create a cached block of view logic.
This allows you to cache a block of view output into the cache defined in elementCache
.
This method will attempt to read the cache first. If the cache is empty, the $block will be run and the output stored.
Parameters
-
callable
$block The block of code that you want to cache the output of.
-
array
$options optional The options defining the cache key etc.
Returns
string
The rendered content.
Throws
RuntimeException
When $options is lacking a 'key' option.
cell() protected
cell(mixed $cell, array $data, array $options)
Renders the given cell.
Example:
// 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]);
The display
action will be used by default when no action is provided:
// Taxonomy\View\Cell\TagCloudCell::display() $cell = $this->cell('Taxonomy.TagCloud');
Cells are not rendered until they are echoed.
Parameters
-
string
$cell You must indicate cell name, and optionally a cell action. e.g.:
TagCloud::smallList
will invokeView\Cell\TagCloudCell::smallList()
,display
action will be invoked by default when none is provided.-
array
$data optional Additional arguments for cell method. e.g.:
cell('TagCloud::smallList', ['a1' => 'v1', 'a2' => 'v2'])
maps toView\Cell\TagCloud::smallList(v1, v2)
-
array
$options optional Options for Cell's constructor
Returns
\Cake\View\Cell
The cell instance
Throws
Cake\View\Exception\MissingCellException
If Cell class was not found.
BadMethodCallException
If Cell class does not specified cell action.
createView() public
createView(mixed $viewClass)
Constructs the view class instance based on the current configuration.
Parameters
-
string|null
$viewClass optional Optional namespaced class name of the View class to instantiate.
Returns
\Cake\View\View
Throws
Cake\View\Exception\MissingViewException
If view class was not found.
disableAutoLayout() public
disableAutoLayout()
Turns off CakePHP's conventional mode of applying layout files.
Layouts will not be automatically applied to rendered views.
Returns
$this
dispatchEvent() public
dispatchEvent(mixed $name, mixed $data, mixed $subject)
Wrapper for creating and dispatching events.
Returns a dispatched event.
Parameters
-
string
$name Name of the event.
-
array|null
$data optional Any value you wish to be transported with this event to it can be read by listeners.
-
object|null
$subject optional The object that this event applies to ($this by default).
Returns
\Cake\Event\Event
element() public
element(mixed $name, array $data, array $options)
Renders a piece of PHP with provided parameters and returns HTML, XML, or any other string.
This realizes the concept of Elements, (or "partial layouts") and the $params array is used to send data to be used in the element. Elements can be cached improving performance by using the cache
option.
Parameters
-
string
$name Name of template file in the /src/Template/Element/ folder, or
MyPlugin.template
to use the template element from MyPlugin. If the element is not found in the plugin, the normal view path cascade will be searched.-
array
$data optional Array of data to be made available to the rendered view (i.e. the Element)
-
array
$options optional -
Array of options. Possible keys are:
-
cache
- Can either betrue
, to enable caching using the config in View::$elementCache. Or an array If an array, the following keys can be used:-
config
- Used to store the cached element in a custom cache configuration. -
key
- Used to define the key used in the Cache::write(). It will be prefixed withelement_
-
-
callbacks
- Set to true to fire beforeRender and afterRender helper callbacks for this element. Defaults to false. -
ignoreMissing
- Used to allow missing elements. Set to true to not throw exceptions. -
plugin
- setting to false will force to use the application's element from plugin templates, when the plugin has element with same name. Defaults to true
-
Returns
string
Rendered Element
Throws
Cake\View\Exception\MissingElementException
When an element is missing and `ignoreMissing` is false.
elementExists() public
elementExists(mixed $name)
Checks if an element exists
Parameters
-
string
$name Name of template file in the /src/Template/Element/ folder, or
MyPlugin.template
to check the template element from MyPlugin. If the element is not found in the plugin, the normal view path cascade will be searched.
Returns
bool
Success
enableAutoLayout() public
enableAutoLayout(mixed $enable)
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.
Parameters
-
bool
$enable optional Boolean to turn on/off.
Returns
$this
end() public
end()
End a capturing block. The compliment to View::start()
Returns
$this
See Also
eventManager() public
eventManager(\Cake\Event\EventManager $eventManager)
Returns the Cake\Event\EventManager manager instance for this object.
You can use this instance to register any new listeners or callbacks to the object events, or create your own events and trigger them at will.
Parameters
-
\Cake\Event\EventManager|null
$eventManager optional the eventManager to set
Returns
\Cake\Event\EventManager
exists() public
exists(mixed $name)
Check if a block exists
Parameters
-
string
$name Name of the block
Returns
bool
extend() public
extend(mixed $name)
Provides template or element extension/inheritance. Views can extends a parent view and populate blocks in the parent template.
Parameters
-
string
$name The template or element to 'extend' the current one with.
Returns
$this
Throws
LogicException
when you extend a template with itself or make extend loops.
LogicException
when you extend an element which doesn't exist
fetch() public
fetch(mixed $name, mixed $default)
Fetch the content for a block. If a block is empty or undefined '' will be returned.
Parameters
-
string
$name Name of the block
-
string
$default optional Default text
Returns
string
The block content or $default if the block does not exist.
See Also
get() public
get(mixed $var, mixed $default)
Returns the contents of the given View variable.
Parameters
-
string
$var The view var you want the contents of.
-
mixed
$default optional The default/fallback content of $var.
Returns
mixed
The content of the named var if its set, otherwise $default.
getCurrentType() public
getCurrentType()
Retrieve the current view type
Returns
string
getEventManager() public
getEventManager()
Returns the Cake\Event\EventManager manager instance for this object.
You can use this instance to register any new listeners or callbacks to the object events, or create your own events and trigger them at will.
Returns
\Cake\Event\EventManager
getLayout() public
getLayout()
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.
Returns
string
getLayoutPath() public
getLayoutPath()
Get path for layout files.
Returns
string
getName() public
getName()
Returns the View's controller name.
Returns
string|null
getPlugin() public
getPlugin()
Returns the plugin name.
Returns
string|null
getRequest() public
getRequest()
Gets the request instance.
Returns
\Cake\Http\ServerRequest
getResponse() public
getResponse()
Gets the response instance.
Returns
\Cake\Http\Response
getSubDir() public
getSubDir()
Get sub-directory for this template files.
Returns
string
See Also
getTemplate() public
getTemplate()
Get the name of the template file to render. The name specified is the filename in /src/Template/
Returns
string
getTemplatePath() public
getTemplatePath()
Get path for templates files.
Returns
string
getTheme() public
getTheme()
Get the current view theme.
Returns
string|null
getVars() public
getVars()
Returns a list of variables available in the current View context
Returns
string[]
Array of the set view variable names.
helpers() public
helpers()
Get the helper registry in use by this View class.
Returns
\Cake\View\HelperRegistry
initialize() public
initialize()
Initialization hook method.
Properties like $helpers etc. cannot be initialized statically in your custom view class as they are overwritten by values from controller in constructor. So this method allows you to manipulate them as required after view instance is constructed.
isAutoLayoutEnabled() public
isAutoLayoutEnabled()
Returns if CakePHP's conventional mode of applying layout files is enabled.
Disabled means that layouts will not be automatically applied to rendered views.
Returns
bool
layout() public
layout(mixed $name)
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.
Parameters
-
string|null
$name optional Layout file name to set. If null returns current name.
Returns
string|null
layoutPath() public
layoutPath(mixed $path)
Get/set path for layout files.
Parameters
-
string|null
$path optional Path for layout files. If null returns current path.
Returns
string|null
loadHelper() public
loadHelper(mixed $name, array $config)
Loads a helper. Delegates to the HelperRegistry::load()
to load the helper
Parameters
-
string
$name Name of the helper to load.
-
array
$config optional Settings for the helper
Returns
\Cake\View\Helper
a constructed helper object.
See Also
loadHelpers() public
loadHelpers()
Load helpers only if serialization is disabled.
Returns
$this
log() public
log(mixed $message, mixed $level, mixed $context)
Convenience method to write a message to Log. See Log::write() for more information on writing to logs.
Parameters
-
mixed
$message Log message.
-
int|string
$level optional Error level.
-
string|array
$context optional Additional log data relevant to this message.
Returns
bool
Success of log write.
pluginSplit() public
pluginSplit(mixed $name, mixed $fallback)
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
Parameters
-
string
$name The name you want to plugin split.
-
bool
$fallback optional If true uses the plugin set in the current Request when parsed plugin is not loaded
Returns
array
Array with 2 indexes. 0 => plugin name, 1 => filename
prepend() public
prepend(mixed $name, mixed $value)
Prepend to an existing or new block.
Prepending to a new block will create the block.
Parameters
-
string
$name Name of the block
-
mixed
$value The content for the block. Value will be type cast to string.
Returns
$this
See Also
render() public
render(mixed $view, mixed $layout)
Render a JSON view.
Special parameters
_serialize
To convert a set of view variables into a JSON response. Its value can be a string for single variable name or array for multiple names. If true all view variables will be serialized. It unset normal view template will be rendered. _jsonp
Enables JSONP support and wraps response in callback function provided in query string.
- Setting it to true enables the default query string parameter "callback".
- Setting it to a string value, uses the provided query string parameter for finding the JSONP callback name.
Parameters
-
string|null
$view optional The view being rendered.
-
string|null
$layout optional The layout being rendered.
Returns
string|null
The rendered view.
renderLayout() public
renderLayout(mixed $content, mixed $layout)
Renders a layout. Returns output from _render(). Returns false on error.
Several variables are created for use in layout.
Parameters
-
string
$content Content to render in a template, wrapped by the surrounding layout.
-
string|null
$layout optional Layout name
Returns
string|false
Rendered output, or false on error
Throws
Cake\Core\Exception\Exception
if there is an error in the view.
requestAction() public
requestAction(mixed $url, array $extra)
Calls a controller's method from any location. Can be used to connect controllers together or tie plugins into a main application. requestAction can be used to return rendered views or fetch the return value from controller actions.
Under the hood this method uses Router::reverse() to convert the $url parameter into a string URL. You should use URL formats that are compatible with Router::reverse()
Examples
A basic example getting the return value of the controller action:
$variables = $this->requestAction('/articles/popular');
A basic example of request action to fetch a rendered page without the layout.
$viewHtml = $this->requestAction('/articles/popular', ['return']);
You can also pass the URL as an array:
$vars = $this->requestAction(['controller' => 'articles', 'action' => 'popular']);
Passing other request data
You can pass POST, GET, COOKIE and other data into the request using the appropriate keys. Cookies can be passed using the cookies
key. Get parameters can be set with query
and post data can be sent using the post
key.
$vars = $this->requestAction('/articles/popular', [ 'query' => ['page' => 1], 'cookies' => ['remember_me' => 1], ]);
Sending environment or header values
By default actions dispatched with this method will use the global $_SERVER and $_ENV values. If you want to override those values for a request action, you can specify the values:
$vars = $this->requestAction('/articles/popular', [ 'environment' => ['CONTENT_TYPE' => 'application/json'] ]);
Transmitting the session
By default actions dispatched with this method will use the standard session object. If you want a particular session instance to be used, you need to specify it.
$vars = $this->requestAction('/articles/popular', [ 'session' => new Session($someSessionConfig) ]);
Parameters
-
string|array
$url String or array-based url. Unlike other url arrays in CakePHP, this url will not automatically handle passed arguments in the $url parameter.
-
array
$extra optional if array includes the key "return" it sets the autoRender to true. Can also be used to submit GET/POST data, and passed arguments.
Returns
mixed
Boolean true or false on success/failure, or contents of rendered action if 'return' is set in $extra.
reset() public
reset(mixed $name)
Reset the content for a block. This will overwrite any existing content.
Parameters
-
string
$name Name of the block
Returns
$this
See Also
set() public
set(mixed $name, mixed $value)
Saves a variable or an associative array of variables for use inside a template.
Parameters
-
string|array
$name A string or an array of data.
-
mixed
$value optional Value in case $name is a string (which then works as the key). Unused if $name is an associative array, otherwise serves as the values to $name's keys.
Returns
$this
setElementCache() public
setElementCache(mixed $elementCache)
Set The cache configuration View will use to store cached elements
Parameters
-
string
$elementCache Cache config name.
Returns
$this
See Also
setEventManager() public
setEventManager(\Cake\Event\EventManager $eventManager)
Returns the Cake\Event\EventManager manager instance for this object.
You can use this instance to register any new listeners or callbacks to the object events, or create your own events and trigger them at will.
Parameters
-
\Cake\Event\EventManager
$eventManager the eventManager to set
Returns
$this
setLayout() public
setLayout(mixed $name)
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.
Parameters
-
string
$name Layout file name to set.
Returns
$this
setLayoutPath() public
setLayoutPath(mixed $path)
Set path for layout files.
Parameters
-
string
$path Path for layout files.
Returns
$this
setPlugin() public
setPlugin(mixed $name)
Sets the plugin name.
Parameters
-
string
$name Plugin name.
Returns
$this
setRequest() public
setRequest(\Cake\Http\ServerRequest $request)
Sets the request objects and configures a number of controller properties based on the contents of the request. The properties that get set are:
- $this->request - To the $request parameter
- $this->plugin - To the value returned by $request->getParam('plugin')
- $this->passedArgs - Same as $request->params['pass]
Parameters
-
\Cake\Http\ServerRequest
$request Request instance.
Returns
$this
setResponse() public
setResponse(\Cake\Http\Response $response)
Sets the response instance.
Parameters
-
\Cake\Http\Response
$response Response instance.
Returns
$this
setSubDir() public
setSubDir(mixed $subDir)
Set sub-directory for this template files.
Parameters
-
string
$subDir Sub-directory name.
Returns
$this
See Also
setTemplate() public
setTemplate(mixed $name)
Set the name of the template file to render. The name specified is the filename in /src/Template/
Parameters
-
string
$name Template file name to set.
Returns
$this
setTemplatePath() public
setTemplatePath(mixed $path)
Set path for templates files.
Parameters
-
string
$path Path for template files.
Returns
$this
setTheme() public
setTheme(mixed $theme)
Set the view theme to use.
Parameters
-
string|null
$theme Theme name.
Returns
$this
start() public
start(mixed $name)
Start capturing output for a 'block'
You can use start on a block multiple times to append or prepend content in a capture mode.
// 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();
Parameters
-
string
$name The name of the block to capture for.
Returns
$this
See Also
template() public
template(mixed $name)
Get/set the name of the template file to render. The name specified is the filename in /src/Template/
Parameters
-
string|null
$name optional Template file name to set. If null returns current name.
Returns
string|null
templatePath() public
templatePath(mixed $path)
Get/set path for templates files.
Parameters
-
string|null
$path optional Path for template files. If null returns current path.
Returns
string|null
theme() public
theme(mixed $theme)
The view theme to use.
Parameters
-
string|null
$theme optional Theme name. If null returns current theme.
Returns
string|null
uuid() public
uuid(mixed $object, mixed $url)
Generates a unique, non-random DOM ID for an object, based on the object type and the target URL.
Parameters
-
string
$object Type of object, i.e. 'form' or 'link'
-
string
$url The object's target URL
Returns
string
viewBuilder() public
viewBuilder()
Get the view builder being used.
Returns
\Cake\View\ViewBuilder
viewOptions() public
viewOptions(mixed $options, mixed $merge)
Get/Set valid view options in the object's _validViewOptions property. The property is created as an empty array if it is not set. If called without any parameters it will return the current list of valid view options. See createView()
.
Parameters
-
string|array|null
$options optional string or array of string to be appended to _validViewOptions.
-
bool
$merge optional Whether to merge with or override existing valid View options. Defaults to
true
.
Returns
array
The updated view options as an array.
Property Detail
$Blocks protected
ViewBlock instance.
Type
\Cake\View\ViewBlock
$Breadcrumbs public
Type
\Cake\View\Helper\BreadcrumbsHelper
$Flash public
Type
\Cake\View\Helper\FlashHelper
$Form public
Type
\Cake\View\Helper\FormHelper
$Html public
Type
\Cake\View\Helper\HtmlHelper
$Number public
Type
\Cake\View\Helper\NumberHelper
$Paginator public
Type
\Cake\View\Helper\PaginatorHelper
$Rss public
Type
\Cake\View\Helper\RssHelper
$Session public
Type
\Cake\View\Helper\SessionHelper
$Text public
Type
\Cake\View\Helper\TextHelper
$Time public
Type
\Cake\View\Helper\TimeHelper
$Url public
Type
\Cake\View\Helper\UrlHelper
$_current protected
The currently rendering view file. Used for resolving parent files.
Type
string
$_currentType protected
Currently rendering an element. Used for finding parent fragments for elements.
Type
string
$_eventClass protected
Default class name for new event objects.
Type
string
$_eventManager protected
Instance of the Cake\Event\EventManager this object is using to dispatch inner events.
Type
\Cake\Event\EventManagerInterface|\Cake\Event\EventManager
$_ext protected
File extension. Defaults to CakePHP's template ".ctp".
Type
string
$_helpers protected
Helpers collection
Type
\Cake\View\HelperRegistry
$_parents protected
The names of views and their parents used with View::extend();
Type
string[]
$_passedVars protected
List of variables to collect from the associated controller.
Type
string[]
$_paths protected
Holds an array of paths.
Type
string[]
$_pathsForPlugin protected
Holds an array of plugin paths.
Type
string[][]
$_responseType protected
Response type.
Type
string
$_specialVars protected
List of special view vars.
Type
array
$_stack protected
Content stack, used for nested templates that all use View::extend();
Type
string[]
$_validViewOptions public
Type
array
$_viewBlockClass protected
ViewBlock class.
Type
string
$_viewBuilder protected
The view builder instance being used.
Type
\Cake\View\ViewBuilder
$autoLayout protected
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.
Type
bool
$elementCache protected
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.
Type
string
$hasRendered public
True when the view has been rendered.
Type
bool
$helpers protected
An array of names of built-in helpers to include.
Type
array
$layout protected
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.
Type
string
$layoutPath protected
JSON layouts are located in the json sub directory of Layouts/
Type
string
$name protected
Name of the controller that created the View if any.
Type
string
$passedArgs public
Current passed params. Passed to View from the creating Controller for convenience.
Type
array
$plugin protected
The name of the plugin.
Type
string|null
$request protected
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.
Type
\Cake\Http\ServerRequest
$response protected
Reference to the Response object
Type
\Cake\Http\Response
$subDir protected
JSON views are located in the 'json' sub directory for controllers' views.
Type
string
$template protected
The name of the template file to render. The name specified is the filename in /src/Template/
Type
string
$templatePath protected
The name of the subfolder containing templates for this View.
Type
string
$theme protected
The view theme to use.
Type
string|null
$uuids public
List of generated DOM UUIDs.
Type
string[]
$view public
Type
string
$viewClass public
The name of default View class.
Type
string|null
$viewPath public
Type
string
$viewVars public
Variables for the view.
Deprecated: This property will be removed in 4.x. Inside controller context use $this->set()
instead, also see $this->viewBuilder()->getVar()
. In view context it will be a protected property View::$viewVars
.
Type
array
© 2005–present The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/3.9/class-Cake.View.JsonView.html