<?xml version="1.0" encoding="iso-8859-1"?> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" /> <title> HTML_Progress2::setProgressHandler </title> <link rel="stylesheet" href="book.css" type="text/css" /> <meta name="generator" content="DocBook XSL Stylesheets V1.69.1" /> <link rel="start" href="index.html" title="HTML_Progress2 Manual" /> <link rel="up" href="ch19s05.html#reference.api.common.process" title= "Process " /> <link rel="prev" href="re52.html" title="HTML_Progress2::sleep" /> <link rel="next" href="re54.html" title="HTML_Progress2::process" /> <style type="text/css"> /*<![CDATA[*/ body { background-color: white; color: black; } :link { color: #0000FF } :visited { color: #840084 } :active { color: #0000FF } table.c1 {padding-bottom: 1em} /*]]>*/ </style> </head> <body> <table class="progress2Header"> <tr> <td> <img src="img/pear_progress2.gif" align="left" alt= "PEAR Progress2 logo" /> <h1> HTML_Progress2 : The Definitive Guide </h1> <div class="navheader"> <table width="100%" summary="Navigation header"> <tr> <th colspan="3" align="center"> <code class= "function">HTML_Progress2::setProgressHandler</code> </th> </tr> <tr> <td width="20%" align="left"> <a accesskey="p" href="re52.html">Prev</a> </td> <th width="60%" align="center"> Process </th> <td width="20%" align="right"> <a accesskey="n" href="re54.html">Next</a> </td> </tr> </table> </div> </td> </tr> </table> <div class="refentry" lang="en" xml:lang="en"> <a name="package.html.html-progress2.html-progress2.setprogresshandler" id="package.html.html-progress2.html-progress2.setprogresshandler"></a> <div class="titlepage"></div> <div class="refnamediv"> <h2> Name </h2> <p> <code class="function">HTML_Progress2::setProgressHandler</code> — Sets the user progress callback function </p> </div> <div class="refsynopsisdiv"> <h2> Synopsis </h2> <div class="funcsynopsis"> <pre class="funcsynopsisinfo"> require_once 'HTML/Progress2.php'; </pre> <table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="c1"> <tr> <td> <code class="funcdef">void <b class= "fsfunc">HTML_Progress2::setProgressHandler</b>(</code> </td> <td> <var class="pdparam">$handler</var><code>)</code>; </td> <td> </td> </tr> </table> <table border="0" summary="Function argument synopsis" cellspacing= "0" cellpadding="0"> <tr> <td> mixed </td> <td> <var class="pdparam">$handler</var>; </td> </tr> </table> </div> </div> <div class="refsect1" lang="en" xml:lang="en"> <a name= "package.html.html-progress2.html-progress2.setprogresshandler.desc" id="package.html.html-progress2.html-progress2.setprogresshandler.desc"> </a> <h2> Description </h2> <p> The <code class="function">process()</code> function will call the user-callback defined here by this <code class= "methodname">setProgressHandler()</code> method. </p> <p> The user-supplied progress function must return either positive for a step progression, using <code class="methodname">moveStep()</code> method, or NULL for a standard progression, using <code class= "methodname">moveNext()</code> method. </p> </div> <div class="refsect1" lang="en" xml:lang="en"> <a name= "package.html.html-progress2.html-progress2.setprogresshandler.param" id= "package.html.html-progress2.html-progress2.setprogresshandler.param"></a> <h2> Parameter </h2> <div class="variablelist"> <dl> <dt> <span class="term"><span class="type">mixed</span> <em class= "parameter"><code>$handler</code></em></span> </dt> <dd> <p> Name of function or a class-method. </p> </dd> </dl> </div> </div> <div class="refsect1" lang="en" xml:lang="en"> <a name= "package.html.html-progress2.html-progress2.setprogresshandler.see" id= "package.html.html-progress2.html-progress2.setprogresshandler.see"></a> <h2> See </h2> <p> <span class="emphasis"><em>see</em></span> <a href="re54.html" title= "HTML_Progress2::process"><code class= "function">HTML_Progress2::process</code></a> </p> </div> <div class="refsect1" lang="en" xml:lang="en"> <a name= "package.html.html-progress2.html-progress2.setprogresshandler.throws" id= "package.html.html-progress2.html-progress2.setprogresshandler.throws"></a> <h2> Throws </h2> <p> <span class="emphasis"><em>throws</em></span> HTML_PROGRESS2_ERROR_INVALID_CALLBACK </p> </div> <div class="refsect1" lang="en" xml:lang="en"> <a name= "package.html.html-progress2.html-progress2.setprogresshandler.note" id="package.html.html-progress2.html-progress2.setprogresshandler.note"> </a> <h2> Note </h2> <p> <span class="emphasis"><em>since</em></span> 2.0.0 </p> <p> This function can not be called statically. </p> </div> </div> <table class="progress2Footer"> <tr> <td align="left"> HTML_Progress2 : The Definitive Guide </td> <td align="right"> v 2.4.0 : April 20, 2007 </td> </tr> </table> <div class="navfooter"> <hr /> <table width="100%" summary="Navigation footer"> <tr> <td width="40%" align="left"> <a accesskey="p" href="re52.html">Prev</a> </td> <td width="20%" align="center"> <a accesskey="u" href= "ch19s05.html#reference.api.common.process">Up</a> </td> <td width="40%" align="right"> <a accesskey="n" href="re54.html">Next</a> </td> </tr> <tr> <td width="40%" align="left" valign="top"> <code class="function">HTML_Progress2::sleep</code> </td> <td width="20%" align="center"> <a accesskey="h" href="index.html">Home</a> </td> <td width="40%" align="right" valign="top"> <code class="function">HTML_Progress2::process</code> </td> </tr> </table> </div> </body> </html>