archived-doc-pt-br/reference/pgsql/functions/pg-delete.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: c2eca73ef79ebe78cebb34053e41b565af504c4f Maintainer: fernandowobeto Status: ready --><!-- CREDITS: fernandowobeto -->
<refentry xml:id="function.pg-delete" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>pg_delete</refname>
  <refpurpose>
   Exclui registros
  </refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>string</type><type>bool</type></type><methodname>pg_delete</methodname>
   <methodparam><type>PgSql\Connection</type><parameter>connection</parameter></methodparam>
   <methodparam><type>string</type><parameter>table_name</parameter></methodparam>
   <methodparam><type>array</type><parameter>conditions</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer><constant>PGSQL_DML_EXEC</constant></initializer></methodparam>
  </methodsynopsis>
  <para>
   <function>pg_delete</function> exclui registros de uma tabela
   especificada pelas chaves e valores em <parameter>conditions</parameter>.
  </para>
  <para>
   Se <parameter>flags</parameter> for especificado,
   <function>pg_convert</function> será aplicado às
   <parameter>conditions</parameter> com as opções especificadas.
  </para>
  <para>
   Por padrão, <function>pg_delete</function> passa valores brutos.
   Os valores devem ser escapados ou a opção <constant>PGSQL_DML_ESCAPE</constant>
   deve ser especificado em <parameter>flags</parameter>.
   <constant>PGSQL_DML_ESCAPE</constant> cita e escapa parâmetros/identificadores.
   Portanto, os nomes de tabelas/colunas diferenciam maiúsculas de minúsculas.
  </para>
  <para>
   Observe que nem o escape nem a consulta preparada podem proteger consultas LIKE,
   JSON, Array, Regex, etc. Esses parâmetros devem ser tratados
   de acordo com seus contextos. ou seja, escapar/validar valores.
  </para>
 </refsect1>

<refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>connection</parameter></term>
     <listitem>
      &pgsql.parameter.connection;
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>table_name</parameter></term>
     <listitem>
      <para>
       Nome da tabela da qual as linhas serão excluídas.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>conditions</parameter></term>
     <listitem>
      <para>
       Um <type>array</type> cujas chaves são nomes de campos na tabela <parameter>table_name</parameter>
       e cujos valores são os valores dos campos que devem ser excluídos.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>flags</parameter></term>
     <listitem>
      <para>
       Qualquer número de <constant>PGSQL_CONV_FORCE_NULL</constant>,
       <constant>PGSQL_DML_NO_CONV</constant>,
       <constant>PGSQL_DML_ESCAPE</constant>,
       <constant>PGSQL_DML_EXEC</constant>,
       <constant>PGSQL_DML_ASYNC</constant> ou
       <constant>PGSQL_DML_STRING</constant> combinado. Se <constant>PGSQL_DML_STRING</constant> fizer parte de
       <parameter>flags</parameter> então a string de consulta é retornada. Quando <constant>PGSQL_DML_NO_CONV</constant>
       ou <constant>PGSQL_DML_ESCAPE</constant> está definido, ele não chama <function>pg_convert</function> internamente.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.success; Retorna <type>string</type> se <constant>PGSQL_DML_STRING</constant> for passado
   através de <parameter>flags</parameter>.
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <informaltable>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>&Version;</entry>
      <entry>&Description;</entry>
     </row>
    </thead>
    <tbody>
     &pgsql.changelog.connection-object;
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Exemplo de <function>pg_delete</function></title>
    <programlisting role="php">
<![CDATA[
<?php
  $db = pg_connect('dbname=foo');
  // Isso é um tanto seguro, já que todos os valores têm escape.
  // No entanto, o PostgreSQL suporta JSON/Array. Eles não são
  // seguros nem por escape nem por consulta preparada.
  $res = pg_delete($db, 'post_log', $_POST, PG_DML_ESCAPE);
  if ($res) {
      echo "Dados POST foram excluídos: $res\n";
  } else {
      echo "O usuário deve ter enviado entradas erradas\n";
  }
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>pg_convert</function></member>
   </simplelist>
  </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-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
-->