<html> <head> <title>HTML_Progress::getIncrement</title> <link rel="stylesheet" type="text/css" href="../media/style.css"> </head> <body> <table border="0" cellspacing="0" cellpadding="0" height="48" width="100%"> <tr> <td class="header_top">HTML_Progress</td> </tr> <tr><td class="header_line"><img src="../media/empty.png" width="1" height="1" border="0" alt="" /></td></tr> <tr> <td class="header_menu"> [ <a href="../classtrees_HTML_Progress.html" class="menu">class tree: HTML_Progress</a> ] [ <a href="../elementindex_HTML_Progress.html" class="menu">index: HTML_Progress</a> ] [ <a href="../elementindex.html" class="menu">all elements</a> ] </td> </tr> <tr><td class="header_line"><img src="../media/empty.png" width="1" height="1" border="0" alt="" /></td></tr> </table> <table width="100%" border="0" cellpadding="0" cellspacing="0"> <tr valign="top"> <td> <table cellpadding="10" cellspacing="0" width="100%" border="0"><tr><td valign="top"> <table width="100%" border="0" cellpadding="0" cellspacing="0"> <tr> <td width="10%" align="left" valign="bottom"><a href= "../HTML_Progress/tutorial_progress.geterror.pkg.html">Prev</a></td> <td width="80%" align="center" valign="bottom"></td> <td width="10%" align="right" valign="bottom"><a href= "../HTML_Progress/tutorial_dm.setincrement.pkg.html">Next</a></td> </tr> </table> <div><a name=""></a><div class="ref-title-box"><div class="ref-title"><span class="function">HTML_Progress::getIncrement</span></div> <div class="ref-purpose">returns the progress meter increment value</div></div> <span><a name="synopsis"></a><h2 class="title">Synopsis</h2><div class="ref-synopsis"><p class="func-synopsis">require_once 'HTML/Progress.php';</p> int <span class="function">HTML_Progress::getIncrement</span>()</div></span> <span><a name="description"></a><h2 class="title">Description</h2><p>This method is used to retrieve the increment value in the mathematical model of the progress meter.</p> The default value is set to +1.<br /></span> <span><a name="note"></a><h2 class="title">Note</h2>( HTML_Progress >= 1.0 )<br /> <p><table class="note"><tr><td class="note_img"><img src="../media/important.png"></td><td class="note_text">This function can not be called statically.</td></tr></table></p> <p><table class="note"><tr><td class="note_img"><img src="../media/note.png"></td><td class="note_text">This method is also a wrapper for <strong>HTML_Progress_DM::getIncrement</strong>.</td></tr></table></p></span> <span><a name="see"></a><h2 class="title">See</h2><p><a href="../HTML_Progress/tutorial_dm.setincrement.pkg.html">HTML_Progress::setIncrement</a></p></span> <span><a name="example"></a><h2 class="title">Example</h2><p><div class="listing"><pre><ol><li><span class="src-php"><?php</span></li> <li><span class="src-inc">require_once </span><span class="src-str">'HTML/Progress.php'</span><span class="src-sym">;</span></li> <li> </li> <li><span class="src-var">$bar </span>= <span class="src-key">new </span><span class="src-id"><a href="../HTML_Progress/HTML_Progress.html">HTML_Progress</a></span><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></li> <li> </li> <li><a href="http://www.php.net/printf">printf</a><span class="src-sym">(</span><span class="src-str">'direct way: increment = %d <br/>'</span><span class="src-sym">, </span><span class="src-var">$bar</span><span class="src-sym">-></span><span class="src-id">getIncrement</span><span class="src-sym">(</span><span class="src-sym">))</span><span class="src-sym">;</span></li> <li> </li> <li><span class="src-var">$dm </span>=<span class="src-sym">& </span><span class="src-var">$bar</span><span class="src-sym">-></span><span class="src-id">getDM</span><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></li> <li><a href="http://www.php.net/printf">printf</a><span class="src-sym">(</span><span class="src-str">'another way: increment = %d <br/>'</span><span class="src-sym">, </span><span class="src-var">$dm</span><span class="src-sym">-></span><span class="src-id">getIncrement</span><span class="src-sym">(</span><span class="src-sym">))</span><span class="src-sym">;</span></li> <li><span class="src-php">?></span></li> </ol></pre></div></p></span></div> <table width="100%" border="0" cellpadding="0" cellspacing="0"> <tr> <td width="33%" align="left" valign="top"><a href="../HTML_Progress/tutorial_progress.geterror.pkg.html">Prev</a></td> <td width="34%" align="center" valign="top"><a href= "../HTML_Progress/tutorial_part3-reference.pkg.html">Up</a></td> <td width="33%" align="right" valign="top"><a href= "../HTML_Progress/tutorial_dm.setincrement.pkg.html">Next</a></td> </tr> <tr> <td width="33%" align="left" valign="top"><span class="function">HTML_Progress::getError</span></td> <td width="34%" align="center" valign="top">Reference Guide</td> <td width="33%" align="right" valign="top"><span class="function">HTML_Progress::setIncrement</span></td> </tr> </table> <div class="credit"> <hr /> Documentation generated on Sun, 12 Sep 2004 20:23:15 +0200 by <a href="http://www.phpdoc.org">phpDocumentor 1.3.0RC3</a> </div> </td></tr></table> </td> </tr> </table> </body> </html>