error-log.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: a2db0ec37511850cc529be2b141bf194ad878ee2 Maintainer: seros Status: ready -->
<!-- Reviewed: yes Maintainer: seros -->
<refentry xml:id="function.error-log" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>error_log</refname>
  <refpurpose>Enviar un mensaje de error a las rutinas de manejo de errores definidas</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>bool</type><methodname>error_log</methodname>
   <methodparam><type>string</type><parameter>message</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>message_type</parameter><initializer>0</initializer></methodparam>
   <methodparam choice="opt"><type>string</type><parameter>destination</parameter></methodparam>
   <methodparam choice="opt"><type>string</type><parameter>extra_headers</parameter></methodparam>
  </methodsynopsis>
  <para>
   Envía un mensaje de error al registro de errores del servidor web o a un fichero.
  </para>
 </refsect1>
 
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>message</parameter></term>
     <listitem>
      <para>
       El mensaje de error que debería ser registrado.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>message_type</parameter></term>
     <listitem>
      <para>
       Indica dónde debería ir el error. Los tipos de mensaje posibles
       son:
      </para>
      <para>
       <table>
        <title>Tipos de registro de <function>error_log</function></title>
        <tgroup cols="2">
         <tbody>
          <row>
           <entry>0</entry>
           <entry>
            <parameter>message</parameter> es enviado al registro del sistema de PHP, usando
            el mecanismo de registro del Sistema Operativo o un fichero, dependiendo
            de qué directiva de configuración esté establecida en
            <link linkend="ini.error-log">error_log</link>. Esta opción es la  predeterminada.
           </entry>
          </row>
          <row>
           <entry>1</entry>
           <entry>
            <parameter>message</parameter> es enviado por email a la dirección del
            parámetro <parameter>destination</parameter>. Este es el único tipo de
            mensaje donde se usa el cuarto parámetro
            <parameter>extra_headers</parameter>.
           </entry>
          </row>
          <row>
           <entry>2</entry>
           <entry>
            Ya no es una opción.
           </entry>
          </row>
          <row>
           <entry>3</entry>
           <entry>
            <parameter>message</parameter> es añadido al final del fichero
            <parameter>destination</parameter>. No se añade automáticamente una
            nueva línea al final del string <parameter>message</parameter>.
           </entry>
          </row>
          <row>
           <entry>4</entry>
           <entry>
            <parameter>message</parameter> es enviado directamente al gestor de registro
            de la SAPI.
           </entry>
          </row>
         </tbody>
        </tgroup>
       </table>
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>destination</parameter></term>
     <listitem>
      <para>
       El destino. Su significado depende del parámetro
       <parameter>message_type</parameter> tal como se describió arriba.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>extra_headers</parameter></term>
     <listitem>
      <para>
       Las cabeceras extra. Se usa cuando el parámetro <parameter>message_type</parameter>
       está establecido a <literal>1</literal>.
       Este tipo de mensaje usa la misma función interna que
       <function>mail</function>.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.success;
  </para>
 </refsect1>
 
 <refsect1 role="notes">
  &reftitle.notes;
  <warning>
   <simpara>
    <function>error_log</function> no es seguro a nivel binario. <parameter>message</parameter> será truncado por un carácter null.
   </simpara>
  </warning>
  <tip>
   <simpara>
    <parameter>message</parameter> no debería contener un carácter null. Observe que <parameter>message</parameter> podría enviarse a un fichero, correo, syslog, etc. Use la función de conversión/escape apropiada, <function>base64_encode</function>, <function>rawurlencode</function> o <function>addslashes</function>, antes de llamar a <function>error_log</function>.
   </simpara>
  </tip>
 </refsect1>
 
 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example role="php">
    <title>Ejemplos de <function>error_log</function></title>
    <programlisting role="php">
<![CDATA[
<?php
// Enviar una notificación al registro del servidor si no podemos
// conectarnos a la base de datos.
if (!Ora_Logon($username, $password)) {
    error_log("¡La base de datos de Oracle no está disponible!", 0);
}

// Notificar al administrador mediante un email si agotamos FOO
if (!($foo = allocate_new_foo())) {
    error_log("Problema serio, nos hemos quedado sin FOOs!", 1,
               "operator@example.com");
}

// otra manera de llamar a error_log():
error_log("¡Lo echaste a perder!", 3, "/var/tmp/my-errors.log");
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>
 
 <refsect1 role="changelog">
  &reftitle.changelog;
  <para>
   <informaltable>
    <tgroup cols="2">
     <thead>
      <row>
       <entry>&Version;</entry>
       <entry>&Description;</entry>
      </row>
     </thead>
     <tbody>
      <row>
       <entry>5.2.7</entry>
       <entry>
        El valor posible de 4 se añadió a <parameter>message_type</parameter>.
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </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
-->