cvs: peardoc /en/package/structures/structures-datagrid structures-datagrid-datasource.xml
/en/package/structures/structures-datagrid/structures-datagrid-datasource structures-datagrid-datasource-create.xml
| From: | Andrew Nagy | Date: | Wed, 15 Dec 2004 16:07:59 +0000 |
| Subject: | cvs: peardoc /en/package/structures/structures-datagrid structures-datagrid-datasource.xml /en/package/structures/structures-datagrid/structures-datagrid-datasource structures-datagrid-datasource-create.xml |
||
| Groups: | php.pear.doc | ||
| Request: | Send a blank email to pear-doc+get-5274@lists.php.net to get a copy of this message | ||
asnagy Wed Dec 15 11:07:59 2004 EDT
Added files:
/peardoc/en/package/structures/structures-datagrid
structures-datagrid-datasource.xml
/peardoc/en/package/structures/structures-datagrid/structures-datagrid-datasource
structures-datagrid-datasource-create.xml
Log:
intial checkin
http://cvs.php.net/co.php/peardoc/en/package/structures/structures-datagrid/structures-datagrid-datasource.xml?r=1.1&p=1
Index: peardoc/en/package/structures/structures-datagrid/structures-datagrid-datasource.xml
+++ peardoc/en/package/structures/structures-datagrid/structures-datagrid-datasource.xml
<?xml version="1.0" encoding="iso-8859-1" ?>
<!-- $Revision: 1.1 $ -->
<refentry
id="package.structures.structures_datagrid.structures_datagrid.datasource">
<refnamediv>
<refname><classname>Structures_DataGrid_DataSource</classname></refname>
<refpurpose>The Data Source Class</refpurpose>
</refnamediv>
<refsect1
id="package.structures.structures_datagrid.structures_datagrid.datasource.desc">
&title.desc;
<para>
The Structures_Datagrid_DataSource class is an abstraction layer to allow
for multiple datatypes that the DataGrid can bind to. It uses datasource
drivers to interact with the datasource directly to process only what is
necessary to eliminate as much overhead as possible.
</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-executeMultiple-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
-->
http://cvs.php.net/co.php/peardoc/en/package/structures/structures-datagrid/structures-datagrid-datasource/structures-datagrid-datasource-create.xml?r=1.1&p=1
Index:
peardoc/en/package/structures/structures-datagrid/structures-datagrid-datasource/structures-datagrid-datasource-create.xml
+++
peardoc/en/package/structures/structures-datagrid/structures-datagrid-datasource/structures-datagrid-datasource-create.xml
<?xml version="1.0" encoding="iso-8859-1" ?>
<!-- $Revision: 1.1 $ -->
<refentry
id="package.structures.structures_datagrid.structures_datagrid.datasource.create">
<refnamediv>
<refname>Structures_DataGrid_DataSource::create()</refname>
<refpurpose>Creates a Structures_DataGrid_DataSource object</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcprototype>
<funcdef>string
<function>Structures_DataGrid_DataSource::create</function></funcdef>
<paramdef>
<classname>Structures_DataGrid_DataSource</classname> object
<parameter>$source</parameter>
</paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsect1
id="package.structures.structures_datagrid.structures_datagrid.datasource.create.desc">
&title.desc;
<para>
This method will create the datasource driver object by attempting to detect
it's type. If the type can be found the driver will be instantiated and
returned, if it cannot be detected, an error will be returned.
</para>
</refsect1>
<refsect1
id="package.structures.structures_datagrid.structures_datagrid.datasource.create.parameter">
&title.param;
<para>
<variablelist>
<varlistentry>
<term>
&type.mixed;
<parameter>$source</parameter>
</term>
<listitem>
<para>
The original data source.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
&type.array;
<parameter>$options</parameter>
</term>
<listitem>
<para>
An array of options to be used, these are respective to the driver.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
&type.string;
<parameter>$type</parameter>
</term>
<listitem>
<para>
Optional. This is used if the data source type cannot be detected.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1
id="package.structures.structures_datagrid.structures_datagrid.datasource.create.return">
&title.returns;
<para>
&type.object; - The <classname>Structures_DataGrid_DataSource</classname> object
</para>
</refsect1>
<refsect1
id="package.structures.structures_datagrid.structures_datagrid.datasource.create.note">
&title.note;
¬e.canstatic;
</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
-->