Class XmlView

A view class that is used for creating XML responses.

By setting the '_serialize' key in your controller, you can specify a view variable that should be serialized to XML and used as the response for the request. This allows you to omit views + layouts, if your just need to emit a single view variable as the XML 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 XML.

Note The view variable you specify must be compatible with Xml::fromArray().

You can also define '_serialize' as an array. This will create an additional top level element named <response> containing all the named view variables:

$this->set(compact('posts', 'users', 'stuff'));
$this->set('_serialize', array('posts', 'users'));

The above would generate a XML object that looks like:

<response><posts>...</posts><users>...</users></response>

If you don't use the _serialize key, you will need a view. You can use extended views to provide layout like functionality.

Object

View

XmlView

Package: Cake\View
Since: CakePHP(tm) v 2.1.0
Copyright: Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
License: MIT License
Location: Cake/View/XmlView.php

Inherited Constants

TYPE_ELEMENT, TYPE_LAYOUT, TYPE_VIEW

Properties summary

$subDir public

string

The subdirectory. XML views are always in xml.

Inherited Magic Properties

Blocks, Cache, Form, Html, Js, Number, Paginator, Rss, Session, Text, Time

Inherited Properties

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

Method Summary

__construct() public

Constructor
_serialize() protected

Serialize view vars.
loadHelpers() public

Skip loading helpers if this is a _serialize based view.
render() public

Render a XML view.

Method Detail

__construct() public ¶

__construct( Controller $controller = null )

Constructor

Parameters

Controller $controller optional null: Controller instance.

Overrides

View::__construct()

_serialize() protected ¶

_serialize( array $serialize )

Serialize view vars.

Special parameters

_xmlOptions You can set an array of custom options for Xml::fromArray() this way, e.g. 'format' as 'attributes' instead of 'tags'.

Parameters

array $serialize: The viewVars that need to be serialized.

Returns

string
The serialized data

loadHelpers() public ¶

loadHelpers( )

Skip loading helpers if this is a _serialize based view.

Overrides

View::loadHelpers()

render() public ¶

render( string $view = null , string $layout = null )

Render a XML view.

Uses the special '_serialize' parameter to convert a set of view variables into a XML response. Makes generating simple XML responses very easy. You can omit the '_serialize' parameter, and use a normal view + layout as well.

Parameters

string $view optional null: The view being rendered.
string $layout optional null: The layout being rendered.

Returns

string
The rendered view.

Throws

CakeException
If there is an error in the view.

Overrides

View::render()

Methods inherited from View

__get() public ¶

__get( string $name )

Magic accessor for helpers. Provides access to attributes that were deprecated.

Parameters

string $name: Name of the attribute to get.

Returns

mixed

__isset() public ¶

__isset( string $name )

Magic isset check for deprecated attributes.

Parameters

string $name: Name of the attribute to check.

Returns

boolean

__set() public ¶

__set( string $name , mixed $value )

Magic accessor for deprecated attributes.

Parameters

string $name: Name of the attribute to set.
mixed $value: Value of the attribute to set.

Returns

mixed

_elementCache() protected ¶

_elementCache( string $name , string $data , array $options )

Checks if an element is cached and returns the cached data if present

Parameters

string $name: Element name
string $data: Data
array $options: Element options

Returns

string|null

_evaluate() protected ¶

_evaluate( string $viewFile , array $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. If empty the current View::$viewVars will be used.

Returns

string
Rendered output

_getElementFileName() protected ¶

_getElementFileName( string $name )

Finds an element filename, returns false on failure.

Parameters

string $name: The name of the element to find.

Returns

mixed
Either a string to the element filename or false when one can't be found.

_getExtensions() protected ¶

_getExtensions( )

Get the extensions that view files can use.

Returns

array
Array of extensions view files use.

_getLayoutFileName() protected ¶

_getLayoutFileName( string $name = null )

Returns layout filename for this template as a string.

Parameters

string $name optional null: The name of the layout to find.

Returns

string
Filename for layout file (.ctp).

Throws

MissingLayoutException
when a layout cannot be located

_getViewFileName() protected ¶

_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.

Parameters

string $name optional null: Controller action to find template filename for

Returns

string
Template filename

Throws

MissingViewException
when a view file could not be found.

_paths() protected ¶

_paths( string $plugin = null , boolean $cached = true )

Return all possible paths to find view files in order

Parameters

string $plugin optional null: Optional plugin name to scan for view files.
boolean $cached optional true: Set to false to force a refresh of view paths. Default true.

Returns

array
paths

_render() protected ¶

_render( string $viewFile , array $data = array() )

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

Parameters

string $viewFile: Filename of the view
array $data optional array(): Data to include in rendered view. If empty the current View::$viewVars will be used.

Returns

string
Rendered output

Throws

CakeException
when a block is left open.

Triggers

View.beforeRenderFile $this, array($viewFile)
View.afterRenderFile $this, array($viewFile, $content)

_renderElement() protected ¶

_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

Parameters

string $file: Element file path
array $data: Data to render
array $options: Element options

Returns

string

Triggers

View.beforeRender $this, array($file)
View.afterRender $this, array($file, $element)

addScript() public deprecated ¶

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

Deprecated

3.0.0 Will be removed in 3.0. Superseded by blocks functionality.

Parameters

string $name: Either the key name for the script, or the script content. Name can be used to update/replace a script element.
string $content optional null: The content of the script being added, optional.

See

View::start()

append() public ¶

append( string $name , mixed $value = null )

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 null: The content for the block.

See

ViewBlock::concat()

assign() public ¶

assign( string $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.

See

ViewBlock::set()

blocks() public ¶

blocks( )

Get the names of all the existing blocks.

Returns

array
An array containing the blocks.

See

ViewBlock::keys()

element() public ¶

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.

Parameters

string $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.
array $data optional array(): Array of data to be made available to the rendered view (i.e. the Element)
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.

Returns

string
Rendered Element

elementExists() public ¶

elementExists( string $name )

Checks if an element exists

Parameters

string $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.

Returns

boolean
Success

end() public ¶

end( )

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

See

ViewBlock::end()

extend() public ¶

extend( string $name )

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

Parameters

string $name: The view or element to 'extend' the current one with.

Throws

LogicException
when you extend a view with itself or make extend loops.
LogicException
when you extend an element which doesn't exist

fetch() public ¶

fetch( string $name , string $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
default The block content or $default if the block does not exist.

See

ViewBlock::get()

get() public ¶

get( string $var , mixed $default = null )

Returns the contents of the given View variable.

Parameters

string $var: The view var you want the contents of.
mixed $default optional null: 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 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.

Returns

CakeEventManager

getVar() public deprecated ¶

getVar( string $var )

Returns the contents of the given View variable(s)

Deprecated

3.0.0 Will be removed in 3.0. Use View::get() instead.

Parameters

string $var: The view var you want the contents of.

Returns

mixed
The content of the named var if its set, otherwise null.

getVars() public ¶

getVars( )

Returns a list of variables available in the current View context

Returns

array
Array of the set view variable names.

loadHelper() public ¶

loadHelper( string $helperName , array $settings = array() )

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

Parameters

string $helperName: Name of the helper to load.
array $settings optional array(): Settings for the helper

Returns

Helper
a constructed helper object.

See

HelperCollection::load()

pluginSplit() public ¶

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

Parameters

string $name: The name you want to plugin split.
boolean $fallback optional true: If true uses the plugin set in the current CakeRequest when parsed plugin is not loaded

Returns

array
Array with 2 indexes. 0 => plugin name, 1 => filename

prepend() public ¶

prepend( string $name , mixed $value = null )

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 optional null: The content for the block.

See

ViewBlock::concat()

renderCache() public ¶

renderCache( string $filename , string $timeStart )

Render cached view. Works in concert with CacheHelper and Dispatcher to render cached view files.

Parameters

string $filename: the cache file to include
string $timeStart: the page render start time

Returns

boolean
Success of rendering the cached file.

renderLayout() public ¶

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 file
scripts_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.

Parameters

string $content: Content to render in a view, wrapped by the surrounding layout.
string $layout optional null: Layout name

Returns

mixed
Rendered output, or false on error

Throws

CakeException
if there is an error in the view.

Triggers

View.beforeLayout $this, array($layoutFileName)
View.afterLayout $this, array($layoutFileName)

set() public ¶

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().

Parameters

string|array $one: A string or an array of data.
string|array $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() public ¶

start( string $name )

Start capturing output for a 'block'

Parameters

string $name: The name of the block to capture for.

See

ViewBlock::start()

startIfEmpty() public ¶

startIfEmpty( string $name )

Start capturing output for a 'block' if it has no content

Parameters

string $name: The name of the block to capture for.

See

ViewBlock::startIfEmpty()

uuid() public ¶

uuid( string $object , string $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

Methods inherited from Object

_mergeVars() protected ¶

_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.

Parameters

array $properties: The name of the properties to merge.
string $class: The class to merge the property with.
boolean $normalize optional true: Set to true to run the properties through Hash::normalize() before merging.

_set() protected ¶

_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.

Parameters

array $properties optional array(): An associative array containing properties and corresponding values.

_stop() protected ¶

_stop( integer|string $status = 0 )

Stop execution of the current script. Wraps exit() making testing easier.

Parameters

integer|string $status optional 0: see http://php.net/exit for values

dispatchMethod() public ¶

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

Parameters

string $method: Name of the method to call
array $params optional array(): Parameter list to use when calling $method

Returns

mixed
Returns the result of the method call

log() public ¶

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.

Parameters

string $msg: Log message
integer $type optional LOG_ERR: Error type constant. Defined in app/Config/core.php.
null|string|array $scope optional null: The scope(s) a log message is being created in. See CakeLog::config() for more information on logging scopes.

Returns

boolean
Success of log write

requestAction() public ¶

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()

Passing POST and GET data

POST and GET data can be simulated in requestAction. Use $extra['url'] for GET data. The $extra['data'] parameter allows POST data simulation.

Parameters

string|array $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.
array $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.

Returns

mixed

Boolean true or false on success/failure, or contents of rendered action if 'return' is set in $extra.

toString() public ¶

toString( )

Object-to-string conversion. Each class can override this method as necessary.

Returns

string
The name of this class

Properties detail

`$subDir` ¶

public string

The subdirectory. XML views are always in xml.

'xml'

Packages

Classes

Class XmlView

Inherited Constants

Properties summary

Inherited Magic Properties

Inherited Properties

Method Summary

__construct() public

_serialize() protected

loadHelpers() public

render() public

Method Detail

__construct() public ¶

Parameters

Overrides

_serialize() protected ¶

Special parameters

Parameters

Returns

loadHelpers() public ¶

Overrides

render() public ¶

Parameters

Returns

Throws

Overrides

Methods inherited from View

__get() public ¶

Parameters

Returns

__isset() public ¶

Parameters

Returns

__set() public ¶

Parameters

Returns

_elementCache() protected ¶

Parameters

Returns

_evaluate() protected ¶

Parameters

Returns

_getElementFileName() protected ¶

Parameters

Returns

_getExtensions() protected ¶

Returns

_getLayoutFileName() protected ¶

Parameters

Returns

Throws

_getViewFileName() protected ¶

Parameters

Returns

Throws

_paths() protected ¶

Parameters

Returns

_render() protected ¶

Parameters

Returns

Throws

Triggers

_renderElement() protected ¶

Parameters

Returns

Triggers

addScript() public deprecated ¶

Deprecated

Parameters

See

append() public ¶

Parameters

See

assign() public ¶

Parameters

See

blocks() public ¶

Returns