cvs: peardoc /en/package/html/pager factory.xml
| From: | Lorenzo Alberton | Date: | Fri, 10 Mar 2006 21:18:00 +0000 |
| Subject: | cvs: peardoc /en/package/html/pager factory.xml | ||
| Groups: | php.pear.doc | ||
| Request: | Send a blank email to pear-doc+get-7658@lists.php.net to get a copy of this message | ||
quipo Fri Mar 10 21:18:00 2006 UTC
Modified files:
/peardoc/en/package/html/pager factory.xml
Log:
document all the available parameters
http://cvs.php.net/viewcvs.cgi/peardoc/en/package/html/pager/factory.xml?r1=1.8&r2=1.9&diff_format=u
Index: peardoc/en/package/html/pager/factory.xml
diff -u peardoc/en/package/html/pager/factory.xml:1.8 peardoc/en/package/html/pager/factory.xml:1.9
--- peardoc/en/package/html/pager/factory.xml:1.8 Fri Jan 20 16:43:03 2006
+++ peardoc/en/package/html/pager/factory.xml Fri Mar 10 21:18:00 2006
@@ -1,4 +1,4 @@
-<!-- $Revision: 1.8 $ -->
+<!-- $Revision: 1.9 $ -->
<refentry id="package.html.pager.factory">
<refnamediv>
<refname><function>Pager::factory</function></refname>
@@ -111,6 +111,12 @@
</para>
</listitem>
<listitem>
+ <para><parameter>fixFileName</parameter> [boolean]</para>
+ <para>
+ If set to &false;, the <parameter>fileName<parameter> option is not
overridden. Use at your own risk.
+ </para>
+ </listitem>
+ <listitem>
<para><parameter>append</parameter> [boolean]</para>
<para>
If &true; pageID is appended as GET value to the URL.
@@ -196,15 +202,40 @@
</para>
</listitem>
<listitem>
+ <para><parameter>curPageLinkClassName</parameter> [string]</para>
+ <para>
+ CSS class name for the current page link.
+ </para>
+ </listitem>
+ <listitem>
+ <para><parameter>curPageSpanPre</parameter> [string]</para>
+ <para>
+ Text before the current page link.
+ </para>
+ </listitem>
+ <listitem>
+ <para><parameter>curPageSpanPost</parameter> [string]</para>
+ <para>
+ Text after the current page link.
+ </para>
+ </listitem>
+ <listitem>
+ <para><parameter>firstPagePre</parameter> [string]</para>
+ <para>
+ String used before the first page number.
+ It can be an <img/>, a "{", an empty string, or whatever.
+ </para>
+ </listitem>
+ <listitem>
<para><parameter>firstPageText</parameter> [string]</para>
<para>
- String used in place of first page number.
+ String used in place of the first page number.
</para>
</listitem>
<listitem>
<para><parameter>firstPagePost</parameter> [string]</para>
<para>
- String used after first page number.
+ String used after the first page number.
It can be an <img/>, a "}", an empty string, or whatever.
</para>
</listitem>
@@ -230,12 +261,6 @@
</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 links (returns an empty string).