oncreate.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 158a015e881963245f2197c2535e7fc2d476a766 Maintainer: seros Status: ready -->
<!-- Reviewed: no -->

<refentry xml:id="php-user-filter.oncreate" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>php_user_filter::onCreate</refname>
  <refpurpose>Llamado cuando se crea el filtro</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <modifier>public</modifier> <type>bool</type><methodname>php_user_filter::onCreate</methodname>
   <void />
  </methodsynopsis>
  <para>
   Este método se llama durante la instanciación del objeto de la clase del
   filtro. Si el filtro asigna o inicializa cualquier otro recurso
   (como un buffer), éste es el lugar para hacerlo.
  </para>
  
  <para>
   Cuando primero se instancia el filtro, y
   se llama a <literal>elfiltro-&gt;onCreate()</literal>, estarán disponibles
   varias propiedades como se muestra en la tabla de abajo.
  </para>
  <para>
   <informaltable>
    <tgroup cols="2">
     <thead>
      <row>
       <entry>Propiedad</entry>
       <entry>Contenido</entry>
      </row>
     </thead>
     <tbody>
      <row>
       <entry><literal>FilterClass-&gt;filtername</literal></entry>
       <entry>
        Una cadena que contiene el nombre del filtro con el que fue instanciado.
        Los filtros pueden ser registrados bajo múltiples nombres o bajo comodines.
        Use esta propiedad para determinar qué nombre fue usado.
       </entry>
      </row>
      <row>
       <entry><literal>FilterClass-&gt;params</literal></entry>
       <entry>
        El contenido del parámetro <parameter>params</parameter> pasado
        a <function>stream_filter_append</function>
        o a <function>stream_filter_prepend</function>.
       </entry>
      </row>
      <row>
       <entry><literal>FilterClass-&gt;stream</literal></entry>
       <entry>
        El recurso de flujo que va a ser filtrado. Quizás disponible sólo durante
        las llamadas a <methodname>filter</methodname> cuando el
        parámetro <literal>closing</literal> es &false;.
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </para>
  
 </refsect1>
 
 <refsect1 role="parameters">
  &reftitle.parameters;
  &no.function.parameters;
 </refsect1>
 
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   La implementación de
   este método debería devolver &false; en caso de error, o &true; en caso de éxito.
  </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
-->