<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <html> <head> <meta http-equiv="content-type" content="text/html; charset=UTF-8"> <title>The php_user_filter class</title> </head> <body><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="stream.streamwrapper.example-1.html">Example class registered as stream wrapper</a></div> <div class="next" style="text-align: right; float: right;"><a href="php-user-filter.filter.html">php_user_filter::filter</a></div> <div class="up"><a href="book.stream.html">Streams</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div><hr /><div id="class.php-user-filter" class="reference"> <h1 class="title">The php_user_filter class</h1> <div class="partintro"><p class="verinfo">(PHP 5)</p> <div class="section" id="php-user-filter.intro"> <h2 class="title">Introduction</h2> <p class="para"> Children of this class are passed to <span class="function"><a href="function.stream-filter-register.html" class="function">stream_filter_register()</a></span>. </p> </div> <div class="section" id="php-user-filter.synopsis"> <h2 class="title">Class synopsis</h2> <div class="classsynopsis"> <div class="ooclass"></div> <div class="classsynopsisinfo"> <span class="ooclass"> <strong class="classname">php_user_filter</strong> </span> {</div> <div class="classsynopsisinfo classsynopsisinfo_comment">/* Properties */</div> <div class="fieldsynopsis"> <span class="modifier">public</span> <var class="varname"><a href="class.php-user-filter.html#php-user-filter.props.filtername">$<var class="varname">filtername</var></a></var> ;</div> <div class="fieldsynopsis"> <span class="modifier">public</span> <var class="varname"><a href="class.php-user-filter.html#php-user-filter.props.params">$<var class="varname">params</var></a></var> ;</div> <div class="classsynopsisinfo classsynopsisinfo_comment">/* Methods */</div> <div class="methodsynopsis dc-description"> <span class="modifier">public</span> <span class="type">int</span> <span class="methodname"><a href="php-user-filter.filter.html" class="methodname">filter</a></span> ( <span class="methodparam"><span class="type">resource</span> <code class="parameter">$in</code></span> , <span class="methodparam"><span class="type">resource</span> <code class="parameter">$out</code></span> , <span class="methodparam"><span class="type">int</span> <code class="parameter reference">&$consumed</code></span> , <span class="methodparam"><span class="type">bool</span> <code class="parameter">$closing</code></span> )</div> <div class="methodsynopsis dc-description"> <span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="php-user-filter.onclose.html" class="methodname">onClose</a></span> ( <span class="methodparam">void</span> )</div> <div class="methodsynopsis dc-description"> <span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><a href="php-user-filter.oncreate.html" class="methodname">onCreate</a></span> ( <span class="methodparam">void</span> )</div> }</div> </div> <div class="section" id="php-user-filter.props"> <h2 class="title">Properties</h2> <dl> <dt id="php-user-filter.props.filtername"> <span class="term"><var class="varname"><var class="varname">filtername</var></var></span> <dd> <p class="para"> Name of the filter registered by <span class="function"><a href="function.stream-filter-append.html" class="function">stream_filter_append()</a></span>. </p> </dd> </dt> <dt id="php-user-filter.props.params"> <span class="term"><var class="varname"><var class="varname">params</var></var></span> <dd> <p class="para"/> </dd> </dt> </dl> </div> </div> <h2>Table of Contents</h2><ul class="chunklist chunklist_reference"><li><a href="php-user-filter.filter.html">php_user_filter::filter</a> — Called when applying the filter</li><li><a href="php-user-filter.onclose.html">php_user_filter::onClose</a> — Called when closing the filter</li><li><a href="php-user-filter.oncreate.html">php_user_filter::onCreate</a> — Called when creating the filter</li></ul> </div> <hr /><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="stream.streamwrapper.example-1.html">Example class registered as stream wrapper</a></div> <div class="next" style="text-align: right; float: right;"><a href="php-user-filter.filter.html">php_user_filter::filter</a></div> <div class="up"><a href="book.stream.html">Streams</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div></body></html>