public function Image::rotate in Drupal 9

Same name and namespace in other branches

8 core/lib/Drupal/Core/Image/Image.php \Drupal\Core\Image\Image::rotate()

Rotates an image by the given number of degrees.

Parameters

float $degrees: The number of (clockwise) degrees to rotate the image.

string|null $background: (optional) A hexadecimal integer specifying the background color to use for the uncovered area of the image after the rotation; for example, 0x000000 for black, 0xff00ff for magenta, and 0xffffff for white. When NULL (the default) is specified, for images that support transparency, this will default to transparent; otherwise, it will default to white.

Return value

bool TRUE on success, FALSE on failure.

Overrides ImageInterface::rotate

File

core/lib/Drupal/Core/Image/Image.php, line 183

Class

Image: Defines an image object to represent an image file.

Namespace

Drupal\Core\Image

Code

public function rotate($degrees, $background = NULL) {
  return $this
    ->apply('rotate', [
    'degrees' => $degrees,
    'background' => $background,
  ]);
}

You are here