cvs: peardoc /en/package/console console-table.xml /en/package/console/console-table/console-table addcol.xml adddata.xml addrow.xml
console_table.xml gettable.xml insertrow.xml setheaders.xml

xnoguer Wed Sep 10 17:17:10 2003 EDT Added files: /peardoc/en/package/console console-table.xml /peardoc/en/package/console/console-table/console-table addcol.xml adddata.xml addrow.xml console_table.xml gettable.xml insertrow.xml setheaders.xml Log: adding Console_Table

Index: peardoc/en/package/console/console-table.xml +++ peardoc/en/package/console/console-table.xml <!-- $Revision: 1.1 $ --> <sect1 id="package.console.console-table"> <title>Console_Table</title> <para> <classname>Console_Table</classname> provides methods to build console tables </para> &package.console.console-table.console-table.console-table; &package.console.console-table.console-table.addcol; &package.console.console-table.console-table.adddata; &package.console.console-table.console-table.addrow; &package.console.console-table.console-table.gettable; &package.console.console-table.console-table.insertrow; &package.console.console-table.console-table.setheaders; </sect1> <!-- Generated by phpDocumentor v 1.2.2 http://www.phpdoc.org --> <!-- 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/console/console-table/console-table/addcol.xml +++ peardoc/en/package/console/console-table/console-table/addcol.xml <!-- $Revision: 1.1 $ --> <refentry id="package.console.console-table.console-table.addcol"> <refnamediv> <refname><function>Console_Table::addCol</function></refname> <refpurpose>Adds a column to the table</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo> require_once &apos;Console/Table.php&apos;; </funcsynopsisinfo> <funcprototype> <funcdef>void <function>Console_Table::addCol</function></funcdef> <paramdef>array <parameter>$col_data</parameter></paramdef> <paramdef>integer <parameter> <optional>$col_id</optional></parameter></paramdef> <paramdef>integer <parameter> <optional>$row_id</optional></parameter></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.console.console-table.console-table.addcol.desc"> &title.desc; <para> Adds a column to the table </para> </refsect1> <refsect1 id="package.console.console-table.console-table.addcol.param"> &title.param; <para> <variablelist> <varlistentry> <term> array <parameter>$col_data</parameter> </term> <listitem> <para> The data of the column. Can be numeric or associative array </para> </listitem> </varlistentry> </variablelist> <variablelist> <varlistentry> <term> &type.int; <parameter>$col_id</parameter> </term> <listitem> <para> The column index to populate </para> </listitem> </varlistentry> </variablelist> <variablelist> <varlistentry> <term> &type.int; <parameter>$row_id</parameter> </term> <listitem> <para> If starting row is not zero, specify it here </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 id="package.console.console-table.console-table.addcol.throws"> &title.throws; <para> <emphasis>throws</emphasis> no exceptions thrown </para> </refsect1> <refsect1 id="package.console.console-table.console-table.addcol.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/console/console-table/console-table/adddata.xml +++ peardoc/en/package/console/console-table/console-table/adddata.xml <!-- $Revision: 1.1 $ --> <refentry id="package.console.console-table.console-table.adddata"> <refnamediv> <refname><function>Console_Table::addData</function></refname> <refpurpose>Adds data to the table.</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo> require_once &apos;Console/Table.php&apos;; </funcsynopsisinfo> <funcprototype> <funcdef>void <function>Console_Table::addData</function></funcdef> <paramdef>array <parameter>$data</parameter></paramdef> <paramdef>integer <parameter> <optional>$col_id</optional></parameter></paramdef> <paramdef>integer <parameter> <optional>$row_id</optional></parameter></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.console.console-table.console-table.adddata.desc"> &title.desc; <para> Adds data to the table. Argument should be a two dimensional array containing the data to be added. </para> </refsect1> <refsect1 id="package.console.console-table.console-table.adddata.param"> &title.param; <para> <variablelist> <varlistentry> <term> &type.array; <parameter>$data</parameter> </term> <listitem> <para> The data to add to the table </para> </listitem> </varlistentry> </variablelist> <variablelist> <varlistentry> <term> &type.int; <parameter>$col_id</parameter> </term> <listitem> <para> Optional starting column ID </para> </listitem> </varlistentry> </variablelist> <variablelist> <varlistentry> <term> &type.int; <parameter>$row_id</parameter> </term> <listitem> <para> Optional starting row ID </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 id="package.console.console-table.console-table.adddata.throws"> &title.throws; <para> <emphasis>throws</emphasis> no exceptions thrown </para> </refsect1> <refsect1 id="package.console.console-table.console-table.adddata.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/console/console-table/console-table/addrow.xml +++ peardoc/en/package/console/console-table/console-table/addrow.xml <!-- $Revision: 1.1 $ --> <refentry id="package.console.console-table.console-table.addrow"> <refnamediv> <refname><function>Console_Table::addRow</function></refname> <refpurpose>Adds a row to the table</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo> require_once &apos;Console/Table.php&apos;; </funcsynopsisinfo> <funcprototype> <funcdef>void <function>Console_Table::addRow</function></funcdef> <paramdef>array <parameter>$row</parameter></paramdef> <paramdef>array <parameter> <optional>$append = &true;</optional></parameter></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.console.console-table.console-table.addrow.desc"> &title.desc; <para> Adds a row to the table </para> </refsect1> <refsect1 id="package.console.console-table.console-table.addrow.param"> &title.param; <para> <variablelist> <varlistentry> <term> &type.array; <parameter>$row</parameter> </term> <listitem> <para> The row data to add </para> </listitem> </varlistentry> </variablelist> <variablelist> <varlistentry> <term> &type.array; <parameter>$append</parameter> </term> <listitem> <para> Whether to append or prepend the row </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 id="package.console.console-table.console-table.addrow.throws"> &title.throws; <para> <emphasis>throws</emphasis> no exceptions thrown </para> </refsect1> <refsect1 id="package.console.console-table.console-table.addrow.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/console/console-table/console-table/console_table.xml +++ peardoc/en/package/console/console-table/console-table/console_table.xml <!-- $Revision: 1.1 $ --> <refentry id="package.console.console-table.console-table.console-table"> <refnamediv> <refname>constructor <function>Console_Table::Console_Table</function></refname> <refpurpose>Constructor</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo> require_once &apos;Console/Table.php&apos;; </funcsynopsisinfo> <funcprototype> <funcdef>void constructor <function>Console_Table::Console_Table</function></funcdef> <paramdef></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.console.console-table.console-table.console-table.desc"> &title.desc; <para> Constructor </para> </refsect1> <refsect1 id="package.console.console-table.console-table.console-table.throws"> &title.throws; <para> <emphasis>throws</emphasis> no exceptions thrown </para> </refsect1> <refsect1 id="package.console.console-table.console-table.console-table.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/console/console-table/console-table/gettable.xml +++ peardoc/en/package/console/console-table/console-table/gettable.xml <!-- $Revision: 1.1 $ --> <refentry id="package.console.console-table.console-table.gettable"> <refnamediv> <refname><function>Console_Table::getTable</function></refname> <refpurpose>Returns the table in wonderful ASCII art</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo> require_once &apos;Console/Table.php&apos;; </funcsynopsisinfo> <funcprototype> <funcdef>void <function>Console_Table::getTable</function></funcdef> <paramdef></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.console.console-table.console-table.gettable.desc"> &title.desc; <para>Returns the table in wonderful ASCII art</para> </refsect1> <refsect1 id="package.console.console-table.console-table.gettable.throws"> &title.throws; <para> <emphasis>throws</emphasis> no exceptions thrown </para> </refsect1> <refsect1 id="package.console.console-table.console-table.gettable.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/console/console-table/console-table/insertrow.xml +++ peardoc/en/package/console/console-table/console-table/insertrow.xml <!-- $Revision: 1.1 $ --> <refentry id="package.console.console-table.console-table.insertrow"> <refnamediv> <refname><function>Console_Table::insertRow</function></refname> <refpurpose>Inserts a row after a given row number in the table.</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo> require_once &apos;Console/Table.php&apos;; </funcsynopsisinfo> <funcprototype> <funcdef>void <function>Console_Table::insertRow</function></funcdef> <paramdef>array <parameter>$row</parameter></paramdef> <paramdef>integer <parameter> <optional>$row_id</optional></parameter></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.console.console-table.console-table.insertrow.desc"> &title.desc; <para> Inserts a row after a given row number in the table. If $row_id is not given it will prepend the row. </para> </refsect1> <refsect1 id="package.console.console-table.console-table.insertrow.param"> &title.param; <para> <variablelist> <varlistentry> <term> &type.array; <parameter>$row</parameter> </term> <listitem> <para> The data to insert </para> </listitem> </varlistentry> </variablelist> <variablelist> <varlistentry> <term> &type.int; <parameter>$row_id</parameter> </term> <listitem> <para> Row number to insert before </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 id="package.console.console-table.console-table.insertrow.throws"> &title.throws; <para> <emphasis>throws</emphasis> no exceptions thrown </para> </refsect1> <refsect1 id="package.console.console-table.console-table.insertrow.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/console/console-table/console-table/setheaders.xml +++ peardoc/en/package/console/console-table/console-table/setheaders.xml <!-- $Revision: 1.1 $ --> <refentry id="package.console.console-table.console-table.setheaders"> <refnamediv> <refname><function>Console_Table::setHeaders</function></refname> <refpurpose>Sets the headers for the columns</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo> require_once &apos;Console/Table.php&apos;; </funcsynopsisinfo> <funcprototype> <funcdef>void <function>Console_Table::setHeaders</function></funcdef> <paramdef>array <parameter>$headers</parameter></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.console.console-table.console-table.setheaders.desc"> &title.desc; <para> Sets the headers for the columns </para> </refsect1> <refsect1 id="package.console.console-table.console-table.setheaders.param"> &title.param; <para> <variablelist> <varlistentry> <term> array <parameter>$headers</parameter> </term> <listitem> <para> The column headers </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 id="package.console.console-table.console-table.setheaders.throws"> &title.throws; <para> <emphasis>throws</emphasis> no exceptions thrown </para> </refsect1> <refsect1 id="package.console.console-table.console-table.setheaders.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 -->