class Basic in Image Effects 8.3
Same name in this branch
- 8.3 src/Plugin/image_effects/FontSelector/Basic.php \Drupal\image_effects\Plugin\image_effects\FontSelector\Basic
- 8.3 src/Plugin/image_effects/ImageSelector/Basic.php \Drupal\image_effects\Plugin\image_effects\ImageSelector\Basic
Same name and namespace in other branches
- 8 src/Plugin/image_effects/FontSelector/Basic.php \Drupal\image_effects\Plugin\image_effects\FontSelector\Basic
- 8.2 src/Plugin/image_effects/FontSelector/Basic.php \Drupal\image_effects\Plugin\image_effects\FontSelector\Basic
Basic font selector plugin.
Allows typing in the font file URI/path.
Plugin annotation
@Plugin(
id = "basic",
title = @Translation("Basic font selector"),
short_title = @Translation("Basic"),
help = @Translation("Allows typing in the font file URI/path.")
)
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\FontSelector\Basic implements ImageEffectsFontSelectorPluginInterface
- class \Drupal\image_effects\Plugin\ImageEffectsPluginBase implements ImageEffectsPluginBaseInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
Expanded class hierarchy of Basic
1 string reference to 'Basic'
- image_effects.schema.yml in config/
schema/ image_effects.schema.yml - config/schema/image_effects.schema.yml
File
- src/
Plugin/ image_effects/ FontSelector/ Basic.php, line 25
Namespace
Drupal\image_effects\Plugin\image_effects\FontSelectorView source
class Basic extends ImageEffectsPluginBase implements ImageEffectsFontSelectorPluginInterface {
/**
* The file metadata manager service.
*
* @var \Drupal\file_mdm\FileMetadataManagerInterface
*/
protected $fileMetadataManager;
/**
* 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\file_mdm\FileMetadataManagerInterface $file_metadata_manager
* The file metadata manager service.
*/
public function __construct(array $configuration, $plugin_id, $plugin_definition, ConfigFactoryInterface $config_factory, LoggerInterface $logger, FileMetadataManagerInterface $file_metadata_manager) {
parent::__construct($configuration, $plugin_id, $plugin_definition, $config_factory, $logger);
$this->fileMetadataManager = $file_metadata_manager;
}
/**
* {@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('file_metadata_manager'));
}
/**
* {@inheritdoc}
*/
public function selectionElement(array $options = []) {
// Element.
return array_merge([
'#type' => 'textfield',
'#title' => $this
->t('Font URI/path'),
'#description' => $this
->t('An URI, an absolute path, or a relative path. Relative paths will be resolved relative to the Drupal installation directory.'),
'#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($element['#value'])) {
$form_state
->setErrorByName(implode('][', $element['#parents']), $this
->t('The file does not exist.'));
}
}
}
/**
* {@inheritdoc}
*/
public function getDescription($uri) {
return $this->fileMetadataManager
->uri($uri)
->getMetadata('font', 'FullName');
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
Basic:: |
protected | property | The file metadata manager service. | |
Basic:: |
public static | function |
Creates an instance of the plugin. Overrides ImageEffectsPluginBase:: |
|
Basic:: |
public | function |
Get the description of a font file. Overrides ImageEffectsFontSelectorPluginInterface:: |
|
Basic:: |
public | function |
Return a form element to select the plugin content. Overrides ImageEffectsPluginBase:: |
1 |
Basic:: |
public | function | Validation handler for the selection element. | 1 |
Basic:: |
public | function |
Constructs a ImageEffectsPluginBase object. Overrides ImageEffectsPluginBase:: |
|
DependencySerializationTrait:: |
protected | property | An array of entity type IDs keyed by the property name of their storages. | |
DependencySerializationTrait:: |
protected | property | An array of service IDs keyed by property name used for serialization. | |
DependencySerializationTrait:: |
public | function | 1 | |
DependencySerializationTrait:: |
public | function | 2 | |
ImageEffectsPluginBase:: |
protected | property | Configuration object for image_effects. | |
ImageEffectsPluginBase:: |
protected | property | The image_effects logger. | |
ImageEffectsPluginBase:: |
protected | property | The image_effects plugin type. | |
ImageEffectsPluginBase:: |
public | function |
Form constructor. Overrides PluginFormInterface:: |
2 |
ImageEffectsPluginBase:: |
public | function |
Gets default configuration for this plugin. Overrides ConfigurableInterface:: |
2 |
ImageEffectsPluginBase:: |
public | function |
Gets this plugin's configuration. Overrides ConfigurableInterface:: |
|
ImageEffectsPluginBase:: |
public | function |
Get the image_effects plugin type. Overrides ImageEffectsPluginBaseInterface:: |
|
ImageEffectsPluginBase:: |
public static | function |
Determines if plugin can be used. Overrides ImageEffectsPluginBaseInterface:: |
1 |
ImageEffectsPluginBase:: |
public | function |
Sets the configuration for this plugin instance. Overrides ConfigurableInterface:: |
|
ImageEffectsPluginBase:: |
public | function |
Form submission handler. Overrides PluginFormInterface:: |
|
ImageEffectsPluginBase:: |
public | function |
Form validation handler. Overrides PluginFormInterface:: |
|
MessengerTrait:: |
protected | property | The messenger. | 29 |
MessengerTrait:: |
public | function | Gets the messenger. | 29 |
MessengerTrait:: |
public | function | Sets the messenger. | |
PluginBase:: |
protected | property | Configuration information passed into the plugin. | 1 |
PluginBase:: |
protected | property | The plugin implementation definition. | 1 |
PluginBase:: |
protected | property | The plugin_id. | |
PluginBase:: |
constant | A string which is used to separate base plugin IDs from the derivative ID. | ||
PluginBase:: |
public | function |
Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the definition of the plugin implementation. Overrides PluginInspectionInterface:: |
3 |
PluginBase:: |
public | function |
Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface:: |
|
PluginBase:: |
public | function | Determines if the plugin is configurable. | |
StringTranslationTrait:: |
protected | property | The string translation service. | 1 |
StringTranslationTrait:: |
protected | function | Formats a string containing a count of items. | |
StringTranslationTrait:: |
protected | function | Returns the number of plurals supported by a given language. | |
StringTranslationTrait:: |
protected | function | Gets the string translation service. | |
StringTranslationTrait:: |
public | function | Sets the string translation service to use. | 2 |
StringTranslationTrait:: |
protected | function | Translates a string to the current language or to a given language. |