You are here

class Dropdown in Image Effects 8

Same name in this branch
  1. 8 src/Plugin/image_effects/FontSelector/Dropdown.php \Drupal\image_effects\Plugin\image_effects\FontSelector\Dropdown
  2. 8 src/Plugin/image_effects/ImageSelector/Dropdown.php \Drupal\image_effects\Plugin\image_effects\ImageSelector\Dropdown
Same name and namespace in other branches
  1. 8.3 src/Plugin/image_effects/FontSelector/Dropdown.php \Drupal\image_effects\Plugin\image_effects\FontSelector\Dropdown
  2. 8.2 src/Plugin/image_effects/FontSelector/Dropdown.php \Drupal\image_effects\Plugin\image_effects\FontSelector\Dropdown

Dropdown font selector plugin.

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

Plugin annotation


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

Hierarchy

Expanded class hierarchy of 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/FontSelector/Dropdown.php, line 21

Namespace

Drupal\image_effects\Plugin\image_effects\FontSelector
View source
class Dropdown extends Basic {

  /**
   * {@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'],
      '#maxlength' => 255,
      '#element_validate' => [
        [
          $this,
          'validatePath',
        ],
      ],
      '#description' => $this
        ->t('Location of the directory where the fonts 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 font names.
    $fonts_list = $this
      ->getList();
    if (empty($fonts_list)) {
      $this->logger
        ->warning('No fonts available. Make sure at least one font is available in the directory specified in the <a href=":url">configuration page</a>.', [
        ':url' => Url::fromRoute('image_effects.settings')
          ->toString(),
      ]);
      return [];
    }

    // 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('Font'),
      '#description' => $this
        ->t('Select a font.'),
      '#options' => $fonts_list,
      '#limit_validation_errors' => FALSE,
      '#required' => TRUE,
      '#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.'));
      }
    }
  }

  /**
   * Return an array of fonts.
   *
   * Scans through files available in the directory specified through
   * configuration.
   *
   * @return array
   *   Array of font names.
   */
  protected function getList() {
    $filelist = [];
    if (is_dir($this->configuration['path']) && ($handle = opendir($this->configuration['path']))) {
      while ($file_name = readdir($handle)) {
        if (preg_match("/\\.[ot]tf\$/i", $file_name) == 1) {
          $filelist[$file_name] = trim(substr($file_name, 0, -4));
          $font = $this
            ->getData($this->configuration['path'] . '/' . $file_name);
          if (!empty($font['name'])) {
            $filelist[$file_name] = $font['name'];
          }
        }
      }
      closedir($handle);
    }
    asort($filelist);
    return $filelist;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
Basic::dec2hex protected function Convert a dec to a hex.
Basic::getData protected function Return the font information.
Basic::getDescription public function Get the description of a font file. Overrides ImageEffectsFontSelectorPluginInterface::getDescription
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::buildConfigurationForm public function Form constructor. Overrides ImageEffectsPluginBase::buildConfigurationForm
Dropdown::defaultConfiguration public function Gets default configuration for this plugin. Overrides ImageEffectsPluginBase::defaultConfiguration
Dropdown::getList protected function Return an array of fonts.
Dropdown::selectionElement public function Return a form element to select the plugin content. Overrides Basic::selectionElement
Dropdown::validatePath public function Validation handler for the 'path' element.
Dropdown::validateSelectorUri public function Validation handler for the selection element. Overrides Basic::validateSelectorUri
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::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create 1
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
ImageEffectsPluginBase::__construct public function Constructs a ImageEffectsPluginBase object. Overrides PluginBase::__construct 1
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.