A view class that is used for JSON responses.
By setting the '_serialize' key in your controller, you can specify a view variable that should be serialized to JSON and used as the response for the request. This allows you to omit views and layouts if you just need to emit a single view variable as the JSON response.
In your controller, you could do the following:
$this->set(array('posts' => $posts, '_serialize' => 'posts'));
When the view is rendered, the $posts
view variable will be serialized into JSON.
You can also define '_serialize'
as an array. This will create a top level object containing all the named view variables:
$this->set(compact('posts', 'users', 'stuff')); $this->set('_serialize', array('posts', 'users'));
The above would generate a JSON object that looks like:
{"posts": [...], "users": [...]}
If you don't use the _serialize
key, you will need a view. 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 paramater name which will contain the callback function name.
$subDir
public string
JSON views are always located in the 'json' sub directory for controllers' views.
Blocks
, Helpers
, _current
, _currentType
, _eventManager
, _eventManagerConfigured
, _parents
, _passedVars
, _paths
, _pathsForPlugin
, _scripts
, _stack
, autoLayout
, cacheAction
, elementCache
, elementCacheSettings
, ext
, hasRendered
, helpers
, layout
, layoutPath
, name
, passedArgs
, plugin
, request
, response
, theme
, uuids
, validationErrors
, view
, viewPath
, viewVars
__construct( Controller $controller null )
Constructor
Controller
$controller
optional null View::__construct()
_serialize( array $serialize )
Serialize view vars
_jsonOptions
You can set custom options for json_encode() this way, e.g. JSON_HEX_TAG | JSON_HEX_APOS
.
$serialize
CakeException
loadHelpers( )
Skip loading helpers if this is a _serialize based view.
View::loadHelpers()
render( string $view null , string $layout null )
Render a JSON view.
_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. You can omit the_serialize
parameter, and use a normal view + layout as well. _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.
$view
optional null $layout
optional null CakeException
View::render()
__get( string $name )
Magic accessor for helpers. Provides access to attributes that were deprecated.
$name
__isset( string $name )
Magic isset check for deprecated attributes.
$name
__set( string $name , mixed $value )
Magic accessor for deprecated attributes.
$name
$value
_elementCache( string $name , string $data , array $options )
Checks if an element is cached and returns the cached data if present
$name
$data
$options
_evaluate( string $viewFile , array $dataForView )
Sandbox method to evaluate a template / view script in.
$viewFile
$dataForView
Data to include in rendered view. If empty the current View::$viewVars will be used.
_getElementFileName( string $name )
Finds an element filename, returns false on failure.
$name
_getExtensions( )
Get the extensions that view files can use.
_getLayoutFileName( string $name null )
Returns layout filename for this template as a string.
$name
optional null MissingLayoutException
_getViewFileName( string $name null )
Returns filename of given action's template file (.ctp) as a string. CamelCased action names will be under_scored! This means that you can have LongActionNames that refer to long_action_names.ctp views.
$name
optional null MissingViewException
_paths( string $plugin null , boolean $cached true )
Return all possible paths to find view files in order
$plugin
optional null $cached
optional true _render( string $viewFile , array $data array() )
Renders and returns output for given view filename with its array of data. Handles parent/extended views.
$viewFile
$data
optional array() CakeException
_renderElement( string $file , array $data , array $options )
Renders an element and fires the before and afterRender callbacks for it and writes to the cache if a cache is used
$file
$data
$options
addScript( string $name , string $content null )
Adds a script block or other element to be inserted in $scripts_for_layout in the <head />
of a document layout
$name
Either the key name for the script, or the script content. Name can be used to update/replace a script element.
$content
optional null append( string $name , mixed $value null )
Append to an existing or new block. Appending to a new block will create the block.
$name
$value
optional null assign( string $name , mixed $value )
Set the content for a block. This will overwrite any existing content.
$name
$value
blocks( )
Get the names of all the existing blocks.
element( string $name , array $data array() , array $options array() )
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.
$name
Name of template file in the/app/View/Elements/ 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.
$data
optional array() $options
optional array() Array of options. Possible keys are: - cache
- Can either be true
, 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 with element_
- plugin
- (deprecated!) Load an element from a specific plugin. This option is deprecated, and will be removed in CakePHP 3.0. Use Plugin.element_name
instead. - 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 trigger notices.
elementExists( string $name )
Checks if an element exists
$name
Name of template file in the /app/View/Elements/ 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.
end( )
End a capturing block. The compliment to View::start()
exists( string $name )
Check if a block exists
$name
extend( string $name )
Provides view or element extension/inheritance. Views can extends a parent view and populate blocks in the parent template.
$name
fetch( string $name , string $default '' )
Fetch the content for a block. If a block is empty or undefined '' will be returned.
$name
$default
optional '' get( string $var , mixed $default null )
Returns the contents of the given View variable.
$var
$default
optional null getEventManager( )
Returns the CakeEventManager manager instance that is handling any callbacks. You can use this instance to register any new listeners or callbacks to the controller events, or create your own events and trigger them at will.
CakeEventManager
getVar( string $var )
Returns the contents of the given View variable(s)
$var
getVars( )
Returns a list of variables available in the current View context
loadHelper( string $helperName , array $settings array() )
Loads a helper. Delegates to the HelperCollection::load()
to load the helper
$helperName
$settings
optional array() Helper
pluginSplit( string $name , boolean $fallback true )
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
$name
$fallback
optional true prepend( string $name , mixed $value null )
Prepend to an existing or new block. Prepending to a new block will create the block.
$name
$value
optional null renderCache( string $filename , string $timeStart )
Render cached view. Works in concert with CacheHelper and Dispatcher to render cached view files.
$filename
$timeStart
renderLayout( string $content , string $layout null )
Renders a layout. Returns output from _render(). Returns false on error. Several variables are created for use in layout.
title_for_layout
- A backwards compatible place holder, you should set this value if you want more control.content_for_layout
- contains rendered view filescripts_for_layout
- Contains content added with addScript() as well as any content in the 'meta', 'css', and 'script' blocks. They are appended in that order.Deprecated features:
$scripts_for_layout
is deprecated and will be removed in CakePHP 3.0. Use the block features instead. meta
, css
and script
will be populated by the matching methods on HtmlHelper.$title_for_layout
is deprecated and will be removed in CakePHP 3.0. Use the title
block instead.$content_for_layout
is deprecated and will be removed in CakePHP 3.0. Use the content
block instead.$content
$layout
optional null CakeException
set( string|array $one , string|array $two null )
Allows a template or element to set a variable that will be available in a layout or other element. Analogous to Controller::set().
$one
$two
optional null Value in case $one is a string (which then works as the key). Unused if $one is an associative array, otherwise serves as the values to $one's keys.
start( string $name )
Start capturing output for a 'block'
$name
startIfEmpty( string $name )
Start capturing output for a 'block' if it has no content
$name
uuid( string $object , string $url )
Generates a unique, non-random DOM ID for an object, based on the object type and the target URL.
$object
$url
_mergeVars( array $properties , string $class , boolean $normalize true )
Merges this objects $property with the property in $class' definition. This classes value for the property will be merged on top of $class'
This provides some of the DRY magic CakePHP provides. If you want to shut it off, redefine this method as an empty function.
$properties
$class
$normalize
optional true _set( array $properties array() )
Allows setting of multiple properties of the object in a single line of code. Will only set properties that are part of a class declaration.
$properties
optional array() _stop( integer|string $status 0 )
Stop execution of the current script. Wraps exit() making testing easier.
$status
optional 0 dispatchMethod( string $method , array $params array() )
Calls a method on this object with the given parameters. Provides an OO wrapper for call_user_func_array
$method
$params
optional array() log( string $msg , integer $type LOG_ERR , null|string|array $scope null )
Convenience method to write a message to CakeLog. See CakeLog::write() for more information on writing to logs.
$msg
$type
optional LOG_ERR $scope
optional null The scope(s) a log message is being created in. See CakeLog::config() for more information on logging scopes.
requestAction( string|array $url , array $extra array() )
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()
POST and GET data can be simulated in requestAction. Use $extra['url']
for GET data. The $extra['data']
parameter allows POST data simulation.
$url
String or array-based URL. Unlike other URL arrays in CakePHP, this URL will not automatically handle passed and named arguments in the $url parameter.
$extra
optional array() if array includes the key "return" it sets the AutoRender to true. Can also be used to submit GET/POST data, and named/passed arguments.
Boolean true or false on success/failure, or contents of rendered action if 'return' is set in $extra.
toString( )
Object-to-string conversion. Each class can override this method as necessary.
public string
JSON views are always located in the 'json' sub directory for controllers' views.
'json'
© 2005–2016 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.
http://api.cakephp.org/2.8/class-JsonView.html