You are here

public function Image::rotate in Zircon Profile 8

Same name and namespace in other branches
  1. 8.0 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) An hexadecimal integer specifying the background color to use for the uncovered area of the image after the rotation. E.g. 0x000000 for black, 0xff00ff for magenta, and 0xffffff for white. For images that support transparency, this will default to transparent. Otherwise it will be white.

Return value

bool TRUE on success, FALSE on failure.

Overrides ImageInterface::rotate

File

core/lib/Drupal/Core/Image/Image.php, line 189
Contains \Drupal\Core\Image\Image.

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', array(
    'degrees' => $degrees,
    'background' => $background,
  ));
}