<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<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>Called when creating the filter</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis role="php_user_filter">
   <modifier>public</modifier> <type>bool</type><methodname>php_user_filter::onCreate</methodname>
   <void/>
  </methodsynopsis>
  <para>
   This method is called during instantiation of the filter class
   object.  If your filter allocates or initializes any other resources
   (such as a buffer), this is the place to do it.
  </para>

  <para>
   When your filter is first instantiated, and
   <literal>yourfilter-&gt;onCreate()</literal> is called, a number of properties
   will be available as shown in the table below.
  </para>
  <para>
   <informaltable>
    <tgroup cols="2">
     <thead>
      <row>
       <entry>Property</entry>
       <entry>Contents</entry>
      </row>
     </thead>
     <tbody>
      <row>
       <entry><literal>FilterClass-&gt;filtername</literal></entry>
       <entry>
        A string containing the name the filter was instantiated with.
        Filters may be registered under multiple names or under wildcards.
        Use this property to determine which name was used.
       </entry>
      </row>
      <row>
       <entry><literal>FilterClass-&gt;params</literal></entry>
       <entry>
        The contents of the <parameter>params</parameter> parameter passed
        to <function>stream_filter_append</function>
        or <function>stream_filter_prepend</function>.
       </entry>
      </row>
      <row>
       <entry><literal>FilterClass-&gt;stream</literal></entry>
       <entry>
        The stream resource being filtered. Maybe available only during
        <methodname>filter</methodname> calls when the 
        <literal>closing</literal> parameter is set to &false;.
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </para>

 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  &no.function.parameters;
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Your implementation of
   this method should return &false; on failure, or &true; on success.
  </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
-->
