abstract class Date in Display Suite 8.2
Same name and namespace in other branches
- 8.4 src/Plugin/DsField/Date.php \Drupal\ds\Plugin\DsField\Date
- 8.3 src/Plugin/DsField/Date.php \Drupal\ds\Plugin\DsField\Date
The base plugin to create DS post date plugins.
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
- class \Drupal\ds\Plugin\DsField\DsFieldBase implements DsFieldInterface
- class \Drupal\ds\Plugin\DsField\Date
- class \Drupal\ds\Plugin\DsField\DsFieldBase implements DsFieldInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
Expanded class hierarchy of Date
5 files declare their use of Date
- CommentChangedDate.php in src/
Plugin/ DsField/ Comment/ CommentChangedDate.php - CommentPostDate.php in src/
Plugin/ DsField/ Comment/ CommentPostDate.php - NodeChangedDate.php in src/
Plugin/ DsField/ Node/ NodeChangedDate.php - NodePostDate.php in src/
Plugin/ DsField/ Node/ NodePostDate.php - NodeSubmittedBy.php in src/
Plugin/ DsField/ Node/ NodeSubmittedBy.php
File
- src/
Plugin/ DsField/ Date.php, line 12
Namespace
Drupal\ds\Plugin\DsFieldView source
abstract class Date extends DsFieldBase {
/**
* The EntityDisplayRepository service.
*
* @var \Drupal\Core\Entity\EntityTypeManagerInterface
*/
protected $entityTypeManager;
/**
* The date formatter service.
*
* @var \Drupal\Core\Datetime\DateFormatterInterface
*/
protected $dateFormatter;
/**
* Constructs a Display Suite field plugin.
*/
public function __construct($configuration, $plugin_id, $plugin_definition, EntityTypeManagerInterface $entity_type_manager, DateFormatterInterface $date_formatter) {
$this->entityTypeManager = $entity_type_manager;
$this->dateFormatter = $date_formatter;
parent::__construct($configuration, $plugin_id, $plugin_definition);
}
/**
* {@inheritdoc}
*/
public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
return new static($configuration, $plugin_id, $plugin_definition, $container
->get('entity_type.manager'), $container
->get('date.formatter'));
}
/**
* {@inheritdoc}
*/
public function build() {
$field = $this
->getFieldConfiguration();
$date_format = str_replace('ds_post_date_', '', $field['formatter']);
$render_key = $this
->getRenderKey();
return array(
'#markup' => $this->dateFormatter
->format($this
->entity()->{$render_key}->value, $date_format),
);
}
/**
* {@inheritdoc}
*/
public function formatters() {
$date_types = $this->entityTypeManager
->getStorage('date_format')
->loadMultiple();
$date_formatters = array();
foreach ($date_types as $machine_name => $value) {
/* @var $value \Drupal\Core\Datetime\DateFormatterInterface */
if ($value
->isLocked()) {
continue;
}
$date_formatters['ds_post_date_' . $machine_name] = $this
->t($value
->id());
}
return $date_formatters;
}
/**
* Returns the entity render key for this field.
*/
public function getRenderKey() {
return '';
}
}
Members
Name![]() |
Modifiers | Type | Description | Overrides |
---|---|---|---|---|
Date:: |
protected | property | The date formatter service. | |
Date:: |
protected | property | The EntityDisplayRepository service. | |
Date:: |
public | function |
Renders a field. Overrides DsFieldBase:: |
1 |
Date:: |
public static | function |
Creates an instance of the plugin. Overrides DsFieldBase:: |
1 |
Date:: |
public | function |
Returns a list of possible formatters for this field. Overrides DsFieldBase:: |
|
Date:: |
public | function | Returns the entity render key for this field. | 4 |
Date:: |
public | function |
Constructs a Display Suite field plugin. Overrides DsFieldBase:: |
1 |
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 | |
DsFieldBase:: |
public | function |
Gets the current bundle. Overrides DsFieldInterface:: |
|
DsFieldBase:: |
public | function |
Calculates dependencies for the configured plugin. Overrides DependentPluginInterface:: |
|
DsFieldBase:: |
public | function |
Gets default configuration for this plugin. Overrides ConfigurablePluginInterface:: |
6 |
DsFieldBase:: |
public | function |
Gets the current entity. Overrides DsFieldInterface:: |
|
DsFieldBase:: |
public | function |
Gets this plugin's configuration. Overrides ConfigurablePluginInterface:: |
1 |
DsFieldBase:: |
public | function |
Gets the current entity type. Overrides DsFieldInterface:: |
|
DsFieldBase:: |
public | function |
Gets the field configuration. Overrides DsFieldInterface:: |
|
DsFieldBase:: |
public | function |
Gets the field name. Overrides DsFieldInterface:: |
|
DsFieldBase:: |
public | function |
Returns the title of the field. Overrides DsFieldInterface:: |
1 |
DsFieldBase:: |
public | function |
Returns if the field is allowed on the field UI screen. Overrides DsFieldInterface:: |
4 |
DsFieldBase:: |
public | function |
Defines if we are dealing with a multivalue field. Overrides DsFieldInterface:: |
1 |
DsFieldBase:: |
public | function |
Sets the configuration for this plugin instance. Overrides ConfigurablePluginInterface:: |
1 |
DsFieldBase:: |
public | function |
The form that holds the settings for this plugin. Overrides DsFieldInterface:: |
7 |
DsFieldBase:: |
public | function |
Returns the summary of the chosen settings. Overrides DsFieldInterface:: |
6 |
DsFieldBase:: |
public | function |
Gets the view mode. Overrides DsFieldInterface:: |
|
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. |