class SetCanvas in Image Effects 8

Defines ImageMagick set canvas operation.

Plugin annotation

@ImageToolkitOperation(
  id = "image_effects_imagemagick_set_canvas",
  toolkit = "imagemagick",
  operation = "set_canvas",
  label = @Translation("Set canvas"),
  description = @Translation("Lay the image over a colored canvas.")
)

Hierarchy

• class \Drupal\image_effects\Plugin\ImageToolkit\Operation\imagemagick\SetCanvas extends \Drupal\imagemagick\Plugin\ImageToolkit\Operation\imagemagick\ImagemagickImageToolkitOperationBase uses ImagemagickOperationTrait, SetCanvasTrait

File

src/Plugin/ImageToolkit/Operation/imagemagick/SetCanvas.php, line 19

Namespace

Drupal\image_effects\Plugin\ImageToolkit\Operation\imagemagick

class SetCanvas extends ImagemagickImageToolkitOperationBase {
  use ImagemagickOperationTrait;
  use SetCanvasTrait;

  /**
   * {@inheritdoc}
   */
  protected function execute(array $arguments) {

    // Calculate geometry.
    $geometry = sprintf('%dx%d', $arguments['width'], $arguments['height']);
    if ($arguments['x_pos'] || $arguments['y_pos']) {
      $geometry .= sprintf('%+d%+d', -$arguments['x_pos'], -$arguments['y_pos']);
    }

    // Determine background.
    if ($arguments['canvas_color']) {
      $bg = '-background ' . $this
        ->getToolkit()
        ->escapeShellArg($arguments['canvas_color']);
    }
    else {
      $format = $this
        ->getToolkit()
        ->getDestinationFormat() ?: $this
        ->getToolkit()
        ->getSourceFormat();
      $mime_type = $this
        ->getFormatMapper()
        ->getMimeTypeFromFormat($format);
      if ($mime_type === 'image/jpeg') {

        // JPEG does not allow transparency. Set to white.
        // @todo allow to be configurable.
        $bg = '-background ' . $this
          ->getToolkit()
          ->escapeShellArg('#FFFFFF');
      }
      else {
        $bg = '-background transparent';
      }
    }

    // Add argument.
    $this
      ->getToolkit()
      ->addArgument("-gravity none {$bg} -compose src-over -extent {$geometry}");

    // Set dimensions.
    $this
      ->getToolkit()
      ->setWidth($arguments['width'])
      ->setHeight($arguments['height']);
    return TRUE;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ImagemagickOperationTrait::$formatMapper	protected	property	The format mapper service.
ImagemagickOperationTrait::getFormatMapper	protected	function	Returns the format mapper service.
SetCanvas::execute	protected	function
SetCanvasTrait::arguments	protected	function
SetCanvasTrait::validateArguments	protected	function