Edit Report a Bug

    Imagick::setProgressMonitor

    (PECL imagick 3 >= 3.3.0)

    Imagick::setProgressMonitor — Description

    Descrierea

    public Imagick::setProgressMonitor ( callable $callback ) : bool

    Set a callback that will be called during the processing of the Imagick image.

    Parametri

    callback

    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.

    callback ( mixed $offset , mixed $span ) : bool
    Precauţie

    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.

    Valorile întoarse

    Întoarce true în caz de succes.

    Exemple

    Example #1 Imagick::setProgressMonitor()

    <?php
            $abortReason     = null;
            
            try {
                    $imagick = new \Imagick(realpath($this->control->getImagePath()));
                    $startTime = time();

                    $callback = function ($offset, $span)  use ($startTime, &$abortReason) {
                    if (((    100 * $offset) / $span)  > 20) {
                            $abortReason = "Processing reached 20%";
                        return     false;
                    }

                        $nowTime = time();

                    if (    $nowTime - $startTime > 5) {
                            $abortReason = "Image processing took more than 5 seconds";
                        return     false;
                    }
                    if ((    $offset % 5) == 0) {
                        echo     "Progress: $offset / $span <br/>";
                    }
                    return     true;
                };

                    $imagick->setProgressMonitor($callback);

                    $imagick->waveImage(2, 15);

                echo     "Data len is: ".strlen($imagick->getImageBlob());
            }
            catch(\    ImagickException $e) {
                if (    $abortReason != null) {
                    echo     "Image processing was aborted: ".$abortReason."<br/>";
                }
                else {
                    echo     "ImagickException caught: ".$e->getMessage()." Exception type is ".get_class($e);
                }
            }

    ?>

    add a note add a note

    User Contributed Notes

    There are no user contributed notes for this page.
    To Top