PHP | Imagick getGravity() Function

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