PHP | Imagick getIteratorIndex() Function

0 0 1 minute read

The Imagick::getIteratorIndex() function is an inbuilt function in PHP which is used to get the index of the current active image. This is a alternate for getImageIndex() function.

Syntax:

int Imagick::getIteratorIndex( void )

Parameters: This function doesn’t accepts any parameter.

Return Value: This function returns an integer value containing the index of the image in the stack.

Exceptions: This function throws ImagickException on error.

Below given programs illustrate the Imagick::getIteratorIndex() function in PHP:

Program 1:

<?php  
    
// Create a new imagick object  
$imagick = new Imagick(  
'https://media.zambiatek.com/wp-content/uploads/zambiatek-13.png');  
    
// Get the Index  
$index = $imagick->getIteratorIndex();  
echo $index;  
?>  

Output:

0 // Which means the first image.

Program 2:

<?php  
    
// Create a new imagick object  
$imagick = new Imagick(  
'https://media.zambiatek.com/wp-content/uploads/zambiatek-13.png');  
    
// Add two more images in the same imagick object  
$imagick->addImage( new Imagick(  
'https://media.zambiatek.com/wp-content/uploads/zambiatek-13.png'));  
    
$imagick->addImage( new Imagick(  
'https://media.zambiatek.com/wp-content/uploads/zambiatek-13.png'));  
    
// Get the Index  
$index = $imagick->getIteratorIndex();  
echo $index;  
?>  