class DateTimeTimeAgoFormatter

Same name in other branches
  1. 8.9.x core/modules/datetime/src/Plugin/Field/FieldFormatter/DateTimeTimeAgoFormatter.php \Drupal\datetime\Plugin\Field\FieldFormatter\DateTimeTimeAgoFormatter
  2. 10 core/modules/datetime/src/Plugin/Field/FieldFormatter/DateTimeTimeAgoFormatter.php \Drupal\datetime\Plugin\Field\FieldFormatter\DateTimeTimeAgoFormatter
  3. 11.x core/modules/datetime/src/Plugin/Field/FieldFormatter/DateTimeTimeAgoFormatter.php \Drupal\datetime\Plugin\Field\FieldFormatter\DateTimeTimeAgoFormatter

Plugin implementation of the 'Time ago' formatter for 'datetime' fields.

Plugin annotation


@FieldFormatter(
  id = "datetime_time_ago",
  label = @Translation("Time ago"),
  field_types = {
    "datetime"
  }
)

Hierarchy

Expanded class hierarchy of DateTimeTimeAgoFormatter

File

core/modules/datetime/src/Plugin/Field/FieldFormatter/DateTimeTimeAgoFormatter.php, line 20

Namespace

Drupal\datetime\Plugin\Field\FieldFormatter
View source
class DateTimeTimeAgoFormatter extends TimestampAgoFormatter {
    
    /**
     * {@inheritdoc}
     */
    public function viewElements(FieldItemListInterface $items, $langcode) {
        $elements = [];
        foreach ($items as $delta => $item) {
            $date = $item->date;
            $output = [];
            if (!empty($item->date)) {
                $output = $this->formatDate($date);
            }
            $elements[$delta] = $output;
        }
        return $elements;
    }
    
    /**
     * Formats a date/time as a time interval.
     *
     * @param \Drupal\Core\Datetime\DrupalDateTime|object $date
     *   A date/time object.
     *
     * @return array
     *   The formatted date/time string using the past or future format setting.
     */
    protected function formatDate(DrupalDateTime $date) {
        return parent::formatTimestamp($date->getTimestamp());
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
DateTimeTimeAgoFormatter::formatDate protected function Formats a date/time as a time interval.
DateTimeTimeAgoFormatter::viewElements public function Builds a renderable array for a field value. Overrides TimestampAgoFormatter::viewElements
FormatterBase::$fieldDefinition protected property The field definition.
FormatterBase::$label protected property The label display setting.
FormatterBase::$settings protected property The formatter settings. Overrides PluginSettingsBase::$settings
FormatterBase::$viewMode protected property The view mode.
FormatterBase::getFieldSetting protected function Returns the value of a field setting.
FormatterBase::getFieldSettings protected function Returns the array of field settings.
FormatterBase::isApplicable public static function Returns if the formatter can be used for the provided field. Overrides FormatterInterface::isApplicable 14
FormatterBase::prepareView public function Allows formatters to load information for field values being displayed. Overrides FormatterInterface::prepareView 2
FormatterBase::view public function Builds a renderable array for a fully themed field. Overrides FormatterInterface::view 1
PluginInspectionInterface::getPluginDefinition public function Gets the definition of the plugin implementation. 6
PluginInspectionInterface::getPluginId public function Gets the plugin_id of the plugin instance. 2
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 Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies 6
PluginSettingsBase::getSetting public function Returns the value of a setting, or its default value if absent. Overrides PluginSettingsInterface::getSetting
PluginSettingsBase::getSettings public function Returns the array of settings, including defaults for missing settings. Overrides PluginSettingsInterface::getSettings
PluginSettingsBase::getThirdPartyProviders public function Gets the list of third parties that store information. Overrides ThirdPartySettingsInterface::getThirdPartyProviders
PluginSettingsBase::getThirdPartySetting public function Gets the value of a third-party setting. Overrides ThirdPartySettingsInterface::getThirdPartySetting
PluginSettingsBase::getThirdPartySettings public function Gets all third-party settings of a given module. Overrides ThirdPartySettingsInterface::getThirdPartySettings
PluginSettingsBase::mergeDefaults protected function Merges default settings values into $settings.
PluginSettingsBase::onDependencyRemoval public function Informs the plugin that some configuration it depends on will be deleted. Overrides PluginSettingsInterface::onDependencyRemoval 3
PluginSettingsBase::setSetting public function Sets the value of a setting for the plugin. Overrides PluginSettingsInterface::setSetting
PluginSettingsBase::setSettings public function Sets the settings for the plugin. Overrides PluginSettingsInterface::setSettings
PluginSettingsBase::setThirdPartySetting public function Sets the value of a third-party setting. Overrides ThirdPartySettingsInterface::setThirdPartySetting
PluginSettingsBase::unsetThirdPartySetting public function Unsets a third-party setting. Overrides ThirdPartySettingsInterface::unsetThirdPartySetting
TimestampAgoFormatter::$dateFormatter protected property The date formatter service.
TimestampAgoFormatter::$request protected property The current Request object.
TimestampAgoFormatter::create public static function Creates an instance of the plugin. Overrides FormatterBase::create
TimestampAgoFormatter::defaultSettings public static function Defines the default settings for this plugin. Overrides PluginSettingsBase::defaultSettings
TimestampAgoFormatter::formatTimestamp protected function Formats a timestamp.
TimestampAgoFormatter::settingsForm public function Returns a form to configure settings for the formatter. Overrides FormatterBase::settingsForm
TimestampAgoFormatter::settingsSummary public function Returns a short summary for the current formatter settings. Overrides FormatterBase::settingsSummary
TimestampAgoFormatter::__construct public function Constructs a TimestampAgoFormatter object. Overrides FormatterBase::__construct

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.