class DefineCanvas in Imagick 8

Defines imagick define canvas operation.

Plugin annotation

@ImageToolkitOperation(
  id = "imagick_define_canvas",
  toolkit = "imagick",
  operation = "define_canvas",
  label = @Translation("Define canvas"),
  description = @Translation("Define the canvas of an image.")
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\Core\ImageToolkit\ImageToolkitOperationBase implements ImageToolkitOperationInterface
      • class \Drupal\imagick\Plugin\ImageToolkit\Operation\imagick\ImagickOperationBase uses ImagickOperationTrait
        • class \Drupal\imagick\Plugin\ImageToolkit\Operation\imagick\DefineCanvas

File

src/Plugin/ImageToolkit/Operation/imagick/DefineCanvas.php, line 19

Namespace

Drupal\imagick\Plugin\ImageToolkit\Operation\imagick

class DefineCanvas extends ImagickOperationBase {

  /**
   * {@inheritdoc}
   */
  protected function arguments() {
    return [
      'HEX' => [
        'description' => 'The color of the canvas',
      ],
      'under' => [
        'description' => 'This will create a solid flat layer, probably totally obscuring the source image',
      ],
      'exact_measurements' => [
        'description' => 'Do we have to use exact measurements',
      ],
      'exact' => [
        'description' => 'Exact measurements',
      ],
      'relative' => [
        'description' => 'Relative measurements',
      ],
    ];
  }

  /**
   * {@inheritdoc}
   */
  protected function process(Imagick &$resource, array $arguments) {
    $color = $arguments['HEX'];
    $under = $arguments['under'];
    $exact_size = $arguments['exact_measurements'];
    $exact = $arguments['exact'];
    $relative = $arguments['relative'];
    $canvas = new Imagick();
    $canvas
      ->setFormat($resource
      ->getImageFormat());
    $color = empty($color) ? 'none' : $color;
    if ($exact_size) {
      $width = $this::imagick_percent_filter($exact['width'], $resource
        ->getImageWidth());
      $height = $this::imagick_percent_filter($exact['height'], $resource
        ->getImageHeight());
      list($x, $y) = explode('-', $exact['anchor']);
      $x = image_filter_keyword($x, $width, $resource
        ->getImageWidth());
      $y = image_filter_keyword($y, $height, $resource
        ->getImageHeight());
    }
    else {
      $width = $resource
        ->getImageWidth() + $relative['leftdiff'] + $relative['rightdiff'];
      $height = $resource
        ->getImageHeight() + $relative['topdiff'] + $relative['bottomdiff'];
      $x = $relative['leftdiff'];
      $y = $relative['topdiff'];
    }
    if (!$canvas
      ->newImage($width, $height, new ImagickPixel($color))) {
      return FALSE;
    }
    if ($under && !$canvas
      ->compositeImage($resource, Imagick::COMPOSITE_DEFAULT, $x, $y)) {
      return FALSE;
    }
    $resource = clone $canvas;
    return TRUE;
  }

  /**
   * Helper function to calculate width from percentage
   */
  private function imagick_percent_filter($length_specification, $current_length) {
    if (strpos($length_specification, '%') !== FALSE) {
      $length_specification = $current_length !== NULL ? str_replace('%', '', $length_specification) * 0.01 * $current_length : NULL;
    }
    return $length_specification;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DefineCanvas::arguments	protected	function	Returns the definition of the operation arguments. Overrides ImageToolkitOperationBase::arguments
DefineCanvas::imagick_percent_filter	private	function	Helper function to calculate width from percentage
DefineCanvas::process	protected	function
DependencySerializationTrait::$_entityStorages	protected	property	An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function		1
DependencySerializationTrait::__wakeup	public	function		2
ImageToolkitOperationBase::$logger	protected	property	A logger instance.
ImageToolkitOperationBase::$toolkit	protected	property	The image toolkit.
ImageToolkitOperationBase::apply	final public	function	Applies a toolkit specific operation to an image. Overrides ImageToolkitOperationInterface::apply
ImageToolkitOperationBase::getToolkit	protected	function	Returns the image toolkit instance for this operation.	1
ImageToolkitOperationBase::prepareArguments	protected	function	Checks if required arguments are passed in and adds defaults for non passed in optional arguments.
ImageToolkitOperationBase::validateArguments	protected	function	Validates the arguments.	6
ImageToolkitOperationBase::__construct	public	function	Constructs an image toolkit operation plugin. Overrides PluginBase::__construct
ImagickOperationTrait::execute	protected	function		3
ImagickOperationTrait::processFrames	protected	function	Process image frames for GIFs
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	1
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.	1
PluginBase::$pluginId	protected	property	The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR		constant	A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId	public	function	Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId	public	function	Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition	public	function	Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition	3
PluginBase::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable	public	function	Determines if the plugin is configurable.
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	1
StringTranslationTrait::formatPlural	protected	function	Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals	protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation	protected	function	Gets the string translation service.
StringTranslationTrait::setStringTranslation	public	function	Sets the string translation service to use.	2
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.