Open In App

PHP | Imagick setIteratorIndex() Function

Last Updated : 28 Nov, 2019
Comments
Improve
Suggest changes
Like Article
Like
Report
The Imagick::setIteratorIndex() function is an inbuilt function in PHP which is used to set the image iterator position. This is an alternative for setImageIndex() function. Syntax: 
bool Imagick::setIteratorIndex( int $index )
Parameters: This function accepts a single parameter $index which holds the index. Return Value: This function returns TRUE on success. Exceptions: This function throws ImagickException on error. Below given programs illustrate the Imagick::setIteratorIndex() function in PHP: Program 1: php 
<?php 
  
// Create a new imagick object 
$imagick = new Imagick( 
'https://media.geeksforgeeks.org/wp-content/uploads/20190918234528/colorize1.png');
  
// Add two more images in the same imagick object 
$imagick->addImage( new Imagick(
'https://media.geeksforgeeks.org/wp-content/uploads/geeksforgeeks-13.png')); 

// Currently Cursor is at 1
// Set the Index to 0
$imagick->setIteratorIndex(0);

// getImageBlob should show last added image but
// cursor is set to 0 thus it shows first image
header("Content-Type: image/png");
echo $imagick->getImageBlob();
?>
Output: Program 2: php 
<?php 

// Create a new imagick object 
$imagick = new Imagick( 
'https://media.geeksforgeeks.org/wp-content/uploads/geeksforgeeks-13.png'); 
  
// Add two more images in the same imagick object 
$imagick->addImage( new Imagick( 
'https://media.geeksforgeeks.org/wp-content/uploads/geeksforgeeks-13.png')); 
  
$imagick->addImage( new Imagick( 
'https://media.geeksforgeeks.org/wp-content/uploads/geeksforgeeks-13.png')); 

// Currently Cursor is at 2
// Set the Index to 1
$imagick->setIteratorIndex(1);

// Get the Index 
$index = $imagick->getIteratorIndex(); 
echo $index; 
?>
Output: 
1
Reference: https://www.php.net/manual/en/imagick.setiteratorindex.php

G

gurrrung
Improve
Article Tags :

Explore

Lightbox