You are here

class Polaroid in Imagick 8

Defines imagick oilpaint operation.

Plugin annotation


@ImageToolkitOperation(
  id = "imagick_polaroid",
  toolkit = "imagick",
  operation = "polaroid",
  label = @Translation("Polaroid"),
  description = @Translation("Adds a polaroid effect to the image.")
)

Hierarchy

Expanded class hierarchy of Polaroid

File

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

Namespace

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

  /**
   * {@inheritdoc}
   */
  protected function arguments() {
    return [
      'angle' => [
        'description' => 'The angle of the polaroid effect.',
      ],
    ];
  }

  /**
   * {@inheritdoc}
   */
  protected function process(Imagick $resource, array $arguments) {
    $angle = $arguments['angle'];

    // Generate a random angle when field is empty
    if (empty($angle)) {
      $angle = mt_rand(-30, 30);
    }
    return $resource
      ->polaroidImage(new ImagickDraw(), $angle);
  }

}

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::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.
Polaroid::arguments protected function Returns the definition of the operation arguments. Overrides ImageToolkitOperationBase::arguments
Polaroid::process protected function
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.