class Composite in Imagick 8

Defines imagick blur operation.

Plugin annotation

@ImageToolkitOperation(
  id = "imagick_composite",
  toolkit = "imagick",
  operation = "composite",
  label = @Translation("Composite"),
  description = @Translation("Composite one image onto another at the specified offset.")
)

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\Composite

1 string reference to 'Composite'

CompositeImageEffect::buildConfigurationForm in src/Plugin/ImageEffect/CompositeImageEffect.php

Form constructor.

File

src/Plugin/ImageToolkit/Operation/imagick/Composite.php, line 20

Namespace

Drupal\imagick\Plugin\ImageToolkit\Operation\imagick

class Composite extends ImagickOperationBase {

  /**
   * {@inheritdoc}
   */
  protected function arguments() {
    return [
      'path' => [
        'description' => 'Path to the composite image',
      ],
      'composite' => [
        'description' => 'Composite operator',
      ],
      'x' => [
        'description' => 'The column offset of the composited image',
      ],
      'y' => [
        'description' => 'he row offset of the composited image',
      ],
      'channel' => [
        'description' => 'Provide any channel constant that is valid for your channel mode. It is possible to apply more than one channel.',
      ],
    ];
  }

  /**
   * {@inheritdoc}
   */
  protected function process(Imagick $resource, array $arguments) {

    // Get the correct path
    $path = $arguments['path'];
    if (!UrlHelper::isExternal($path)) {
      $path = \Drupal::service('file_system')
        ->realpath($path);
    }
    if (!file_exists($path)) {
      return FALSE;
    }

    // Get the composite image
    $composite = new Imagick($path);

    // Create channel using bitwise operator
    $channel = array_reduce($arguments['channel'], function ($a, $b) {
      return $a | $b;
    }, 0);
    return $resource
      ->compositeImage($composite, $arguments['composite'], $arguments['x'], $arguments['y'], $channel);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
Composite::arguments	protected	function	Returns the definition of the operation arguments. Overrides ImageToolkitOperationBase::arguments
Composite::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.