copytoarray.xml

<?xml version="1.0" encoding="utf-8"?>
<refentry xml:id="pdo-pgsql.copytoarray" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
 <refnamediv>
  <refname>Pdo\Pgsql::copyToArray</refname>
  <refpurpose>Copy data from database table into PHP array</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis role="Pdo\\Pgsql">
   <modifier>public</modifier> <type class="union"><type>array</type><type>false</type></type><methodname>Pdo\Pgsql::copyToArray</methodname>
   <methodparam><type>string</type><parameter>tableName</parameter></methodparam>
   <methodparam choice="opt"><type>string</type><parameter>separator</parameter><initializer>"\t"</initializer></methodparam>
   <methodparam choice="opt"><type>string</type><parameter>nullAs</parameter><initializer>"\\\\N"</initializer></methodparam>
   <methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>fields</parameter><initializer>&null;</initializer></methodparam>
  </methodsynopsis>
  <simpara>
   Copies data from <parameter>tableName</parameter> into array using <parameter>separator</parameter> as fields delimiter and <parameter>fields</parameter> list
  </simpara>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <variablelist>
   <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('pdo-pgsql.copyfromarray')/db:refsect1[@role='parameters']//db:varlistentry[db:term[db:parameter[text()='tableName']]]/.)">
    <xi:fallback><varlistentry><term></term><listitem><simpara></simpara></listitem></varlistentry></xi:fallback>
   </xi:include>
   <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('pdo-pgsql.copyfromarray')/db:refsect1[@role='parameters']//db:varlistentry[db:term[db:parameter[text()='separator']]]/.)">
    <xi:fallback><varlistentry><term></term><listitem><simpara></simpara></listitem></varlistentry></xi:fallback>
   </xi:include>
   <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('pdo-pgsql.copyfromarray')/db:refsect1[@role='parameters']//db:varlistentry[db:term[db:parameter[text()='nullAs']]]/.)">
    <xi:fallback><varlistentry><term></term><listitem><simpara></simpara></listitem></varlistentry></xi:fallback>
   </xi:include>
   <varlistentry>
    <term><parameter>fields</parameter></term>
    <listitem>
     <simpara>
      List of fields to export.
     </simpara>
    </listitem>
   </varlistentry>
  </variablelist>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <simpara>
   Returns an array of rows,&return.falseforfailure;.
  </simpara>
 </refsect1>

 <!-- TODO?
 <refsect1 role="errors">
  &reftitle.errors;
  <simpara>
   When does this function issue <constant>E_*</constant> level errors,
   and/or throw <exceptionname>Exception</exceptionname>s.
  </simpara>
 </refsect1>
 -->

 <!-- TODO?
 <refsect1 role="examples">
  &reftitle.examples;
  <example xml:id="pdo-pgsql.copytoarray.example.basic">
   <title><methodname>Pdo\Pgsql::copyToArray</methodname> example</title>
   <simpara>
    Description.
   </simpara>
   <programlisting role="php">
<![CDATA[
<?php
echo "Code example";
?>
]]>
   </programlisting>
   &example.outputs;
   <screen>
<![CDATA[
Code example
]]>
   </screen>
  </example>
 </refsect1>
 -->

 <refsect1 role="seealso">
  &reftitle.seealso;
  <simplelist>
   <member><methodname>Pdo\Pgsql::copyFromArray</methodname></member>
   <member><methodname>Pdo\Pgsql::copyFromFile</methodname></member>
   <member><methodname>Pdo\Pgsql::copyToFile</methodname></member>
  </simplelist>
 </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
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/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
-->