class FileAndImageTableFormatter in Open Social 10.2.x
Same name and namespace in other branches
- 10.3.x modules/social_features/social_core/src/Plugin/Field/FieldFormatter/FileAndImageTableFormatter.php \Drupal\social_core\Plugin\Field\FieldFormatter\FileAndImageTableFormatter
- 10.0.x modules/social_features/social_core/src/Plugin/Field/FieldFormatter/FileAndImageTableFormatter.php \Drupal\social_core\Plugin\Field\FieldFormatter\FileAndImageTableFormatter
- 10.1.x modules/social_features/social_core/src/Plugin/Field/FieldFormatter/FileAndImageTableFormatter.php \Drupal\social_core\Plugin\Field\FieldFormatter\FileAndImageTableFormatter
Plugin implementation of the 'file_image_default' formatter.
Plugin annotation
@FieldFormatter(
id = "file_image_default",
label = @Translation("File and Image in a table"),
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\Core\Field\Plugin\Field\FieldFormatter\EntityReferenceFormatterBase
- class \Drupal\file\Plugin\Field\FieldFormatter\FileFormatterBase
- class \Drupal\image\Plugin\Field\FieldFormatter\ImageFormatterBase
- class \Drupal\image\Plugin\Field\FieldFormatter\ImageFormatter
- class \Drupal\social_core\Plugin\Field\FieldFormatter\FileAndImageTableFormatter
- class \Drupal\image\Plugin\Field\FieldFormatter\ImageFormatter
- class \Drupal\image\Plugin\Field\FieldFormatter\ImageFormatterBase
- class \Drupal\file\Plugin\Field\FieldFormatter\FileFormatterBase
- class \Drupal\Core\Field\Plugin\Field\FieldFormatter\EntityReferenceFormatterBase
- 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 FileAndImageTableFormatter
File
- modules/
social_features/ social_core/ src/ Plugin/ Field/ FieldFormatter/ FileAndImageTableFormatter.php, line 21
Namespace
Drupal\social_core\Plugin\Field\FieldFormatterView source
class FileAndImageTableFormatter extends ImageFormatter {
/**
* {@inheritdoc}
*/
public function viewElements(FieldItemListInterface $items, $langcode) {
// Grab elements from the ImageFormatter and see if we can attach files?
$elements = parent::viewElements($items, $langcode);
foreach ($this
->getEntitiesToView($items, $langcode) as $delta => $file) {
$item = $file->_referringItem;
// If it's a File we render it as a file_link.
if (!$this
->isImage($file)) {
$elements[$delta] = [
'#theme' => 'file_link',
'#file' => $file,
'#cache' => [
'tags' => $file
->getCacheTags(),
],
];
// Pass field item attributes to the theme function.
if (isset($item->_attributes)) {
$elements[$delta] += [
'#attributes' => [],
];
$elements[$delta]['#attributes'] += $item->_attributes;
// Unset field item attributes since they have been included in the
// formatter output and should not be rendered in the field template.
unset($item->_attributes);
}
}
else {
// If it's an image we need to add the image width and height
// so Photoswipe knows what to render.
$image = $this
->getImage($file);
$elements[$delta]['#item']->height = $image
->getHeight();
$elements[$delta]['#item']->width = $image
->getWidth();
$elements[$delta]['#item']->is_image = TRUE;
}
}
return $elements;
}
/**
* Check if its a file or image so we know what to render.
*
* @param \Drupal\file\FileInterface $file
* A file entity. This function may resize the file affecting its size.
*
* @return bool
* TRUE when it's an image and not a file
*/
private function isImage(FileInterface $file) {
$image = $this
->getImage($file);
if ($image === NULL) {
return FALSE;
}
return $image
->isValid();
}
/**
* Grab the Image if we are dealing with one.
*
* @param \Drupal\file\FileInterface $file
* A file entity. This function may resize the file affecting its size.
*
* @return \Drupal\Core\Image\ImageInterface
* An Image object.
*/
private function getImage(FileInterface $file) {
// Make sure we deal with a file.
$image_factory = \Drupal::service('image.factory');
return $image_factory
->get($file
->getFileUri());
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
DependencySerializationTrait:: |
protected | property | ||
DependencySerializationTrait:: |
protected | property | ||
DependencySerializationTrait:: |
public | function | 2 | |
DependencySerializationTrait:: |
public | function | 2 | |
EntityReferenceFormatterBase:: |
public | function |
Loads the entities referenced in that field across all the entities being
viewed. Overrides FormatterBase:: |
|
EntityReferenceFormatterBase:: |
public | function |
Overrides FormatterBase:: |
|
FileAndImageTableFormatter:: |
private | function | Grab the Image if we are dealing with one. | |
FileAndImageTableFormatter:: |
private | function | Check if its a file or image so we know what to render. | |
FileAndImageTableFormatter:: |
public | function |
Builds a renderable array for a field value. Overrides ImageFormatter:: |
|
FileFormatterBase:: |
protected | function |
Checks access to the given entity. Overrides EntityReferenceFormatterBase:: |
|
FileFormatterBase:: |
protected | function |
Returns whether the entity referenced by an item needs to be loaded. Overrides EntityReferenceFormatterBase:: |
1 |
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 static | function |
Returns if the formatter can be used for the provided field. Overrides FormatterInterface:: |
14 |
ImageFormatter:: |
protected | property | The current user. | |
ImageFormatter:: |
protected | property | The file URL generator. | |
ImageFormatter:: |
protected | property | The image style entity storage. | |
ImageFormatter:: |
public | function |
Calculates dependencies for the configured plugin. Overrides PluginSettingsBase:: |
|
ImageFormatter:: |
public static | function |
Creates an instance of the plugin. Overrides FormatterBase:: |
1 |
ImageFormatter:: |
public static | function |
Defines the default settings for this plugin. Overrides PluginSettingsBase:: |
1 |
ImageFormatter:: |
public | function |
Informs the plugin that some configuration it depends on will be deleted. Overrides PluginSettingsBase:: |
|
ImageFormatter:: |
public | function |
Returns a form to configure settings for the formatter. Overrides FormatterBase:: |
2 |
ImageFormatter:: |
public | function |
Returns a short summary for the current formatter settings. Overrides FormatterBase:: |
2 |
ImageFormatter:: |
public | function |
Constructs an ImageFormatter object. Overrides FormatterBase:: |
1 |
ImageFormatterBase:: |
protected | function |
Returns the referenced entities for display. Overrides EntityReferenceFormatterBase:: |
|
MessengerTrait:: |
protected | property | The messenger. | 27 |
MessengerTrait:: |
public | function | Gets the messenger. | 27 |
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:: |
2 |
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 |
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 |
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. | 4 |
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. |