<!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>Description</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="imagick.setpointsize.html">Imagick::setPointSize</a></div>
<div class="next" style="text-align: right; float: right;"><a href="imagick.setregistry.html">Imagick::setRegistry</a></div>
<div class="up"><a href="class.imagick.html">Imagick</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="imagick.setprogressmonitor" class="refentry">
<div class="refnamediv">
<h1 class="refname">Imagick::setProgressMonitor</h1>
<p class="verinfo">(No version information available, might only be in Git)</p><p class="refpurpose"><span class="refname">Imagick::setProgressMonitor</span> — <span class="dc-title">Description</span></p>
</div>
<div class="refsect1 description" id="refsect1-imagick.setprogressmonitor-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><strong>Imagick::setProgressMonitor</strong></span>
( <span class="methodparam"><span class="type"><a href="language.types.callable.html" class="type callable">callable</a></span> <code class="parameter">$callback</code></span>
)</div>
<p class="para rdfs-comment">
Set a callback that will be called during the processing of the Imagick image.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-imagick.setprogressmonitor-parameters">
<h3 class="title">Parameters</h3>
<dl>
<dt>
<code class="parameter">callback</code></dt>
<dd>
<p class="para">
The progress function to call. It should return true if image processing should continue, or false if it should be cancelled. The offset parameter indicates the progress and the span parameter indicates the total amount of work needed to be done.
</p>
<div class="methodsynopsis dc-description">
<span class="type">bool</span>
<span class="methodname">
<span class="replaceable">callback</span>
</span>
( <span class="methodparam">
<span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <code class="parameter">$offset</code>
</span>
, <span class="methodparam">
<span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span>
<code class="parameter">$span</code>
</span>
)</div>
<div class="caution"><strong class="caution">Caution</strong>
<p class="para">
The values passed to the callback function are not consistent. In particular the span parameter can increase during image processing. Because of this calculating the percentage complete of an image operation is not trivial.
</p>
</div>
</dd>
</dl>
</div>
<div class="refsect1 returnvalues" id="refsect1-imagick.setprogressmonitor-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns <strong><code>TRUE</code></strong> on success.
</p>
</div>
<div class="refsect1 examples" id="refsect1-imagick.setprogressmonitor-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-4022">
<p><strong>Example #1 <span class="function"><strong>Imagick::setProgressMonitor()</strong></span></strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /> $abortReason </span><span style="color: #007700">= </span><span style="color: #0000BB">null</span><span style="color: #007700">;<br /> <br /> try {<br /> </span><span style="color: #0000BB">$imagick </span><span style="color: #007700">= new \</span><span style="color: #0000BB">Imagick</span><span style="color: #007700">(</span><span style="color: #0000BB">realpath</span><span style="color: #007700">(</span><span style="color: #0000BB">$this</span><span style="color: #007700">-></span><span style="color: #0000BB">control</span><span style="color: #007700">-></span><span style="color: #0000BB">getImagePath</span><span style="color: #007700">()));<br /> </span><span style="color: #0000BB">$startTime </span><span style="color: #007700">= </span><span style="color: #0000BB">time</span><span style="color: #007700">();<br /><br /> </span><span style="color: #0000BB">$callback </span><span style="color: #007700">= function (</span><span style="color: #0000BB">$offset</span><span style="color: #007700">, </span><span style="color: #0000BB">$span</span><span style="color: #007700">) use (</span><span style="color: #0000BB">$startTime</span><span style="color: #007700">, &</span><span style="color: #0000BB">$abortReason</span><span style="color: #007700">) {<br /> if (((</span><span style="color: #0000BB">100 </span><span style="color: #007700">* </span><span style="color: #0000BB">$offset</span><span style="color: #007700">) / </span><span style="color: #0000BB">$span</span><span style="color: #007700">) > </span><span style="color: #0000BB">20</span><span style="color: #007700">) {<br /> </span><span style="color: #0000BB">$abortReason </span><span style="color: #007700">= </span><span style="color: #DD0000">"Processing reached 20%"</span><span style="color: #007700">;<br /> return </span><span style="color: #0000BB">false</span><span style="color: #007700">;<br /> }<br /><br /> </span><span style="color: #0000BB">$nowTime </span><span style="color: #007700">= </span><span style="color: #0000BB">time</span><span style="color: #007700">();<br /><br /> if (</span><span style="color: #0000BB">$nowTime </span><span style="color: #007700">- </span><span style="color: #0000BB">$startTime </span><span style="color: #007700">> </span><span style="color: #0000BB">5</span><span style="color: #007700">) {<br /> </span><span style="color: #0000BB">$abortReason </span><span style="color: #007700">= </span><span style="color: #DD0000">"Image processing took more than 5 seconds"</span><span style="color: #007700">;<br /> return </span><span style="color: #0000BB">false</span><span style="color: #007700">;<br /> }<br /> if ((</span><span style="color: #0000BB">$offset </span><span style="color: #007700">% </span><span style="color: #0000BB">5</span><span style="color: #007700">) == </span><span style="color: #0000BB">0</span><span style="color: #007700">) {<br /> echo </span><span style="color: #DD0000">"Progress: </span><span style="color: #0000BB">$offset</span><span style="color: #DD0000"> / </span><span style="color: #0000BB">$span</span><span style="color: #DD0000"> <br/>"</span><span style="color: #007700">;<br /> }<br /> return </span><span style="color: #0000BB">true</span><span style="color: #007700">;<br /> };<br /><br /> </span><span style="color: #0000BB">$imagick</span><span style="color: #007700">-></span><span style="color: #0000BB">setProgressMonitor</span><span style="color: #007700">(</span><span style="color: #0000BB">$callback</span><span style="color: #007700">);<br /><br /> </span><span style="color: #0000BB">$imagick</span><span style="color: #007700">-></span><span style="color: #0000BB">waveImage</span><span style="color: #007700">(</span><span style="color: #0000BB">2</span><span style="color: #007700">, </span><span style="color: #0000BB">15</span><span style="color: #007700">);<br /><br /> echo </span><span style="color: #DD0000">"Data len is: "</span><span style="color: #007700">.</span><span style="color: #0000BB">strlen</span><span style="color: #007700">(</span><span style="color: #0000BB">$imagick</span><span style="color: #007700">-></span><span style="color: #0000BB">getImageBlob</span><span style="color: #007700">());<br /> }<br /> catch(\</span><span style="color: #0000BB">ImagickException $e</span><span style="color: #007700">) {<br /> if (</span><span style="color: #0000BB">$abortReason </span><span style="color: #007700">!= </span><span style="color: #0000BB">null</span><span style="color: #007700">) {<br /> echo </span><span style="color: #DD0000">"Image processing was aborted: "</span><span style="color: #007700">.</span><span style="color: #0000BB">$abortReason</span><span style="color: #007700">.</span><span style="color: #DD0000">"<br/>"</span><span style="color: #007700">;<br /> }<br /> else {<br /> echo </span><span style="color: #DD0000">"ImagickException caught: "</span><span style="color: #007700">.</span><span style="color: #0000BB">$e</span><span style="color: #007700">-></span><span style="color: #0000BB">getMessage</span><span style="color: #007700">().</span><span style="color: #DD0000">" Exception type is "</span><span style="color: #007700">.</span><span style="color: #0000BB">get_class</span><span style="color: #007700">(</span><span style="color: #0000BB">$e</span><span style="color: #007700">);<br /> }<br /> }<br /><br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="imagick.setpointsize.html">Imagick::setPointSize</a></div>
<div class="next" style="text-align: right; float: right;"><a href="imagick.setregistry.html">Imagick::setRegistry</a></div>
<div class="up"><a href="class.imagick.html">Imagick</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
