You are here

class TransparentBackground in Imagick 8

Defines imagick transparent background operation.

Plugin annotation


@ImageToolkitOperation(
  id = "imagick_transparent_background",
  toolkit = "imagick",
  operation = "transparent_background",
  label = @Translation("Transparent background"),
  description = @Translation("Make image background transparent")
)

Hierarchy

Expanded class hierarchy of TransparentBackground

File

src/Plugin/ImageToolkit/Operation/imagick/TransparentBackground.php, line 18

Namespace

Drupal\imagick\Plugin\ImageToolkit\Operation\imagick
View source
class TransparentBackground extends ImagickOperationBase {

  /**
   * {@inheritdoc}
   */
  protected function arguments() {
    return [];
  }

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

    /* @var $resource Imagick */
    $resource = $this
      ->getToolkit()
      ->getResource();

    // Replace white background with fuchsia
    $floodSuccess = $resource
      ->floodFillPaintImage("rgb(255, 0, 255)", 2500, "rgb(255,255,255)", 0, 0, false);

    // Make fuchsia transparent
    $transparentSuccess = $resource
      ->transparentPaintImage("rgb(255,0,255)", 0, 10, FALSE);

    // Format as PNG
    $formatSuccess = $resource
      ->setImageFormat('PNG');
    return $floodSuccess && $transparentSuccess;
  }

}

Members

Namesort descending 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
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::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.
TransparentBackground::arguments protected function Returns the definition of the operation arguments. Overrides ImageToolkitOperationBase::arguments
TransparentBackground::execute protected function Overrides ImagickOperationTrait::execute