class DownloadLinkFieldFormatter in Media Entity Download 8.2
Same name and namespace in other branches
- 8 src/Plugin/Field/FieldFormatter/DownloadLinkFieldFormatter.php \Drupal\media_entity_download\Plugin\Field\FieldFormatter\DownloadLinkFieldFormatter
Plugin implementation of the 'media_entity_download_download_link' formatter.
Plugin annotation
@FieldFormatter(
id = "media_entity_download_download_link",
label = @Translation("Download link"),
field_types = {
"file",
"image"
}
)
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
- class \Drupal\Core\Field\PluginSettingsBase implements DependentPluginInterface, PluginSettingsInterface
- class \Drupal\Core\Field\FormatterBase implements FormatterInterface, ContainerFactoryPluginInterface
- class \Drupal\link\Plugin\Field\FieldFormatter\LinkFormatter implements ContainerFactoryPluginInterface
- class \Drupal\media_entity_download\Plugin\Field\FieldFormatter\DownloadLinkFieldFormatter
- class \Drupal\link\Plugin\Field\FieldFormatter\LinkFormatter implements ContainerFactoryPluginInterface
- class \Drupal\Core\Field\FormatterBase implements FormatterInterface, ContainerFactoryPluginInterface
- class \Drupal\Core\Field\PluginSettingsBase implements DependentPluginInterface, PluginSettingsInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
Expanded class hierarchy of DownloadLinkFieldFormatter
File
- src/
Plugin/ Field/ FieldFormatter/ DownloadLinkFieldFormatter.php, line 26
Namespace
Drupal\media_entity_download\Plugin\Field\FieldFormatterView source
class DownloadLinkFieldFormatter extends LinkFormatter {
/**
* {@inheritdoc}
*/
public static function defaultSettings() {
return [
'disposition' => ResponseHeaderBag::DISPOSITION_ATTACHMENT,
] + parent::defaultSettings();
}
/**
* {@inheritdoc}
*/
public function settingsForm(array $form, FormStateInterface $form_state) {
$elements = parent::settingsForm($form, $form_state);
$elements['disposition'] = [
'#type' => 'radios',
'#title' => t('Download behavior'),
'#description' => t('Whether browsers will open a "Save as..." dialog or automatically decide how to handle the download.'),
'#default_value' => $this
->getSetting('disposition'),
'#options' => [
ResponseHeaderBag::DISPOSITION_ATTACHMENT => $this
->t('Force "Save as..." dialog'),
ResponseHeaderBag::DISPOSITION_INLINE => $this
->t('Browser default'),
],
];
return $elements;
}
/**
* {@inheritdoc}
*/
public function settingsSummary() {
$summary = parent::settingsSummary();
$settings = $this
->getSettings();
if ($settings['disposition'] == ResponseHeaderBag::DISPOSITION_ATTACHMENT) {
$summary[] = $this
->t('Force "Save as..." dialog');
}
return $summary;
}
/**
* {@inheritdoc}
*/
public function viewElements(FieldItemListInterface $items, $langcode) {
$elements = [];
$parent = $items
->getParent()
->getValue()
->id();
$settings = $this
->getSettings();
foreach ($items as $delta => $item) {
$route_parameters = [
'media' => $parent,
];
$url_options = [];
if ($delta > 0) {
$route_parameters['query']['delta'] = $delta;
}
// @todo: replace with DI when this issue is fixed: https://www.drupal.org/node/2053415
/** @var \Drupal\file\FileInterface $file */
$file = \Drupal::entityTypeManager()
->getStorage('file')
->load($item->target_id);
if (empty($file)) {
continue;
}
$filename = $file
->getFilename();
$mime_type = $file
->getMimeType();
$url_options['attributes'] = [
'type' => "{$mime_type}; length={$file->getSize()}",
'title' => $filename,
// Classes to add to the file field for icons.
'class' => [
'file',
// Add a specific class for each and every mime type.
'file--mime-' . strtr($mime_type, [
'/' => '-',
'.' => '-',
]),
// Add a more general class for groups of well known MIME types.
'file--' . file_icon_class($mime_type),
],
];
// Add download variant.
$url_options['query'][$settings['disposition']] = NULL;
if ($settings['disposition'] == ResponseHeaderBag::DISPOSITION_INLINE) {
if (!empty($settings['target'])) {
// Link target only relevant for inline downloads (attachment
// downloads will never navigate client locations)
$url_options['attributes']['target'] = $settings['target'];
}
}
if (!empty($settings['rel'])) {
$url_options['attributes']['rel'] = $settings['rel'];
}
$url = Url::fromRoute('media_entity_download.download', $route_parameters, $url_options);
$elements[$delta] = [
'#type' => 'link',
'#url' => $url,
'#title' => $filename,
];
}
return $elements;
}
/**
* Generate the output appropriate for one field item.
*
* @param \Drupal\Core\Field\FieldItemInterface $item
* One field item.
*
* @return string
* The textual output generated.
*/
protected function viewValue(FieldItemInterface $item) {
// The text value has no text format assigned to it, so the user input
// should equal the output, including newlines.
return nl2br(Html::escape($item->value));
}
/**
* {@inheritdoc}
*/
public static function isApplicable(FieldDefinitionInterface $field_definition) {
return $field_definition
->getFieldStorageDefinition()
->getTargetEntityTypeId() == 'media';
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
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 | |
DownloadLinkFieldFormatter:: |
public static | function |
Defines the default settings for this plugin. Overrides LinkFormatter:: |
|
DownloadLinkFieldFormatter:: |
public static | function |
Returns if the formatter can be used for the provided field. Overrides FormatterBase:: |
|
DownloadLinkFieldFormatter:: |
public | function |
Returns a form to configure settings for the formatter. Overrides LinkFormatter:: |
|
DownloadLinkFieldFormatter:: |
public | function |
Returns a short summary for the current formatter settings. Overrides LinkFormatter:: |
|
DownloadLinkFieldFormatter:: |
public | function |
Builds a renderable array for a field value. Overrides LinkFormatter:: |
|
DownloadLinkFieldFormatter:: |
protected | function | Generate the output appropriate for one field item. | |
FormatterBase:: |
protected | property | The field definition. | |
FormatterBase:: |
protected | property | The label display setting. | |
FormatterBase:: |
protected | property |
The formatter settings. Overrides PluginSettingsBase:: |
|
FormatterBase:: |
protected | property | The view mode. | |
FormatterBase:: |
protected | function | Returns the value of a field setting. | |
FormatterBase:: |
protected | function | Returns the array of field settings. | |
FormatterBase:: |
public | function |
Allows formatters to load information for field values being displayed. Overrides FormatterInterface:: |
2 |
FormatterBase:: |
public | function |
Builds a renderable array for a fully themed field. Overrides FormatterInterface:: |
1 |
LinkFormatter:: |
protected | property | The path validator service. | |
LinkFormatter:: |
protected | function | Builds the \Drupal\Core\Url object for a link field item. | |
LinkFormatter:: |
public static | function |
Creates an instance of the plugin. Overrides FormatterBase:: |
|
LinkFormatter:: |
public | function |
Constructs a new LinkFormatter. Overrides FormatterBase:: |
|
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. | |
PluginSettingsBase:: |
protected | property | Whether default settings have been merged into the current $settings. | |
PluginSettingsBase:: |
protected | property | The plugin settings injected by third party modules. | |
PluginSettingsBase:: |
public | function |
Calculates dependencies for the configured plugin. Overrides DependentPluginInterface:: |
6 |
PluginSettingsBase:: |
public | function |
Returns the value of a setting, or its default value if absent. Overrides PluginSettingsInterface:: |
|
PluginSettingsBase:: |
public | function |
Returns the array of settings, including defaults for missing settings. Overrides PluginSettingsInterface:: |
|
PluginSettingsBase:: |
public | function |
Gets the list of third parties that store information. Overrides ThirdPartySettingsInterface:: |
|
PluginSettingsBase:: |
public | function |
Gets the value of a third-party setting. Overrides ThirdPartySettingsInterface:: |
|
PluginSettingsBase:: |
public | function |
Gets all third-party settings of a given module. Overrides ThirdPartySettingsInterface:: |
|
PluginSettingsBase:: |
protected | function | Merges default settings values into $settings. | |
PluginSettingsBase:: |
public | function |
Informs the plugin that some configuration it depends on will be deleted. Overrides PluginSettingsInterface:: |
3 |
PluginSettingsBase:: |
public | function |
Sets the value of a setting for the plugin. Overrides PluginSettingsInterface:: |
|
PluginSettingsBase:: |
public | function |
Sets the settings for the plugin. Overrides PluginSettingsInterface:: |
|
PluginSettingsBase:: |
public | function |
Sets the value of a third-party setting. Overrides ThirdPartySettingsInterface:: |
|
PluginSettingsBase:: |
public | function |
Unsets a third-party setting. Overrides ThirdPartySettingsInterface:: |
|
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. |