cvs: peardoc /en/package/html html-template-sigma.xml /en/package/html/html-template-sigma/html-template-sigma get.xml getblocklist.xml
getplaceholderlist.xml

From: Date: Mon, 19 May 2003 20:16:49 +0000
Subject: cvs: peardoc /en/package/html html-template-sigma.xml /en/package/html/html-template-sigma/html-template-sigma get.xml getblocklist.xml
getplaceholderlist.xml
Groups: php.pear.doc 
Request: Send a blank email to pear-doc+get-830@lists.php.net to get a copy of this message
avb Mon May 19 16:16:49 2003 EDT Added files: /peardoc/en/package/html/html-template-sigma/html-template-sigma getplaceholderlist.xml getblocklist.xml Modified files: /peardoc/en/package/html html-template-sigma.xml /peardoc/en/package/html/html-template-sigma/html-template-sigma get.xml Log: Update docs for 1.0.1

Index: peardoc/en/package/html/html-template-sigma.xml diff -u peardoc/en/package/html/html-template-sigma.xml:1.1 peardoc/en/package/html/html-template-sigma.xml:1.2 --- peardoc/en/package/html/html-template-sigma.xml:1.1 Mon Apr 28 10:22:42 2003 +++ peardoc/en/package/html/html-template-sigma.xml Mon May 19 16:16:48 2003 @@ -22,7 +22,9 @@ &package.html.html-template-sigma.html-template-sigma.blockexists; &package.html.html-template-sigma.html-template-sigma.errormessage; &package.html.html-template-sigma.html-template-sigma.get; +&package.html.html-template-sigma.html-template-sigma.getblocklist; &package.html.html-template-sigma.html-template-sigma.getcurrentblock; +&package.html.html-template-sigma.html-template-sigma.getplaceholderlist; &package.html.html-template-sigma.html-template-sigma.hideblock; &package.html.html-template-sigma.html-template-sigma.loadtemplatefile; &package.html.html-template-sigma.html-template-sigma.parse; Index: peardoc/en/package/html/html-template-sigma/html-template-sigma/get.xml diff -u peardoc/en/package/html/html-template-sigma/html-template-sigma/get.xml:1.1 peardoc/en/package/html/html-template-sigma/html-template-sigma/get.xml:1.2 --- peardoc/en/package/html/html-template-sigma/html-template-sigma/get.xml:1.1 Mon Apr 28 10:21:03 2003 +++ peardoc/en/package/html/html-template-sigma/html-template-sigma/get.xml Mon May 19 16:16:49 2003 @@ -1,4 +1,4 @@ -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <refentry id="package.html.html-template-sigma.html-template-sigma.get"> <refnamediv> <refname><function>HTML_Template_Sigma::get</function></refname> @@ -12,7 +12,7 @@ <funcprototype> <funcdef>string <function>HTML_Template_Sigma::get</function></funcdef> <paramdef>string <parameter> <optional>$block = '__global__'</optional></parameter></paramdef> - <paramdef>bool <parameter> <optional>$clear = true</optional></parameter></paramdef> + <paramdef>bool <parameter> <optional>$clear = false</optional></parameter></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> Index: peardoc/en/package/html/html-template-sigma/html-template-sigma/getplaceholderlist.xml +++ peardoc/en/package/html/html-template-sigma/html-template-sigma/getplaceholderlist.xml <!-- $Revision: 1.1 $ --> <refentry id="package.html.html-template-sigma.html-template-sigma.getplaceholderlist"> <refnamediv> <refname><function>HTML_Template_Sigma::getPlaceholderList</function></refname> <refpurpose>Returns a list of placeholders within a block.</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo> require_once 'HTML/Template/Sigma.php'; </funcsynopsisinfo> <funcprototype> <funcdef>array <function>HTML_Template_Sigma::getPlaceholderList</function></funcdef> <paramdef>string <parameter> <optional>$block = '__global__'</optional></parameter></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.html.html-template-sigma.html-template-sigma.getplaceholderlist.desc"> &title.desc; <para>Returns a list of placeholders within a block.</para> <para>Only 'normal' <link linkend="package.html.html-template-sigma.intro-syntax.placeholder">placeholders</link> are in the list, not ones automatically created for <link linkend="package.html.html-template-sigma.intro-syntax.block">blocks</link> and <link linkend="package.html.html-template-sigma.intro-syntax.callback">template functions</link>.</para> </refsect1> <refsect1 id="package.html.html-template-sigma.html-template-sigma.getplaceholderlist.param"> &title.param; <para> <variablelist> <varlistentry> <term> &type.string; <parameter>$block</parameter> </term> <listitem> <para> block name </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 id="package.html.html-template-sigma.html-template-sigma.getplaceholderlist.return"> &title.returns; <para> <emphasis>return</emphasis> a list of placeholders </para> </refsect1> <refsect1 id="package.html.html-template-sigma.html-template-sigma.getplaceholderlist.see"> &title.see; <para> <emphasis>see</emphasis> <link linkend="package.html.html-template-sigma.html-template-sigma.placeholderexists"><function>HTML_Template_Sigma::placeholderExists</function></link>, <link linkend="package.html.html-template-sigma.html-template-sigma.getblocklist"><function>HTML_Template_Sigma::getBlockList</function></link> </para> </refsect1> <refsect1 id="package.html.html-template-sigma.html-template-sigma.getplaceholderlist.throws"> &title.throws; <para> <table> <title>&title.throws.errortable;</title> <tgroup cols="4"> <thead> <row> <entry>Error code</entry> <entry>Error message</entry> <entry>Reason</entry> <entry>Solution</entry> </row> </thead> <tbody> <row> <entry><constant>SIGMA_BLOCK_NOT_FOUND</constant></entry> <entry>Cannot find block '<parameter>$block</parameter>'</entry> <entry>There is no block <parameter>$block</parameter> in the template</entry> <entry>Check the block name spelling, check whether you added all the necessary blocks to the template</entry> </row> </tbody> </tgroup> </table> </para> </refsect1> <refsect1 id="package.html.html-template-sigma.html-template-sigma.getplaceholderlist.note"> &title.note; &note.notstatic; </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 sgml-parent-document:nil sgml-default-dtd-file:"../../../../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 --> Index: peardoc/en/package/html/html-template-sigma/html-template-sigma/getblocklist.xml +++ peardoc/en/package/html/html-template-sigma/html-template-sigma/getblocklist.xml <!-- $Revision: 1.1 $ --> <refentry id="package.html.html-template-sigma.html-template-sigma.getblocklist"> <refnamediv> <refname><function>HTML_Template_Sigma::getBlockList</function></refname> <refpurpose>Returns a list of blocks within a template.</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo> require_once 'HTML/Template/Sigma.php'; </funcsynopsisinfo> <funcprototype> <funcdef>array <function>HTML_Template_Sigma::getBlockList</function></funcdef> <paramdef>string <parameter> <optional>$parent = '__global__'</optional></parameter></paramdef> <paramdef>bool <parameter> <optional>$recursive = false</optional></parameter></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.html.html-template-sigma.html-template-sigma.getblocklist.desc"> &title.desc; <para>Returns a list of blocks within a template.</para> <para>If <parameter>$recursive</parameter> is &false;, it returns just a 'flat' array of <parameter>$parent</parameter>'s direct subblocks. If <parameter>$recursive</parameter> is &true;, it builds a tree of template blocks using <parameter>$parent</parameter> as root. Tree structure is compatible with PEAR::Tree's Memory_Array driver.</para> </refsect1> <refsect1 id="package.html.html-template-sigma.html-template-sigma.getblocklist.param"> &title.param; <para> <variablelist> <varlistentry> <term> &type.string; <parameter>$parent</parameter> </term> <listitem> <para> parent block name </para> </listitem> </varlistentry> <varlistentry> <term> &type.bool; <parameter>$recursive</parameter> </term> <listitem> <para> whether to return a tree of child blocks (&true;) or a 'flat' array (&false;) </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 id="package.html.html-template-sigma.html-template-sigma.getblocklist.return"> &title.returns; <para> <emphasis>return</emphasis> a list of child blocks </para> </refsect1> <refsect1 id="package.html.html-template-sigma.html-template-sigma.getblocklist.see"> &title.see; <para> <emphasis>see</emphasis> <link linkend="package.html.html-template-sigma.html-template-sigma.blockexists"><function>HTML_Template_Sigma::blockExists</function></link>, <link linkend="package.html.html-template-sigma.html-template-sigma.getplaceholderlist"><function>HTML_Template_Sigma::getPlaceholderList</function></link> </para> </refsect1> <refsect1 id="package.html.html-template-sigma.html-template-sigma.getblocklist.throws"> &title.throws; <para> <table> <title>&title.throws.errortable;</title> <tgroup cols="4"> <thead> <row> <entry>Error code</entry> <entry>Error message</entry> <entry>Reason</entry> <entry>Solution</entry> </row> </thead> <tbody> <row> <entry><constant>SIGMA_BLOCK_NOT_FOUND</constant></entry> <entry>Cannot find block '<parameter>$parent</parameter>'</entry> <entry>There is no block <parameter>$parent</parameter> in the template</entry> <entry>Check the block name spelling, check whether you added all the necessary blocks to the template</entry> </row> </tbody> </tgroup> </table> </para> </refsect1> <refsect1 id="package.html.html-template-sigma.html-template-sigma.getblocklist.note"> &title.note; &note.notstatic; </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 sgml-parent-document:nil sgml-default-dtd-file:"../../../../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 -->
« previous php.pear.doc (#830) next »