class CollageFormatterImageEffect in Collage Formatter 8

Description of the collageformatter image effect plugin.

Plugin annotation

@ImageEffect(
  id = "collageformatter",
  label = @Translation("Collage Formatter"),
  description = @Translation("Desaturate converts an image to grayscale.")
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\image\ImageEffectBase implements ContainerFactoryPluginInterface, ImageEffectInterface
      • class \Drupal\collageformatter\Plugin\ImageEffect\CollageFormatterImageEffect

File

src/Plugin/ImageEffect/CollageFormatterImageEffect.php, line 25

Contains \Drupal\collageformatter\src\Plugin\ImageEffect\CollageFormatterImageEffect

Namespace

Drupal\collageformatter\Plugin\ImageEffect

class CollageFormatterImageEffect extends ImageEffectBase {

  /**
   * {@inheritdoc}
   */
  public function applyEffect(ImageInterface $image) {
    if (Unicode::strpos(FileSystem::basename($image
      ->getSource()), '_copy_') !== FALSE || Unicode::strpos(FileSystem::basename($image
      ->getSource()), '_symlink_') !== FALSE || Unicode::strpos(FileSystem::basename($image
      ->getSource()), '_fake_') !== FALSE) {
      $dimensions = preg_replace('/.+\\/([\\d]+x[\\d]+)_(copy|symlink|fake)_.+/', '$1', $image
        ->getSource());
      list($image_width, $image_height) = explode('x', $dimensions);
      $original_image_uri = preg_replace('/(.+\\/)collageformatter\\/(.+\\/)[\\d]+x[\\d]+_(copy|symlink|fake)_(.+)/', '$1$2$4', $image
        ->getSource());

      // If it is a fake image - we need to load the real image resource.
      if (Unicode::strpos(FileSystem::basename($image
        ->getSource()), '_fake_') !== FALSE) {
        $original_image = \Drupal::service('image.factory')
          ->get($original_image_uri);
        $image->info = $original_image->info;
        $image->resource = $original_image->resource;
      }
      $effect_callback = 'image_scale_and_crop_effect';
      if (\Drupal::moduleHandler()
        ->moduleExists('focal_point')) {
        $effect_callback = 'focal_point_scale_and_crop_effect';
      }
      if (isset($image_width) && isset($image_height)) {
        return $image
          ->apply($effect_callback, [
          'width' => $image_width,
          'height' => $image_height,
        ]);

        // return $image->scaleAndCrop($image_width, $image_height);
      }
    }
    return FALSE;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
CollageFormatterImageEffect::applyEffect	public	function	Applies an image effect to the image object. Overrides ImageEffectInterface::applyEffect
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
ImageEffectBase::$logger	protected	property	A logger instance.
ImageEffectBase::$uuid	protected	property	The image effect ID.
ImageEffectBase::$weight	protected	property	The weight of the image effect.
ImageEffectBase::calculateDependencies	public	function	Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies
ImageEffectBase::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
ImageEffectBase::defaultConfiguration	public	function	Gets default configuration for this plugin. Overrides ConfigurableInterface::defaultConfiguration	4
ImageEffectBase::getConfiguration	public	function	Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
ImageEffectBase::getDerivativeExtension	public	function	Returns the extension of the derivative after applying this image effect. Overrides ImageEffectInterface::getDerivativeExtension	1
ImageEffectBase::getSummary	public	function	Returns a render array summarizing the configuration of the image effect. Overrides ImageEffectInterface::getSummary	3
ImageEffectBase::getUuid	public	function	Returns the unique ID representing the image effect. Overrides ImageEffectInterface::getUuid
ImageEffectBase::getWeight	public	function	Returns the weight of the image effect. Overrides ImageEffectInterface::getWeight
ImageEffectBase::label	public	function	Returns the image effect label. Overrides ImageEffectInterface::label
ImageEffectBase::setConfiguration	public	function	Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration
ImageEffectBase::setWeight	public	function	Sets the weight for this image effect. Overrides ImageEffectInterface::setWeight
ImageEffectBase::transformDimensions	public	function	Determines the dimensions of the styled image. Overrides ImageEffectInterface::transformDimensions	4
ImageEffectBase::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object. 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.