cvs: peardoc /en/package/html/pager factory.xml pager.xml

quipo Tue May 18 06:00:30 2004 EDT Added files: /peardoc/en/package/html/pager factory.xml Modified files: /peardoc/en/package/html/pager pager.xml Log: constructor is deprecated in favour of the new factory() method

http://cvs.php.net/diff.php/peardoc/en/package/html/pager/pager.xml?r1=1.1&r2=1.2&ty=u Index: peardoc/en/package/html/pager/pager.xml diff -u peardoc/en/package/html/pager/pager.xml:1.1 peardoc/en/package/html/pager/pager.xml:1.2 --- peardoc/en/package/html/pager/pager.xml:1.1 Tue Sep 9 20:40:22 2003 +++ peardoc/en/package/html/pager/pager.xml Tue May 18 06:00:30 2004 @@ -1,4 +1,4 @@ -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <refentry id="package.html.pager.pager"> <refnamediv> <refname><function>Pager::Pager</function></refname> @@ -15,6 +15,15 @@ </funcprototype> </funcsynopsis> </refsynopsisdiv> + + <refsect1 id="package.html.pager.pager.deprecated"> + <title>Deprecated</title> + <para> + The constructor is <emphasis>deprecated</emphasis> in favour of the new + <function>factory</function> method, which is PHP5 compatible too. + </para> + </refsect1> + <refsect1 id="package.html.pager.pager.parameter"> &title.param; <para> http://cvs.php.net/co.php/peardoc/en/package/html/pager/factory.xml?r=1.1&p=1 Index: peardoc/en/package/html/pager/factory.xml +++ peardoc/en/package/html/pager/factory.xml <!-- $Revision: 1.1 $ --> <refentry id="package.html.pager.factory"> <refnamediv> <refname><function>Pager::factory</function></refname> <refpurpose>Creates a pager instance</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo> require_once 'Pager/Pager.php'; </funcsynopsisinfo> <funcprototype> <funcdef>object <function>&amp;Pager</function></funcdef> <paramdef>array <parameter>$options</parameter></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.html.pager.factory.parameter"> &title.param; <para> <function>Pager::factory</function> constructor takes an associative array of parameters as input values. This is the complete list of these options: <itemizedlist> <listitem> <para><parameter>itemData</parameter> [array]</para> <para> Array of items to page. </para> </listitem> <listitem> <para><parameter>totalItems</parameter> [integer]</para> <para> Number of items to page (used only if <parameter>itemData</parameter> is not provided). </para> </listitem> <listitem> <para><parameter>perPage</parameter> [integer]</para> <para> Number of items to display on each page. </para> </listitem> <listitem> <para><parameter>delta</parameter> [integer]</para> <para> Number of page numbers to display before and after the current one. </para> </listitem> <listitem> <para><parameter>mode</parameter> [integer]</para> <para> "Jumping" or "Sliding" -window - It determines pager behaviour. </para> </listitem> <listitem> <para><parameter>expanded</parameter> [boolean]</para> <para> if &true;, window size is always 2*delta+1 </para> </listitem> <listitem> <para><parameter>linkClass</parameter> [string]</para> <para> Name of CSS class used for link styling. </para> </listitem> <listitem> <para><parameter>urlVar</parameter> [string]</para> <para> Name of URL var used to indicate the page number. Default value is "pageID". </para> </listitem> <listitem> <para><parameter>path</parameter> [string]</para> <para> Complete path to the page (without the page name). </para> </listitem> <listitem> <para><parameter>fileName</parameter> [string]</para> <para> name of the page, with a "%d" if <parameter>append</parameter> == &true;. </para> </listitem> <listitem> <para><parameter>append</parameter> [boolean]</para> <para> If &true; pageID is appended as GET value to the URL. If &false; it is embedded in the URL according to <parameter>fileName</parameter> specs. </para> </listitem> <listitem> <para><parameter>altPrev</parameter> [string]</para> <para> Alt text to display for prev page, on prev link. Default value is "previous page"; </para> </listitem> <listitem> <para><parameter>altNext</parameter> [string]</para> <para> Alt text to display for next page, on next link. Default value is "next page"; </para> </listitem> <listitem> <para><parameter>altPage</parameter> [string]</para> <para> Alt text to display before the page number. Default value is "page ". </para> </listitem> <listitem> <para><parameter>prevImg</parameter> [string]</para> <para> Something to display instead of "&lt;&lt;". It can be text such as "&lt;&lt; PREV" or an &lt;img/&gt; as well. </para> </listitem> <listitem> <para><parameter>nextImg</parameter> [string]</para> <para> Something to display instead of "&gt;&gt;". It can be text such as "NEXT &gt;&gt;" or an &lt;img/&gt; as well. </para> </listitem> <listitem> <para><parameter>separator</parameter> [string]</para> <para> What to use to separate numbers. It can be an &lt;img/&gt;, a comma, an hyphen, or whatever. </para> </listitem> <listitem> <para><parameter>spacesBeforeSeparator</parameter> [integer]</para> <para> Number of spaces before the separator. </para> </listitem> <listitem> <para><parameter>spacesAfterSeparator</parameter> [integer]</para> <para> Number of spaces after the separator. </para> </listitem> <listitem> <para><parameter>firstPagePre</parameter> [string]</para> <para> String used before first page number. It can be an &lt;img/&gt;, a "{", an empty string, or whatever. </para> </listitem> <listitem> <para><parameter>firstPageText</parameter> [string]</para> <para> String used in place of first page number. </para> </listitem> <listitem> <para><parameter>firstPagePost</parameter> [string]</para> <para> String used after first page number. It can be an &lt;img/&gt;, a "}", an empty string, or whatever. </para> </listitem> <listitem> <para><parameter>lastPagePre</parameter> [string]</para> <para> Similar to <parameter>firstPagePre</parameter>, but used for last page number. </para> </listitem> <listitem> <para><parameter>lastPageText</parameter> [string]</para> <para> Similar to <parameter>firstPageText</parameter>, but used for last page number. </para> </listitem> <listitem> <para><parameter>lastPagePost</parameter> [string]</para> <para> Similar to <parameter>firstPagePost</parameter>, but used for last page number. </para> </listitem> <listitem> <para><parameter>curPageLinkClassName</parameter> [string]</para> <para> Name of CSS class used for current page link. </para> </listitem> <listitem> <para><parameter>clearIfVoid</parameter> [boolean]</para> <para> if there's only one page, don't display pager (returns an empty string). </para> </listitem> <listitem> <para><parameter>useSessions</parameter> [boolean]</para> <para> if &true;, number of items to display per page is stored in the $_SESSION[$_sessionVar] var. </para> </listitem> <listitem> <para><parameter>closeSession</parameter> [boolean]</para> <para> if &true;, the session is closed just after R/W. </para> </listitem> <listitem> <para><parameter>sessionVar</parameter> [string]</para> <para> Name of the session var for perPage value. A value different from default can be useful when using more than one Pager istance in the page. </para> </listitem> <listitem> <para><parameter>pearErrorMode</parameter> [constant]</para> <para> PEAR_ERROR mode for raiseError(). Default is PEAR_ERROR_RETURN. </para> </listitem> </itemizedlist> REQUIRED options are: <itemizedlist> <listitem> <para><parameter>fileName</parameter> IF <parameter>append</parameter>==&false; (default is &true;) </para> </listitem> <listitem> <para><parameter>itemData</parameter> OR <parameter>totalItems</parameter> (if itemData is set, totalItems is overwritten) </para> </listitem> </itemizedlist> </para> </refsect1> <refsect1 id="package.html.pager.factory.return"> &title.returns; <para> <parameter>object</parameter> - a specific <classname>Pager</classname> instance or a &class.pear-error; object, if fails </para> </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 -->