PHP | Imagick getImageGravity() Function

PHP | Imagick getGravity() Function

Last Updated : 15 Apr, 2020

The Imagick::getGravity() function is an inbuilt function in PHP which is used to get the global gravity property for the Imagick object.

Syntax:

int Imagick::getGravity( void )

Parameters: This function does not accept any parameters.

Exceptions: This function throws ImagickException on error.

Return Value: This function returns an integer value which represents the gravity constant.
List of GRAVITY constants are given below:

imagick::GRAVITY_NORTHWEST (1)
imagick::GRAVITY_NORTH (2)
imagick::GRAVITY_NORTHEAST (3)
imagick::GRAVITY_WEST (4)
imagick::GRAVITY_CENTER (5)
imagick::GRAVITY_EAST (6)
imagick::GRAVITY_SOUTHWEST (7)
imagick::GRAVITY_SOUTH (8)
imagick::GRAVITY_SOUTHEAST (9)

Below programs illustrate the Imagick::getGravity() function in PHP:

Program 1:

<?php 
  
// Create a new imagick object 
$imagick = new Imagick(); 
  
// Get the Gravity 
$gravity = $imagick->getGravity(); 
  
echo $gravity; 
?> 

Output:

0 // Which means gravity is not set.

Program 2:

<?php 
  
// Create a new imagick object 
$imagick = new Imagick( 
'https://media.geeksforgeeks.org/wp-content/uploads/geeksforgeeks-13.png'); 
  
// Set the Gravity 
$imagick->setGravity(3); 
  
// Get the Gravity 
$gravity = $imagick->getGravity(); 
  
echo $gravity; 
?> 

Output:

3 // Which corresponds to imagick::GRAVITY_NORTHEAST.

Reference: https://www.php.net/manual/en/imagick.getgravity.php

PHP | Imagick getImageGravity() Function

gurrrung

Improve

Article Tags :

Similar Reads

PHP | ImagickDraw getGravity() Function

The ImagickDraw::getGravity() function is an inbuilt function in PHP which is used to get the text placement gravity used when annotating with text. Syntax: int ImagickDraw::getGravity( void ) Parameters: This function doesnâ€™t accepts any parameters. Return Value: This function returns an integer va

PHP | Imagick getImageGravity() Function

The Imagick::getImageGravity() function is an inbuilt function in PHP which is used to get the image gravity. Difference between getGravity() and getImageGravity() is that the former applies for the whole Imagick object whereas the latter gets the gravity of the current image (in case of multiple im

PHP | Imagick getFormat() Function

The Imagick::getFormat() function is an inbuilt function in PHP which is used to get the format of the Imagick object. Syntax: string Imagick::getFormat( void ) Parameters: This function does not accept any parameters. Exceptions: This function throws ImagickException on error. Return Value: This fu

PHP | Imagick getRegistry() Function

The Imagick::getRegistry() function is an inbuilt function in PHP which is used to get the StringRegistry entry for the named key or false if not set. Syntax: string Imagick::getRegistry( string $key ) Parameters: This function accepts a single parameter $key which holds the key. Return Value: This

PHP | Imagick getPage() Function

The Imagick::getPage() function is an inbuilt function in PHP which is used to return the geometry of page associated with Imagick object in associative array format. Syntax: array Imagick::getPage( void ) Parameters:This function does not accept any parameter. Return Value: This function returns an

PHP | Imagick getSize() Function

The Imagick::getSize() function is an inbuilt function in PHP which is used to get the size associated with the imagick object. Syntax: array Imagick::getSize( void ) Parameters: This function doesnâ€™t accepts any parameter. Return Value: This function returns an array with the keys "columns" and "ro

PHP | Imagick getImageFormat() Function

The Imagick::getImageFormat() function is an inbuilt function in PHP which is used to get the format of a particular image in a sequence Syntax: string Imagick::getImageFormat( void ) Parameters: This function does not accepts any parameter. Return Value: This function returns a string of the image

PHP | Imagick getFont() Function

The Imagick::getFont() function is an inbuilt function in PHP which is used to get the font. Syntax: int Imagick::getFont( void ) Parameters: This function doesn't accept any parameters. Return Value: This function returns a string containing address of font file on success. Below program illustrate

PHP | Imagick getImageType() Function

The Imagick::getImageType() function is an inbuilt function in PHP which is used to get the potential image type. Syntax: int Imagick::getImageType( void ) Parameters: This function doesnâ€™t accepts any parameter. Return Value: This function returns an integer value corresponding to one of IMGTYPE co

PHP | Imagick getVersion() Function

The Imagick::getVersion() function is an inbuilt function in PHP which is used to get the ImageMagick API version. Syntax: array Imagick::getVersion( void ) Parameters: This function does not accept any parameter. Return Value: This function returns the ImageMagick API version. Below programs illust