Files
archived-doc-pt-br/reference/pdo_pgsql/pdo/pgsql/copyfromarray.xml
2025-03-02 21:46:47 -03:00

145 lines
4.1 KiB
XML

<?xml version="1.0" encoding="utf-8"?><!-- EN-Revision: 9b69a8dcce47d6619d6459914e784627cbb02a5f Maintainer: leonardolara Status: ready --><!-- CREDITS: leonardolara -->
<refentry xml:id="pdo-pgsql.copyfromarray" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>Pdo\Pgsql::copyFromArray</refname>
<refpurpose>Copia dados de um array PHP para uma tabela</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis role="Pdo\\Pgsql">
<modifier>public</modifier> <type>bool</type><methodname>Pdo\Pgsql::copyFromArray</methodname>
<methodparam><type>string</type><parameter>tableName</parameter></methodparam>
<methodparam><type>array</type><parameter>rows</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>
Copia dados do array <parameter>rows</parameter> para a tabela
<parameter>tableName</parameter> usando <parameter>separator</parameter>
como delimitador de campos e uma lista de campos no parâmetro <parameter>fields</parameter>.
</simpara>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>tableName</parameter></term>
<listitem>
<simpara>
String contendo o nome da tabela.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>rows</parameter></term>
<listitem>
<simpara>
Um <type>array</type> indexado de <type>string</type>s com
campos separados por <parameter>separator</parameter>.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>separator</parameter></term>
<listitem>
<simpara>
Delimitador usado para separar campos em uma entrada do
array <parameter>rows</parameter>.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>nullAs</parameter></term>
<listitem>
<simpara>
Como interpretar valores SQL <literal>NULL</literal>.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>fields</parameter></term>
<listitem>
<simpara>
Lista de campos a serem inseridos.
</simpara>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<simpara>
&return.success;
</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.copyfromarray.example.basic">
<title><methodname>Pdo\Pgsql::copyFromArray</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::copyToArray</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
-->