Class ThemeView
Theme view class
Allows the creation of multiple themes to be used in an app. Theme views are regular view files
that can provide unique HTML and static assets. If theme views are not found for the current view
the default app view files will be used. You can set $this->theme and $this->view = 'Theme'
in your Controller to use the ThemeView.
Example of theme path with $this->theme = 'super_hot'; Would be app/views/themed/super_hot/posts
Direct Subclasses
Copyright: Copyright 2005-2012, Cake Software Foundation, Inc. (http://cakefoundation.org)
License: License (http://www.opensource.org/licenses/mit-license.php)
Location: view/theme.php
Inherited Properties
-
__passedVars,__paths,__scripts,action,association,autoLayout,autoRender,base,cacheAction,data,ext,field,fieldSuffix,hasRendered,helpers,here,layout,layoutPath,loaded,model,modelId,modelScope,name,output,params,passedArgs,plugin,subDir,theme,uuids,validationErrors,viewPath,viewVars
Method Summary
-
__construct() public
Constructor for ThemeView sets $this->theme. -
_paths() public
Return all possible paths to find view files in order
Method Detail
__construct() public ¶
__construct( Controller $controller , boolean $register = true )
Constructor for ThemeView sets $this->theme.
Parameters
-
Controller$controller - Controller object to be rendered.
- boolean $register optional true
- Should the view be registered in the registry.
Returns
Overrides
_paths() public ¶
_paths( string $plugin = null , boolean $cached = true )
Return all possible paths to find view files in order
Parameters
- string $plugin optional null
- The name of the plugin views are being found for.
- boolean $cached optional true
- Set to true to force dir scan.
Returns
paths
Overrides
Methods inherited from View
_getExtensions() public ¶
_getExtensions( )
Get the extensions that view files can use.
Returns
Array of extensions view files use.
_getLayoutFileName() public ¶
_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).
_getViewFileName() public ¶
_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
_loadHelpers() public ¶
_loadHelpers( array $loaded , array $helpers , string $parent = null )
Loads helpers, with their dependencies.
Parameters
- array $loaded
- List of helpers that are already loaded.
- array $helpers
- List of helpers to load.
- string $parent optional null
- holds name of helper, if loaded helper has helpers
Returns
Array containing the loaded helpers.
_missingView() public ¶
_missingView( string $file , $error = 'missingView' )
Return a misssing view error message
Parameters
- string $file
- $viewFileName the filename that should exist
- $error optional 'missingView'
Returns
_render() public ¶
_render( string $___viewFn , array $___dataForView , boolean $loadHelpers = true , boolean $cached = false )
Renders and returns output for given view filename with its array of data.
Parameters
- string $___viewFn
- Filename of the view
- array $___dataForView
- Data to include in rendered view
- boolean $loadHelpers optional true
- Boolean to indicate that helpers should be loaded.
- boolean $cached optional false
- Whether or not to trigger the creation of a cache file.
Returns
Rendered output
_triggerHelpers() public ¶
_triggerHelpers( string $callback )
Fire a callback on all loaded Helpers. All helpers must implement this method, it is not checked before being called. You can add additional helper callbacks in AppHelper.
Parameters
- string $callback
- name of callback fire.
addScript() public ¶
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.
element() public ¶
element( string $name , array $params = array() , $loadHelpers = false )
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 through use of the cache key.
Special params
cache- enable caching for this element accepts boolean or strtotime compatible string. Can also be an array. Ifcacheis an array,timeis used to specify duration of cache.keycan be used to create unique cache files.plugin- Load an element from a specific plugin.
Parameters
- string $name
- Name of template file in the/app/views/elements/ folder
- array $params optional array()
Array of data to be made available to the for rendered view (i.e. the Element)
- $loadHelpers optional false
Returns
Rendered Element
entity() public ¶
entity( )
Returns the entity reference of the current context as an array of identity parts
Returns
An array containing the identity elements of an entity
error() public ¶
error( integer $code , string $name , string $message )
Displays an error page to the user. Uses layouts/error.ctp to render the page.
Parameters
- integer $code
- HTTP Error code (for instance: 404)
- string $name
- Name of the error (for instance: Not Found)
- string $message
- Error message as a web page
getVar() public ¶
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.
render() public ¶
render( string $action = null , string $layout = null , string $file = null )
Renders view for given action and layout. If $file is given, that is used for a view filename (e.g. customFunkyView.ctp).
Parameters
- string $action optional null
- Name of action to render for
- string $layout optional null
- Layout to use
- string $file optional null
- Custom filename for view
Returns
Rendered Element
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_for_layout , $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 scripts added to header
Parameters
- string $content_for_layout
- Content to render in a view, wrapped by the surrounding layout.
- $layout optional null
Returns
Rendered output, or false on error
set() public ¶
set( mixed $one , mixed $two = null )
Allows a template or element to set a variable that will be available in a layout or other element. Analagous to Controller::set.
Parameters
- mixed $one
- A string or an array of data.
- mixed $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.
Methods inherited from Object
Object() public ¶
Object( )
A hack to support __construct() on PHP 4 Hint: descendant classes have no PHP4 class_name() constructors, so this constructor gets called first and calls the top-layer __construct() which (if present) should call parent::__construct()
Returns
__openPersistent() public ¶
__openPersistent( string $name , string $type = null )
Open the persistent class file for reading Used by Object::_persist()
Parameters
- string $name
- Name of persisted class
- string $type optional null
- Type of persistance (e.g: registry)
_persist() public ¶
_persist( string $name , string $return , $object , $type = null )
Checks for a persistent class file, if found file is opened and true returned If file is not found a file is created and false returned If used in other locations of the model you should choose a unique name for the persistent file There are many uses for this method, see manual for examples
Parameters
- string $name
- name of the class to persist
- string $return
- $object the object to persist
- $object
- $type optional null
Returns
Success
_savePersistent() public ¶
_savePersistent( string $name , object $object )
You should choose a unique name for the persistent file
There are many uses for this method, see manual for examples
Parameters
- string $name
- name used for object to cache
- object $object
- the object to persist
Returns
true on save, throws error if file can not be created
_set() public ¶
_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() public ¶
_stop( $status = 0 )
Stop execution of the current script. Wraps exit() making testing easier.
Parameters
- $status optional 0
- http://php.net/exit for values
cakeError() public ¶
cakeError( string $method , array $messages = array() )
Used to report user friendly errors. If there is a file app/error.php or app/app_error.php this file will be loaded error.php is the AppError class it should extend ErrorHandler class.
Parameters
- string $method
- Method to be called in the error class (AppError or ErrorHandler classes)
- array $messages optional array()
- Message that is to be displayed by the error class
Returns
message
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_ERROR )
Convience 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_ERROR
- Error type constant. Defined in app/config/core.php.
Returns
Success of log write
requestAction() public ¶
requestAction( mixed $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.
Parameters
- mixed $url
- String or array-based url.
- array $extra optional array()
- if array includes the key "return" it sets the AutoRender to true.
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