Class ScaffoldView
Theme view class
Copyright: Copyright 2005-2012, Cake Software Foundation, Inc. (http://cakefoundation.org)
License: The MIT License
Location: controller/scaffold.php
Inherited Properties
-
themeElement,themeLayout,themePath__passedVars,__paths,__scripts,action,association,autoLayout,autoRender,base,cacheAction,data,ext,field,fieldSuffix,hasRendered,helpers,here,layout,layoutPath,loaded,model,modelId,modelScope,name,output,pageTitle,params,passedArgs,plugin,subDir,themeWeb,uuids,validationErrors,viewPath,viewVars_log
Method Summary
-
_getViewFileName() public
Override _getViewFileName
Method Detail
_getViewFileName() public ¶
_getViewFileName( string $name = null )
Override _getViewFileName
Parameters
- string $name optional null
- $action Controller action to find template filename for
Returns
action
Overrides
Methods inherited from ThemeView
__construct() public ¶
__construct( unknown_type $controller , $register = true )
Enter description here...
Parameters
- unknown_type $controller
- $register optional true
Returns
Overrides
Methods inherited from View
_getLayoutFileName() public ¶
_getLayoutFileName( $name = null )
Returns layout filename for this template as a string.
Returns
Filename for layout file (.ctp).
_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
_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 , $loadHelpers = true , $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
- $loadHelpers optional true
- $cached optional false
Returns
Rendered output
_triggerHelpers() public ¶
_triggerHelpers( string $callback )
Fire a callback on all loaded Helpers
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
Parameters
- string $name
- string $content optional null
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.
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) Special params: cache - enable caching for this element accepts boolean or strtotime compatible string. Can also be an array if an array,'time' is used to specify duration of cache. 'key' can be used to create unique cache files.
- $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
getVars() public ¶
getVars( )
Returns a list of variables available in the current View context
Returns
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
Parameters
- string $filename
- the cache file to include
- string $timeStart
- the page render start time
renderElement() public deprecated ¶
renderElement( $name , $params = array() , $loadHelpers = false )
Deprecated
See
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 - contains page title content_for_layout - contains rendered view file scripts_for_layout - contains scripts added to header cakeDebug - if debug is on, cake debug information is added.
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.