class AdvanceResize in image effect 2.0.x

Defines GD2 advance resize operation.

Plugin annotation

@ImageToolkitOperation(
  id = "gd_advance_resize",
  toolkit = "gd",
  operation = "advance_resize",
  label = @Translation("Advance Resize"),
  description = @Translation("Advance Resizes an image to the given dimensions, add white background if need.")
)

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\system\Plugin\ImageToolkit\Operation\gd\GDImageToolkitOperationBase
        • class \Drupal\image_effect\Plugin\ImageToolkit\Operation\gd\AdvanceResize

File

src/Plugin/ImageToolkit/Operation/gd/AdvanceResize.php, line 17

Namespace

Drupal\image_effect\Plugin\ImageToolkit\Operation\gd

class AdvanceResize extends GDImageToolkitOperationBase {

  /**
   * {@inheritdoc}
   */
  protected function arguments() {
    return [
      'width' => [
        'description' => 'The new width of the resized image, in pixels',
      ],
      'height' => [
        'description' => 'The new height of the resized image, in pixels',
      ],
    ];
  }

  /**
   * {@inheritdoc}
   */
  protected function validateArguments(array $arguments) {

    // Assure integers for all arguments.
    $arguments['width'] = (int) round($arguments['width']);
    $arguments['height'] = (int) round($arguments['height']);

    // Fail when width or height are 0 or negative.
    if ($arguments['width'] <= 0) {
      throw new \InvalidArgumentException("Invalid width ('{$arguments['width']}') specified for the image 'resize' operation");
    }
    if ($arguments['height'] <= 0) {
      throw new \InvalidArgumentException("Invalid height ('{$arguments['height']}') specified for the image 'resize' operation");
    }
    return $arguments;
  }

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

    // Create a new resource of the required dimensions, and copy and resize
    // the original resource on it with resampling. Destroy the original
    // resource upon success.
    $w = $arguments['width'];
    $h = $arguments['height'];
    $src_x = 0;
    $src_y = 0;
    $src_w = $this
      ->getToolkit()
      ->getWidth();
    $src_h = $this
      ->getToolkit()
      ->getHeight();
    $dst_w = $src_w;
    $dst_h = $src_h;
    $dst_x = 0;
    $dst_y = 0;
    if ($w > $src_w) {
      $dst_x = ($w - $src_w) / 2;
    }
    if ($h > $src_h) {
      $dst_y = ($h - $src_h) / 2;
    }
    $original_resource = $this
      ->getToolkit()
      ->getResource();
    $data = [
      'width' => $arguments['width'],
      'height' => $arguments['height'],
      'extension' => image_type_to_extension($this
        ->getToolkit()
        ->getType(), FALSE),
      'transparent_color' => $this
        ->getToolkit()
        ->getTransparentColor(),
      'is_temp' => TRUE,
    ];
    if ($this
      ->getToolkit()
      ->apply('create_new', $data)) {
      $backgroundColor = imagecolorallocate($this
        ->getToolkit()
        ->getResource(), 255, 255, 255);
      imagefill($this
        ->getToolkit()
        ->getResource(), 0, 0, $backgroundColor);
      if (imagecopyresampled($this
        ->getToolkit()
        ->getResource(), $original_resource, $dst_x, $dst_y, $src_x, $src_y, $dst_w, $dst_h, $src_w, $src_h)) {
        imagedestroy($original_resource);
        return TRUE;
      }
      else {

        // In case of failure, destroy the temporary resource and restore
        // the original one.
        imagedestroy($this
          ->getToolkit()
          ->getResource());
        $this
          ->getToolkit()
          ->setResource($original_resource);
      }
    }
    return FALSE;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
AdvanceResize::arguments	protected	function	Returns the definition of the operation arguments. Overrides ImageToolkitOperationBase::arguments
AdvanceResize::execute	protected	function	Performs the actual manipulation on the image. Overrides ImageToolkitOperationBase::execute
AdvanceResize::validateArguments	protected	function	Validates the arguments. Overrides ImageToolkitOperationBase::validateArguments
DependencySerializationTrait::$_entityStorages	protected	property
DependencySerializationTrait::$_serviceIds	protected	property
DependencySerializationTrait::__sleep	public	function		2
DependencySerializationTrait::__wakeup	public	function		2
GDImageToolkitOperationBase::getToolkit	protected	function	The correctly typed image toolkit for GD operations. 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::prepareArguments	protected	function	Checks if required arguments are passed in and adds defaults for non passed in optional arguments.
ImageToolkitOperationBase::__construct	public	function	Constructs an image toolkit operation plugin. Overrides PluginBase::__construct
MessengerTrait::$messenger	protected	property	The messenger.	27
MessengerTrait::messenger	public	function	Gets the messenger.	27
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	2
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.	4
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.