From 4feac54e42aaa65a6b1c1e8cb434c2a624e9e1e5 Mon Sep 17 00:00:00 2001 From: Xinchen Hui Date: Wed, 4 Apr 2012 14:51:51 +0000 Subject: [PATCH] Update docs, add Yaf_View_Simple::clear() git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@324803 c90b9560-bf6c-de11-be94-00142212c4b1 --- reference/yaf/versions.xml | 1 + reference/yaf/yaf_view_simple/assign.xml | 2 +- reference/yaf/yaf_view_simple/clear.xml | 96 ++++++++++++++++++++++++ reference/yaf/yaf_view_simple/get.xml | 15 +++- 4 files changed, 109 insertions(+), 5 deletions(-) create mode 100644 reference/yaf/yaf_view_simple/clear.xml diff --git a/reference/yaf/versions.xml b/reference/yaf/versions.xml index 640195cb42..cc4fbaa184 100644 --- a/reference/yaf/versions.xml +++ b/reference/yaf/versions.xml @@ -283,6 +283,7 @@ + diff --git a/reference/yaf/yaf_view_simple/assign.xml b/reference/yaf/yaf_view_simple/assign.xml index e363913769..27a931ab13 100644 --- a/reference/yaf/yaf_view_simple/assign.xml +++ b/reference/yaf/yaf_view_simple/assign.xml @@ -95,7 +95,7 @@ class IndexController extends Yaf_Controller_Abstract { &reftitle.seealso; Yaf_View_Simple::assignRef - Yaf_View_Interface::assign + Yaf_View_Interface::clear Yaf_View_Simple::__set diff --git a/reference/yaf/yaf_view_simple/clear.xml b/reference/yaf/yaf_view_simple/clear.xml new file mode 100644 index 0000000000..17fdee23d8 --- /dev/null +++ b/reference/yaf/yaf_view_simple/clear.xml @@ -0,0 +1,96 @@ + + + + + + Yaf_View_Simple::clear + Clear Assigned values + + + + &reftitle.description; + + public boolYaf_View_Simple::clear + stringname + + + + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + + + name + + + assigned variable name + + + if empty, will clear all assigned variables + + + + + + + + &reftitle.returnvalues; + + + + + + + &reftitle.examples; + + <function>Yaf_View_Simple::clear</function>example + +getView()->clear("foo")->clear("bar"); // clear "foo" and "bar" + $this->_view->clear(); //clear all assigned variables + } +?> +]]> + + + + + + &reftitle.seealso; + + Yaf_View_Simple::assignRef + Yaf_View_Interface::assign + Yaf_View_Simple::__set + + + + + + diff --git a/reference/yaf/yaf_view_simple/get.xml b/reference/yaf/yaf_view_simple/get.xml index bc7e3030fc..27bb1aa133 100644 --- a/reference/yaf/yaf_view_simple/get.xml +++ b/reference/yaf/yaf_view_simple/get.xml @@ -4,17 +4,21 @@ Yaf_View_Simple::__get - The __get purpose + Retrieve assigned variable &reftitle.description; public voidYaf_View_Simple::__get - stringname + stringname - + + + parameter can be empty since 2.1.11 + + &warn.undocumented.func; @@ -28,7 +32,10 @@ name - + the assigned variable name + + + if this is empty, all assigned variables will be returned