php-doc-en/reference/stream/php-user-filter.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<phpdoc:classref xml:id="class.php-user-filter" xmlns:phpdoc="http://php.net/ns/phpdoc" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">

 <title>The php_user_filter class</title>
 <titleabbrev>php_user_filter</titleabbrev>

 <partintro>

<!-- {{{ php_user_filter intro -->
  <section xml:id="php-user-filter.intro">
   &reftitle.intro;
   <para>
    Children of this class are passed to
    <function>stream_filter_register</function>.
    Note that the <link linkend="object.construct">__construct</link> method is not called;
    instead, <methodname>php_user_filter::onCreate</methodname> should be used for
    initialization.
   </para>
  </section>
<!-- }}} -->

  <section xml:id="php-user-filter.synopsis">
   &reftitle.classsynopsis;

<!-- {{{ Synopsis -->
   <classsynopsis>
    <ooclass>
     <classname>php_user_filter</classname>
    </ooclass>

    <classsynopsisinfo>
     <ooclass>
      <classname>php_user_filter</classname>
     </ooclass>
    </classsynopsisinfo>

    <classsynopsisinfo role="comment">&Properties;</classsynopsisinfo>
    <fieldsynopsis>
     <modifier>public</modifier>
     <type>string</type>
     <varname linkend="php-user-filter.props.filtername">filtername</varname>
     <initializer>""</initializer>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <type>mixed</type>
     <varname linkend="php-user-filter.props.params">params</varname>
     <initializer>""</initializer>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <type class="union"><type>resource</type><type>null</type></type>
     <varname linkend="php-user-filter.props.stream">stream</varname>
     <initializer>null</initializer>
    </fieldsynopsis>

    <classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.php-user-filter')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural')])">
     <xi:fallback/>
    </xi:include>
   </classsynopsis>
<!-- }}} -->

  </section>

  
<!-- {{{ php_user_filter properties -->
  <section xml:id="php-user-filter.props">
   &reftitle.properties;
   <variablelist>
    <varlistentry xml:id="php-user-filter.props.filtername">
     <term><varname>filtername</varname></term>
     <listitem>
      <para>
       Name of the filter registered by
       <function>stream_filter_append</function>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="php-user-filter.props.params">
     <term><varname>params</varname></term>
     <listitem>
      <para/>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="php-user-filter.props.stream">
     <term><varname>stream</varname></term>
     <listitem>
      <para/>
     </listitem>
    </varlistentry>
   </variablelist>
  </section>
<!-- }}} -->


 </partintro>

 &reference.stream.entities.php-user-filter;

</phpdoc:classref>
<!-- 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
-->