adulau/cakephp2-php8
1
0
Fork 0
mirror of https://github.com/kamilwylegala/cakephp2-php8.git synced 2025-02-07 12:36:25 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Adding documentation to doc-blocks for View

Browse source 
git-svn-id: https://svn.cakephp.org/repo/branches/1.2.x.x@7425 3807eeeb-6ff5-0310-8944-8be069107fe0
This commit is contained in:
mark_story 2008-08-03 05:24:10 +00:00
parent eb02ec4ca9
commit d9de0c6cd5
1 changed files with 11 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
cake/libs/view/view.php
View file

@ -280,10 +280,14 @@ class View extends Object {
* *
* This realizes the concept of Elements, (or "partial layouts") * This realizes the concept of Elements, (or "partial layouts")
* and the $params array is used to send data to be used in the * and the $params array is used to send data to be used in the
* Element. * Element. Elements can be cached through use of the cache key.
* *
* @param string $name Name of template file in the/app/views/elements/ folder * @param string $name Name of template file in the/app/views/elements/ folder
* @param array $params Array of data to be made available to the for rendered view (i.e. the Element) * @param array $params 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.
*
* @return string Rendered Element * @return string Rendered Element
* @access public * @access public
*/ */
@ -392,6 +396,11 @@ class View extends Object {
} }
/** /**
* Renders a layout. Returns output from _render(). Returns false on error. * 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.
* *
* @param string $content_for_layout Content to render in a view, wrapped by the surrounding layout. * @param string $content_for_layout Content to render in a view, wrapped by the surrounding layout.
* @return mixed Rendered output, or false on error * @return mixed Rendered output, or false on error
@ -521,6 +530,7 @@ class View extends Object {
* *
* @param string $name * @param string $name
* @param string $content * @param string $content
* @return void
* @access public * @access public
*/ */
function addScript($name, $content = null) { function addScript($name, $content = null) {