Sophie

Sophie

distrib > PLD > ac > amd64 > media > dist > by-pkgid > 82c55661c0e72fc211ea70d3eba10d72 > files > 108

php-pear-HTML_Progress-1.2.5-2.noarch.rpm

<html>
<head>
<title>HTML_Progress_UI::drawCircleSegments</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_ui.getstyle.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_monitor.notify.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_UI::drawCircleSegments</span></div>
  <div class="ref-purpose">draws each of pictures for circle and/or ellipse progress meter</div></div>

 <span><a name="synopsis"></a><h2 class="title">Synopsis</h2><div class="ref-synopsis"><p class="func-synopsis">require_once 'HTML/Progress/UI.php';</p>
   mixed <span class="function">HTML_Progress_UI::drawCircleSegments</span>(
    string <i>$dir = '.'</i>
    string <i>$fileMask = 'c%s.png'</i>)</div></span>

 <span><a name="description"></a><h2 class="title">Description</h2><p>This method is used to create each circle/ellipse segment picture.</p>
  <p><strong>$dir</strong> is the path to final destination of pictures creates by the GD library.</p>
  <p><strong>$fileMask</strong> is a template filename to build each picture segment.</p></span>

 <span><a name="parameter"></a><h2 class="title">Parameter</h2><p><ul class="parameter"><dl><dt>string
      <i>$dir</i><dd>
     <li><p>directory where pictures should be created.</p></li></dl></ul>
    <ul class="parameter"><dl><dt>string
      <i>$fileMask</i><dd>
     <li><p>mask for picture filename (sprintf format).</p></li></dl></ul></p></span>

 <span><a name="throws"></a><h2 class="title">Throws</h2><p><table frame = "border"><p><strong>Possible PEAR_Error values</strong></p><colgroup span = "4"/><thead><tr><td>Error level</td>
       <td>Error code</td>
       <td>Error message</td>
       <td>Solution</td></tr></thead>
     <tbody><tr><td>exception</td>
       <td><b>HTML_PROGRESS_ERROR_INVALID_INPUT</b></td>
       <td>invalid input, parameter #1 &quot;<i>$dir</i>&quot; was expecting &quot;string&quot;</td>
       <td>Fixed the cast of parameter</td></tr>
      <tr><td>exception</td>
       <td><b>HTML_PROGRESS_ERROR_INVALID_INPUT</b></td>
       <td>invalid input, parameter #2 &quot;<i>$fileMask</i>&quot; was expecting &quot;string&quot;</td>
       <td>Fixed the cast of parameter</td></tr></tbody></table></p></span>

 <span><a name="note"></a><h2 class="title">Note</h2>( HTML_Progress &gt;= 1.2.0RC1, Image_Color &gt;= 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></span>

 <span><a name="see"></a><h2 class="title">See</h2><p><a href="../HTML_Progress/tutorial_ui.setcellattributes.pkg.html">HTML_Progress_UI::setCellAttributes</a></p></span>

 <span><a name="example"></a><h2 class="title">Example</h2><p>Example below will produced picture segments for a plain circle progress meter.<br />
   <p><table class="note"><tr><td><img src="../media/example.png"></td><td><img src = "../media/screenshots/circle080.png"/></td></tr></table></p>
   <p><div class="listing"><pre><ol><li><span class="src-php">&lt;?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>&nbsp;</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-id"><a href="../HTML_Progress/_Progress_Progress_php.html#defineHTML_PROGRESS_CIRCLE">HTML_PROGRESS_CIRCLE</a></span><span class="src-sym">)</span><span class="src-sym">;</span></li>
<li>&nbsp;</li>
<li><span class="src-var">$ui </span>=<span class="src-sym">&amp; </span><span class="src-var">$bar</span><span class="src-sym">-&gt;</span><span class="src-id">getUI</span><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></li>
<li><span class="src-var">$ui</span><span class="src-sym">-&gt;</span><a href="../HTML_Progress/Progress_UI/HTML_Progress_UI.html#methodsetStringAttributes">setStringAttributes</a><span class="src-sym">(</span><span class="src-str">'background-color=#eeeeee'</span><span class="src-sym">)</span><span class="src-sym">;</span></li>
<li><span class="src-var">$ui</span><span class="src-sym">-&gt;</span><a href="../HTML_Progress/Progress_UI/HTML_Progress_UI.html#methodsetCellAttributes">setCellAttributes</a><span class="src-sym">(</span><span class="src-key">array</span><span class="src-sym">(</span></li>
<li>    <span class="src-str">'width' </span>=&gt; <span class="src-num">50</span><span class="src-sym">,</span></li>
<li>    <span class="src-str">'height' </span>=&gt; <span class="src-num">50</span><span class="src-sym">,</span></li>
<li>    <span class="src-str">'spacing' </span>=&gt; <span class="src-num">0</span><span class="src-sym">,</span></li>
<li>    <span class="src-str">'background-color' </span>=&gt; <span class="src-str">'#EEEEEE'</span></li>
<li>    <span class="src-sym">))</span><span class="src-sym">;</span></li>
<li>&nbsp;</li>
<li><span class="src-var">$dir </span>= <span class="src-str">'../temp'</span><span class="src-sym">;</span></li>
<li><span class="src-var">$fmask </span>= <span class="src-str">'c%s.png'</span><span class="src-sym">;</span></li>
<li>&nbsp;</li>
<li><span class="src-key">if </span><span class="src-sym">(</span><a href="http://www.php.net/file_exists">file_exists</a><span class="src-sym">(</span><span class="src-str">&quot;</span><span class="src-var">$dir</span>/<span class="src-id">c0</span>.<span class="src-id">png</span><span class="src-str">&quot;</span><span class="src-sym">)) </span><span class="src-sym">{</span></li>
<li>    <span class="src-comm">// uses cached files rather than create it again and again</span></li>
<li>    <span class="src-key">foreach </span><span class="src-sym">(</span><a href="http://www.php.net/range">range</a><span class="src-sym">(</span><span class="src-num">0</span><span class="src-sym">,</span><span class="src-num">10</span><span class="src-sym">) </span><span class="src-key">as </span><span class="src-var">$index</span><span class="src-sym">) </span><span class="src-sym">{</span></li>
<li>        <span class="src-var">$ui</span><span class="src-sym">-&gt;</span><a href="../HTML_Progress/Progress_UI/HTML_Progress_UI.html#methodsetCellAttributes">setCellAttributes</a><span class="src-sym">(</span></li>
<li>            <span class="src-key">array</span><span class="src-sym">(</span><span class="src-str">'background-image' </span>=&gt; <a href="http://www.php.net/sprintf">sprintf</a><span class="src-sym">(</span><span class="src-var">$dir</span>.<span class="src-var">$fmask</span><span class="src-sym">, </span><span class="src-var">$index</span><span class="src-sym">))</span><span class="src-sym">,</span></li>
<li>            <span class="src-var">$index</span></li>
<li>            <span class="src-sym">)</span><span class="src-sym">;</span></li>
<li>    <span class="src-sym">}</span></li>
<li><span class="src-sym">} </span><span class="src-key">else </span><span class="src-sym">{</span></li>
<li>    <span class="src-comm">// creates circle segments pictures only once</span></li>
<li>    <span class="src-var">$ui</span><span class="src-sym">-&gt;</span><a href="../HTML_Progress/Progress_UI/HTML_Progress_UI.html#methoddrawCircleSegments">drawCircleSegments</a><span class="src-sym">(</span><span class="src-var">$dir</span><span class="src-sym">, </span><span class="src-var">$fmask</span><span class="src-sym">)</span><span class="src-sym">;</span></li>
<li><span class="src-sym">}</span></li>
<li><span class="src-php">?&gt;</span></li>
</ol></pre></div></p></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_ui.getstyle.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_monitor.notify.pkg.html">Next</a></td>
</tr>

<tr>
<td width="33%" align="left" valign="top"><span class="function">HTML_Progress_UI::getStyle</span></td>
<td width="34%" align="center" valign="top">Reference Guide</td>
<td width="33%" align="right" valign="top"><span class="function">HTML_Progress_Monitor::notify</span></td>
</tr>
</table>
        <div class="credit">
		    <hr />
		    Documentation generated on Sun, 12 Sep 2004 20:23:31 +0200 by <a href="http://www.phpdoc.org">phpDocumentor 1.3.0RC3</a>
	      </div>
      </td></tr></table>
    </td>
  </tr>
</table>

</body>
</html>