mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-16 00:48:54 +00:00
Update docs, add Yaf_View_Simple::clear()
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@324803 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Xinchen Hui
parent
ee73d00557
commit
4feac54e42
4 changed files with 109 additions and 5 deletions
|
|
@ -283,6 +283,7 @@
|
|||
<function name='yaf_config_simple::offsetexists' from='PECL yaf >=1.0.0'/>
|
||||
<function name='yaf_config_simple::offsetset' from='PECL yaf >=1.0.0'/>
|
||||
<function name='yaf_view_interface::assign' from='PECL yaf >=1.0.0'/>
|
||||
<function name='yaf_view_interface::clear' from='PECL yaf >=2.1.11'/>
|
||||
<function name='yaf_view_interface::display' from='PECL yaf >=1.0.0'/>
|
||||
<function name='yaf_view_interface::render' from='PECL yaf >=1.0.0'/>
|
||||
<function name='yaf_view_interface::setscriptpath' from='PECL yaf >=1.0.0'/>
|
||||
|
|
|
|||
|
|
@ -95,7 +95,7 @@ class IndexController extends Yaf_Controller_Abstract {
|
|||
&reftitle.seealso;
|
||||
<simplelist>
|
||||
<member><methodname>Yaf_View_Simple::assignRef</methodname></member>
|
||||
<member><methodname>Yaf_View_Interface::assign</methodname></member>
|
||||
<member><methodname>Yaf_View_Interface::clear</methodname></member>
|
||||
<member><methodname>Yaf_View_Simple::__set</methodname></member>
|
||||
</simplelist>
|
||||
</refsect1>
|
||||
|
|
|
|||
96
reference/yaf/yaf_view_simple/clear.xml
Normal file
96
reference/yaf/yaf_view_simple/clear.xml
Normal file
|
|
@ -0,0 +1,96 @@
|
|||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<!-- $Revision: 320078 $ -->
|
||||
|
||||
<refentry xml:id="yaf-view-simple.clear" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
||||
<refnamediv>
|
||||
<refname>Yaf_View_Simple::clear</refname>
|
||||
<refpurpose>Clear Assigned values</refpurpose>
|
||||
</refnamediv>
|
||||
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<modifier>public</modifier> <type>bool</type><methodname>Yaf_View_Simple::clear</methodname>
|
||||
<methodparam choice="opt"><type>string</type><parameter>name</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
&warn.undocumented.func;
|
||||
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>name</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
assigned variable name
|
||||
</para>
|
||||
<para>
|
||||
if empty, will clear all assigned variables
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="examples">
|
||||
&reftitle.examples;
|
||||
<example>
|
||||
<title><function>Yaf_View_Simple::clear</function>example</title>
|
||||
<programlisting role="php">
|
||||
<![CDATA[
|
||||
<?php
|
||||
class IndexController extends Yaf_Controller_Abstract {
|
||||
public function indexAction() {
|
||||
$this->getView()->clear("foo")->clear("bar"); // clear "foo" and "bar"
|
||||
$this->_view->clear(); //clear all assigned variables
|
||||
}
|
||||
?>
|
||||
]]>
|
||||
</programlisting>
|
||||
</example>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="seealso">
|
||||
&reftitle.seealso;
|
||||
<simplelist>
|
||||
<member><methodname>Yaf_View_Simple::assignRef</methodname></member>
|
||||
<member><methodname>Yaf_View_Interface::assign</methodname></member>
|
||||
<member><methodname>Yaf_View_Simple::__set</methodname></member>
|
||||
</simplelist>
|
||||
</refsect1>
|
||||
|
||||
</refentry>
|
||||
|
||||
<!-- Keep this comment at the end of the file
|
||||
Local variables:
|
||||
mode: sgml
|
||||
sgml-omittag:t
|
||||
sgml-shorttag:t
|
||||
sgml-minimize-attributes:nil
|
||||
sgml-always-quote-attributes:t
|
||||
sgml-indent-step:1
|
||||
sgml-indent-data:t
|
||||
indent-tabs-mode:nil
|
||||
sgml-parent-document:nil
|
||||
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
|
||||
sgml-exposed-tags:nil
|
||||
sgml-local-catalogs:nil
|
||||
sgml-local-ecat-files:nil
|
||||
End:
|
||||
vim600: syn=xml fen fdm=syntax fdl=2 si
|
||||
vim: et tw=78 syn=sgml
|
||||
vi: ts=1 sw=1
|
||||
-->
|
||||
|
|
@ -4,17 +4,21 @@
|
|||
<refentry xml:id="yaf-view-simple.get" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
||||
<refnamediv>
|
||||
<refname>Yaf_View_Simple::__get</refname>
|
||||
<refpurpose>The __get purpose</refpurpose>
|
||||
<refpurpose>Retrieve assigned variable</refpurpose>
|
||||
</refnamediv>
|
||||
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<modifier>public</modifier> <type>void</type><methodname>Yaf_View_Simple::__get</methodname>
|
||||
<methodparam><type>string</type><parameter>name</parameter></methodparam>
|
||||
<methodparam choice="opt"><type>string</type><parameter>name</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
|
||||
<note>
|
||||
<para>
|
||||
parameter can be empty since 2.1.11
|
||||
</para>
|
||||
</note>
|
||||
</para>
|
||||
|
||||
&warn.undocumented.func;
|
||||
|
|
@ -28,7 +32,10 @@
|
|||
<term><parameter>name</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
|
||||
the assigned variable name
|
||||
</para>
|
||||
<para>
|
||||
if this is empty, all assigned variables will be returned
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
|
|
|||
Loading…
Reference in a new issue