class Dropdown in Image Effects 8

Dropdown image selector plugin.

Provides access to a list of images stored in a directory, specified in configuration.

Plugin annotation

@Plugin(
  id = "dropdown",
  title = @Translation("Dropdown image selector"),
  short_title = @Translation("Dropdown"),
  help = @Translation("Access a list of images stored in the directory specified in configuration.")
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\image_effects\Plugin\ImageEffectsPluginBase implements ImageEffectsPluginBaseInterface
      • class \Drupal\image_effects\Plugin\image_effects\ImageSelector\Dropdown

1 string reference to 'Dropdown'

image_effects.schema.yml in config/schema/image_effects.schema.yml

config/schema/image_effects.schema.yml

File

src/Plugin/image_effects/ImageSelector/Dropdown.php, line 26

Namespace

Drupal\image_effects\Plugin\image_effects\ImageSelector

class Dropdown extends ImageEffectsPluginBase {

  /**
   * The image factory service.
   *
   * @var \Drupal\Core\Image\ImageFactory
   */
  protected $imageFactory;

  /**
   * Constructs a ImageEffectsPluginBase object.
   *
   * @param array $configuration
   *   A configuration array containing information about the plugin instance.
   * @param string $plugin_id
   *   The plugin_id for the plugin instance.
   * @param mixed $plugin_definition
   *   The plugin implementation definition.
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
   *   The configuration factory.
   * @param \Psr\Log\LoggerInterface $logger
   *   The image_effects logger.
   * @param \Drupal\Core\Image\ImageFactory $image_factory
   *   The image factory service.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, ConfigFactoryInterface $config_factory, LoggerInterface $logger, ImageFactory $image_factory) {
    parent::__construct($configuration, $plugin_id, $plugin_definition, $config_factory, $logger);
    $this->imageFactory = $image_factory;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container
      ->get('config.factory'), $container
      ->get('logger.channel.image_effects'), $container
      ->get('image.factory'));
  }

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    return [
      'path' => '',
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state, array $ajax_settings = []) {
    $element['path'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Path'),
      '#default_value' => $this->configuration['path'],
      '#element_validate' => [
        [
          $this,
          'validatePath',
        ],
      ],
      '#maxlength' => 255,
      '#description' => $this
        ->t('Location of the directory where the background images are stored.') . ' ' . $this
        ->t('Relative paths will be resolved relative to the Drupal installation directory.'),
    ];
    return $element;
  }

  /**
   * Validation handler for the 'path' element.
   */
  public function validatePath($element, FormStateInterface $form_state, $form) {
    if (!is_dir($element['#value'])) {
      $form_state
        ->setErrorByName(implode('][', $element['#parents']), $this
        ->t('Invalid directory specified.'));
    }
  }

  /**
   * {@inheritdoc}
   */
  public function selectionElement(array $options = []) {

    // Get list of images.
    $image_files = $this
      ->getList();
    if (empty($image_files)) {
      drupal_set_message($this
        ->t('No images available. Make sure at least one image is available in the directory specified in the <a href=":url">configuration page</a>.', [
        ':url' => Url::fromRoute('image_effects.settings')
          ->toString(),
      ]), 'warning');
    }

    // Strip the path from the URI.
    $options['#default_value'] = isset($options['#default_value']) ? pathinfo($options['#default_value'], PATHINFO_BASENAME) : '';

    // Element.
    return array_merge([
      '#type' => 'select',
      '#title' => $this
        ->t('Image'),
      '#description' => $this
        ->t('Select an image.'),
      '#options' => array_combine($image_files, $image_files),
      '#element_validate' => [
        [
          $this,
          'validateSelectorUri',
        ],
      ],
    ], $options);
  }

  /**
   * Validation handler for the selection element.
   */
  public function validateSelectorUri($element, FormStateInterface $form_state, $form) {
    if (!empty($element['#value'])) {
      if (file_exists($file_path = $this->configuration['path'] . '/' . $element['#value'])) {
        $form_state
          ->setValueForElement($element, $file_path);
      }
      else {
        $form_state
          ->setErrorByName(implode('][', $element['#parents']), $this
          ->t('The selected file does not exist.'));
      }
    }
  }

  /**
   * Returns an array of files with image extensions in the specified directory.
   *
   * @return array
   *   Array of image files.
   */
  protected function getList() {
    $filelist = [];
    if (is_dir($this->configuration['path']) && ($handle = opendir($this->configuration['path']))) {
      while ($file = readdir($handle)) {
        $extension = pathinfo($file, PATHINFO_EXTENSION);
        if (in_array($extension, $this->imageFactory
          ->getSupportedExtensions())) {
          $filelist[] = $file;
        }
      }
      closedir($handle);
    }
    return $filelist;
  }

}

Members

Name	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
Dropdown::$imageFactory	protected	property	The image factory service.
Dropdown::buildConfigurationForm	public	function	Form constructor. Overrides ImageEffectsPluginBase::buildConfigurationForm
Dropdown::create	public static	function	Creates an instance of the plugin. Overrides ImageEffectsPluginBase::create
Dropdown::defaultConfiguration	public	function	Gets default configuration for this plugin. Overrides ImageEffectsPluginBase::defaultConfiguration
Dropdown::getList	protected	function	Returns an array of files with image extensions in the specified directory.
Dropdown::selectionElement	public	function	Return a form element to select the plugin content. Overrides ImageEffectsPluginBase::selectionElement
Dropdown::validatePath	public	function	Validation handler for the 'path' element.
Dropdown::validateSelectorUri	public	function	Validation handler for the selection element.
Dropdown::__construct	public	function	Constructs a ImageEffectsPluginBase object. Overrides ImageEffectsPluginBase::__construct
ImageEffectsPluginBase::$config	protected	property	Configuration object for image_effects.
ImageEffectsPluginBase::$logger	protected	property	The image_effects logger.
ImageEffectsPluginBase::$pluginType	protected	property	The image_effects plugin type.
ImageEffectsPluginBase::calculateDependencies	public	function	Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies
ImageEffectsPluginBase::getConfiguration	public	function	Gets this plugin's configuration. Overrides ConfigurablePluginInterface::getConfiguration
ImageEffectsPluginBase::getType	public	function	Get the image_effects plugin type. Overrides ImageEffectsPluginBaseInterface::getType
ImageEffectsPluginBase::isAvailable	public static	function	Determines if plugin can be used. Overrides ImageEffectsPluginBaseInterface::isAvailable	1
ImageEffectsPluginBase::setConfiguration	public	function	Sets the configuration for this plugin instance. Overrides ConfigurablePluginInterface::setConfiguration
ImageEffectsPluginBase::submitConfigurationForm	public	function	Form submission handler. Overrides PluginFormInterface::submitConfigurationForm
ImageEffectsPluginBase::validateConfigurationForm	public	function	Form validation handler. Overrides PluginFormInterface::validateConfigurationForm
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.