CreateNew
class CreateNew extends GDImageToolkitOperationBase (View source)
Defines GD2 create_new image operation.
Traits
Wrapper methods for \Drupal\Core\StringTranslation\TranslationInterface.
Provides dependency injection friendly methods for serialization.
Provides a trait for the messenger service.
Constants
| DERIVATIVE_SEPARATOR |
A string which is used to separate base plugin IDs from the derivative ID. |
Properties
| protected string | $pluginId | The plugin_id. |
from PluginBase |
| protected array | $pluginDefinition | The plugin implementation definition. |
from PluginBase |
| protected array | $configuration | Configuration information passed into the plugin. |
from PluginBase |
| protected TranslationInterface | $stringTranslation | The string translation service. |
from StringTranslationTrait |
| protected array | $_serviceIds | An array of service IDs keyed by property name used for serialization. |
from DependencySerializationTrait |
| protected array | $_entityStorages | An array of entity type IDs keyed by the property name of their storages. |
from DependencySerializationTrait |
| protected MessengerInterface | $messenger | The messenger. |
from MessengerTrait |
| protected ImageToolkitInterface | $toolkit | The image toolkit. |
from ImageToolkitOperationBase |
| protected LoggerInterface | $logger | A logger instance. |
from ImageToolkitOperationBase |
Methods
Constructs an image toolkit operation plugin.
Translates a string to the current language or to a given language.
Formats a string containing a count of items.
Returns the number of plurals supported by a given language.
Gets the string translation service.
The correctly typed image toolkit for GD operations.
Returns the definition of the operation arguments.
Checks if required arguments are passed in and adds defaults for non passed in optional arguments.
Validates the arguments.
Applies a toolkit specific operation to an image.
Performs the actual manipulation on the image.
Details
__construct(array $configuration, string $plugin_id, mixed $plugin_definition, ImageToolkitInterface $toolkit, LoggerInterface $logger)
Constructs an image toolkit operation plugin.
string
getPluginId()
Gets the plugin_id of the plugin instance.
string
getBaseId()
Gets the base_plugin_id of the plugin instance.
string|null
getDerivativeId()
Gets the derivative_id of the plugin instance.
array
getPluginDefinition()
Gets the definition of the plugin implementation.
bool
isConfigurable()
Determines if the plugin is configurable.
protected TranslatableMarkup
t(string $string, array $args = [], array $options = [])
Translates a string to the current language or to a given language.
See \Drupal\Core\StringTranslation\TranslatableMarkup::__construct() for important security information and usage guidelines.
In order for strings to be localized, make them available in one of the ways supported by the
protected
formatPlural($count, $singular, $plural, array $args = [], array $options = [])
Formats a string containing a count of items.
protected
getNumberOfPlurals($langcode = NULL)
Returns the number of plurals supported by a given language.
protected TranslationInterface
getStringTranslation()
Gets the string translation service.
$this
setStringTranslation(TranslationInterface $translation)
Sets the string translation service to use.
__sleep()
{@inheritdoc}
__wakeup()
{@inheritdoc}
setMessenger(MessengerInterface $messenger)
Sets the messenger.
MessengerInterface
messenger()
Gets the messenger.
protected ImageToolkitInterface
getToolkit()
The correctly typed image toolkit for GD operations.
protected array
arguments()
Returns the definition of the operation arguments.
Image toolkit operation implementers must implement this method to "document" their operation, thus also if no arguments are expected.
protected array
prepareArguments(array $arguments)
Checks if required arguments are passed in and adds defaults for non passed in optional arguments.
Image toolkit operation implementers should not normally need to override this method as they should place their own validation in validateArguments.
protected array
validateArguments(array $arguments)
Validates the arguments.
Image toolkit operation implementers should place any argument validation in this method, throwing an InvalidArgumentException when an error is encountered.
Validation typically includes things like:
- Checking that width and height are not negative.
- Checking that a color value is indeed a color.
But validation may also include correcting the arguments, e.g:
- Casting arguments to the correct type.
- Rounding pixel values to an integer.
This base implementation just returns the array of arguments and thus does not need to be called by overriding methods.
final bool
apply(array $arguments)
Applies a toolkit specific operation to an image.
protected bool
execute(array $arguments)
Performs the actual manipulation on the image.
Image toolkit operation implementers must implement this method. This method is responsible for actually performing the operation on the image. When this method gets called, the implementer may assume all arguments, also the optional ones, to be available, validated and corrected.