class BaseFieldFileFormatterBase
Same name and namespace in other branches
- 10 core/modules/file/src/Plugin/Field/FieldFormatter/BaseFieldFileFormatterBase.php \Drupal\file\Plugin\Field\FieldFormatter\BaseFieldFileFormatterBase
- 11.x core/modules/file/src/Plugin/Field/FieldFormatter/BaseFieldFileFormatterBase.php \Drupal\file\Plugin\Field\FieldFormatter\BaseFieldFileFormatterBase
- 9 core/modules/file/src/Plugin/Field/FieldFormatter/BaseFieldFileFormatterBase.php \Drupal\file\Plugin\Field\FieldFormatter\BaseFieldFileFormatterBase
- 8.9.x core/modules/file/src/Plugin/Field/FieldFormatter/BaseFieldFileFormatterBase.php \Drupal\file\Plugin\Field\FieldFormatter\BaseFieldFileFormatterBase
Base class for file formatters, which allow to link to the file download URL.
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses \Drupal\Core\DependencyInjection\AutowiredInstanceTrait, \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait extends \Drupal\Component\Plugin\PluginBase
- class \Drupal\Core\Field\PluginSettingsBase implements \Drupal\Core\Field\PluginSettingsInterface, \Drupal\Component\Plugin\DependentPluginInterface extends \Drupal\Core\Plugin\PluginBase
- class \Drupal\Core\Field\FormatterBase implements \Drupal\Core\Field\FormatterInterface, \Drupal\Core\Plugin\ContainerFactoryPluginInterface extends \Drupal\Core\Field\PluginSettingsBase
- class \Drupal\file\Plugin\Field\FieldFormatter\BaseFieldFileFormatterBase extends \Drupal\Core\Field\FormatterBase
- class \Drupal\Core\Field\FormatterBase implements \Drupal\Core\Field\FormatterInterface, \Drupal\Core\Plugin\ContainerFactoryPluginInterface extends \Drupal\Core\Field\PluginSettingsBase
- class \Drupal\Core\Field\PluginSettingsBase implements \Drupal\Core\Field\PluginSettingsInterface, \Drupal\Component\Plugin\DependentPluginInterface extends \Drupal\Core\Plugin\PluginBase
- class \Drupal\Core\Plugin\PluginBase uses \Drupal\Core\DependencyInjection\AutowiredInstanceTrait, \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait extends \Drupal\Component\Plugin\PluginBase
Expanded class hierarchy of BaseFieldFileFormatterBase
File
-
core/
modules/ file/ src/ Plugin/ Field/ FieldFormatter/ BaseFieldFileFormatterBase.php, line 15
Namespace
Drupal\file\Plugin\Field\FieldFormatterView source
abstract class BaseFieldFileFormatterBase extends FormatterBase {
/**
* The file URL generator.
*
* @var \Drupal\Core\File\FileUrlGeneratorInterface
*/
protected $fileUrlGenerator;
/**
* Constructs a BaseFieldFileFormatterBase object.
*
* @param string $plugin_id
* The plugin ID for the formatter.
* @param mixed $plugin_definition
* The plugin implementation definition.
* @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
* The definition of the field to which the formatter is associated.
* @param array $settings
* The formatter settings.
* @param string $label
* The formatter label display setting.
* @param string $view_mode
* The view mode.
* @param array $third_party_settings
* Any third party settings.
* @param \Drupal\Core\File\FileUrlGeneratorInterface $file_url_generator
* The file URL generator.
*/
public function __construct($plugin_id, $plugin_definition, FieldDefinitionInterface $field_definition, array $settings, $label, $view_mode, array $third_party_settings, FileUrlGeneratorInterface $file_url_generator) {
parent::__construct($plugin_id, $plugin_definition, $field_definition, $settings, $label, $view_mode, $third_party_settings);
$this->fileUrlGenerator = $file_url_generator;
}
/**
* {@inheritdoc}
*/
public static function defaultSettings() {
$settings['link_to_file'] = FALSE;
return $settings;
}
/**
* {@inheritdoc}
*/
public function settingsForm(array $form, FormStateInterface $form_state) {
$form = parent::settingsForm($form, $form_state);
$form['link_to_file'] = [
'#title' => $this->t('Link this field to the file download URL'),
'#type' => 'checkbox',
'#default_value' => $this->getSetting('link_to_file'),
];
return $form;
}
/**
* {@inheritdoc}
*/
public function viewElements(FieldItemListInterface $items, $langcode) {
$elements = [];
$url = NULL;
// Add support to link to the entity itself.
if ($this->getSetting('link_to_file')) {
$url = $this->fileUrlGenerator
->generate($items->getEntity()
->getFileUri());
}
foreach ($items as $delta => $item) {
$view_value = $this->viewValue($item);
if ($url) {
$elements[$delta] = [
'#type' => 'link',
'#title' => $view_value,
'#url' => $url,
];
}
else {
$elements[$delta] = is_array($view_value) ? $view_value : [
'#markup' => $view_value,
];
}
}
return $elements;
}
/**
* Generate the output appropriate for one field item.
*
* @param \Drupal\Core\Field\FieldItemInterface $item
* One field item.
*
* @return mixed
* The textual output generated.
*/
abstract protected function viewValue(FieldItemInterface $item);
/**
* {@inheritdoc}
*/
public static function isApplicable(FieldDefinitionInterface $field_definition) {
return $field_definition->getTargetEntityTypeId() === 'file';
}
}
Members
| Title Sort descending | Modifiers | Object type | Summary | Overriden Title |
|---|---|---|---|---|
| AutowiredInstanceTrait::createInstanceAutowired | public static | function | Instantiates a new instance of the implementing class using autowiring. | |
| BaseFieldFileFormatterBase::$fileUrlGenerator | protected | property | The file URL generator. | |
| BaseFieldFileFormatterBase::defaultSettings | public static | function | Defines the default settings for this plugin. | Overrides PluginSettingsBase::defaultSettings |
| BaseFieldFileFormatterBase::isApplicable | public static | function | Returns if the formatter can be used for the provided field. | Overrides FormatterBase::isApplicable |
| BaseFieldFileFormatterBase::settingsForm | public | function | Returns a form to configure settings for the formatter. | Overrides FormatterBase::settingsForm |
| BaseFieldFileFormatterBase::viewElements | public | function | Builds a renderable array for a field value. | Overrides FormatterInterface::viewElements |
| BaseFieldFileFormatterBase::viewValue | abstract protected | function | Generate the output appropriate for one field item. | |
| BaseFieldFileFormatterBase::__construct | public | function | Constructs a BaseFieldFileFormatterBase object. | Overrides FormatterBase::__construct |
| 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 | ||
| DependencySerializationTrait::__wakeup | public | function | ||
| FormatterBase::$fieldDefinition | protected | property | The field definition. | |
| FormatterBase::$label | protected | property | The label display setting. | |
| FormatterBase::$settings | protected | property | The formatter settings. | |
| FormatterBase::$viewMode | protected | property | The view mode. | |
| FormatterBase::create | public static | function | ||
| FormatterBase::getFieldSetting | protected | function | Returns the value of a field setting. | |
| FormatterBase::getFieldSettings | protected | function | Returns the array of field settings. | |
| FormatterBase::prepareView | public | function | ||
| FormatterBase::settingsSummary | public | function | ||
| FormatterBase::view | public | function | ||
| MessengerTrait::$messenger | protected | property | The messenger. | |
| MessengerTrait::messenger | public | function | Gets the messenger. | |
| MessengerTrait::setMessenger | public | function | Sets the messenger. | |
| PluginBase::$configuration | protected | property | Configuration information passed into the plugin. | |
| PluginBase::$pluginDefinition | protected | property | The plugin implementation definition. | |
| 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 | ||
| PluginBase::getDerivativeId | public | function | ||
| PluginBase::getPluginDefinition | public | function | ||
| PluginBase::getPluginId | public | function | ||
| PluginSettingsBase::$defaultSettingsMerged | protected | property | Whether default settings have been merged into the current $settings. | |
| PluginSettingsBase::$thirdPartySettings | protected | property | The plugin settings injected by third party modules. | |
| PluginSettingsBase::calculateDependencies | public | function | ||
| PluginSettingsBase::getSetting | public | function | ||
| PluginSettingsBase::getSettings | public | function | ||
| PluginSettingsBase::getThirdPartyProviders | public | function | ||
| PluginSettingsBase::getThirdPartySetting | public | function | ||
| PluginSettingsBase::getThirdPartySettings | public | function | ||
| PluginSettingsBase::mergeDefaults | protected | function | Merges default settings values into $settings. | |
| PluginSettingsBase::onDependencyRemoval | public | function | ||
| PluginSettingsBase::setSetting | public | function | ||
| PluginSettingsBase::setSettings | public | function | ||
| PluginSettingsBase::setThirdPartySetting | public | function | ||
| PluginSettingsBase::unsetThirdPartySetting | public | function | ||
| StringTranslationTrait::$stringTranslation | protected | property | The string translation service. | |
| 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. | |
| StringTranslationTrait::t | protected | function | Translates a string to the current language or to a given language. |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.