Class ThemeView
Theme view class
Stub class for 2.1 Compatibility
Deprecated: Deprecated since 2.1, use View class instead
Copyright: Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
License: MIT License
Location: Cake/View/ThemeView.php
Inherited Constants
Inherited Magic Properties
Inherited Properties
-
Blocks,Helpers,_current,_currentType,_eventManager,_eventManagerConfigured,_parents,_passedVars,_paths,_scripts,_stack,autoLayout,cacheAction,elementCache,elementCacheSettings,ext,hasRendered,helpers,layout,layoutPath,name,passedArgs,plugin,request,response,subDir,theme,uuids,validationErrors,view,viewPath,viewVars
Methods inherited from View
__construct() public ¶
__construct( Controller $controller = null )
Constructor
Parameters
-
Controller$controller optional null - A controller object to pull View::_passedVars from.
Overrides
__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
__isset() public ¶
__isset( string $name )
Magic isset check for deprecated attributes.
Parameters
- string $name
- Name of the attribute to check.
Returns
__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
_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
_evaluate() protected ¶
_evaluate( string $viewFile , array $dataForView )
Sandbox method to evaluate a template / view script in.
Parameters
- string $viewFile
- $viewFn Filename of the view
- array $dataForView
Data to include in rendered view. If empty the current View::$viewVars will be used.
Returns
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
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 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
Filename for layout file (.ctp).
Throws
_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
Template filename
Throws
_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
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
Rendered output
Throws
_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
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
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
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
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
blocks() public ¶
blocks( )
Get the names of all the existing blocks.
Returns
An array containing the blocks.
See
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.templateto 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 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_-plugin- (deprecated!) Load an element from a specific plugin. This option is deprecated, and will be removed in CakePHP 3.0. UsePlugin.element_nameinstead. -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
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.templateto check the template element from MyPlugin. If the element is not found in the plugin, the normal view path cascade will be searched.
Returns
Success
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
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
$default The block content or $default if the block does not exist.
See
get() public ¶
get( string $var )
Returns the contents of the given View variable or a block. Blocks are checked before view variables.
Parameters
- string $var
- The view var you want the contents of.
Returns
The content of the named var if its set, otherwise null.
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
getVar() public deprecated ¶
getVar( string $var )
Returns the contents of the given View variable(s)
Parameters
- string $var
- The view var you want the contents of.
Returns
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 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
See
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 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
render() public ¶
render( string $view = null , string $layout = null )
Renders view for given view file and layout.
Render triggers helper callbacks, which are fired before and after the view are rendered, as well as before and after the layout. The helper callbacks are called:
beforeRenderafterRenderbeforeLayoutafterLayout
If View::$autoRender is false and no $layout is provided, the view will be returned bare.
View and layout names can point to plugin views/layouts. Using the Plugin.view syntax
a plugin view/layout can be used instead of the app ones. If the chosen plugin is not found
the view will be located along the regular view path cascade.
Parameters
- string $view optional null
- Name of view file to use
- string $layout optional null
- Layout to use.
Returns
Rendered content or null if content already rendered and returned earlier.
Throws
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
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 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_layoutis deprecated and will be removed in CakePHP 3.0. Use the block features instead.meta,cssandscriptwill be populated by the matching methods on HtmlHelper.$title_for_layoutis deprecated and will be removed in CakePHP 3.0$content_for_layoutis deprecated and will be removed in CakePHP 3.0. Use thecontentblock instead.
Parameters
- string $content
- Content to render in a view, wrapped by the surrounding layout.
- string $layout optional null
- Layout name
Returns
Rendered output, or false on error
Throws
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
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
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
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
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
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
The name of this class