abstract class ImagemagickImageToolkitOperationBase in ImageMagick 8.3

Base image toolkit operation class for Imagemagick.

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\imagemagick\Plugin\ImageToolkit\Operation\imagemagick\ImagemagickImageToolkitOperationBase

File

src/Plugin/ImageToolkit/Operation/imagemagick/ImagemagickImageToolkitOperationBase.php, line 11

Namespace

Drupal\imagemagick\Plugin\ImageToolkit\Operation\imagemagick

abstract class ImagemagickImageToolkitOperationBase extends ImageToolkitOperationBase {

  /**
   * The correctly typed image toolkit for imagemagick operations.
   *
   * @return \Drupal\imagemagick\Plugin\ImageToolkit\ImagemagickToolkit
   *   The correctly typed image toolkit for imagemagick operations.
   */

  // @codingStandardsIgnoreStart
  protected function getToolkit() {
    return parent::getToolkit();
  }

  // @codingStandardsIgnoreEnd

  /**
   * Helper to add a command line argument.
   *
   * Adds the originating operation and plugin id to the $info array.
   *
   * @param string $argument
   *   The command line argument to be added.
   * @param int $mode
   *   (optional) The mode of the argument in the command line. Determines if
   *   the argument should be placed before or after the source image file path.
   *   Defaults to ImagemagickExecArguments::POST_SOURCE.
   * @param int $index
   *   (optional) The position of the argument in the arguments array.
   *   Reflects the sequence of arguments in the command line. Defaults to
   *   ImagemagickExecArguments::APPEND.
   * @param array $info
   *   (optional) An optional array with information about the argument.
   *   Defaults to an empty array.
   *
   * @return \Drupal\imagemagick\ImagemagickExecArguments
   *   The Imagemagick arguments.
   */
  protected function addArgument(string $argument, int $mode = ImagemagickExecArguments::POST_SOURCE, int $index = ImagemagickExecArguments::APPEND, array $info = []) : ImagemagickExecArguments {
    $plugin_definition = $this
      ->getPluginDefinition();
    $info = array_merge($info, [
      'image_toolkit_operation' => $plugin_definition['operation'],
      'image_toolkit_operation_plugin_id' => $plugin_definition['id'],
    ]);
    return $this
      ->getToolkit()
      ->arguments()
      ->add($argument, $mode, $index, $info);
  }

  /**
   * Helper to escape a command line argument.
   *
   * @param string $argument
   *   The string to escape.
   *
   * @return string
   *   An escaped string for use in the
   *   ImagemagickExecManagerInterface::execute method.
   */
  protected function escapeArgument(string $argument) : string {
    return $this
      ->getToolkit()
      ->arguments()
      ->escape($argument);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
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
ImagemagickImageToolkitOperationBase::addArgument	protected	function	Helper to add a command line argument.
ImagemagickImageToolkitOperationBase::escapeArgument	protected	function	Helper to escape a command line argument.
ImagemagickImageToolkitOperationBase::getToolkit	protected	function	Returns the image toolkit instance for this operation. Overrides ImageToolkitOperationBase::getToolkit
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::arguments	abstract protected	function	Returns the definition of the operation arguments.	8
ImageToolkitOperationBase::execute	abstract protected	function	Performs the actual manipulation on the image.	8
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
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.