You are here

Home » API reference » Age Field Formatter 8 » AgeFieldFormatter.php

class AgeFieldFormatter in Age Field Formatter 8

Same name and namespace in other branches
  1. 8.2 src/Plugin/Field/FieldFormatter/AgeFieldFormatter.php \Drupal\age_field_formatter\Plugin\Field\FieldFormatter\AgeFieldFormatter
  2. 3.0.x src/Plugin/Field/FieldFormatter/AgeFieldFormatter.php \Drupal\age_field_formatter\Plugin\Field\FieldFormatter\AgeFieldFormatter

Plugin implementation of the 'age_field_formatter' formatter.

Plugin annotation


@FieldFormatter(
  id = "age_field_formatter",
  label = @Translation("Age formatter"),
  field_types = {
    "datetime"
  }
)

Hierarchy

Expanded class hierarchy of AgeFieldFormatter

File

src/Plugin/Field/FieldFormatter/AgeFieldFormatter.php, line 23

Namespace

Drupal\age_field_formatter\Plugin\Field\FieldFormatter
View source 
class AgeFieldFormatter extends FormatterBase {

  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() {
    $options = parent::defaultSettings();
    $options['age_format'] = TRUE;
    $options['year_suffix'] = TRUE;
    return $options;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    $elements = parent::settingsForm($form, $form_state);
    $age_formats = [
      'birthdate' => $this
        ->t('Date plus Age with label'),
      'birthdate_nolabel' => $this
        ->t('Date with no Age label'),
      'age_only' => $this
        ->t('Age only'),
    ];
    $elements['age_format'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Date/age format'),
      '#options' => $age_formats,
      '#default_value' => $this
        ->getSetting('age_format'),
    ];
    $elements['year_suffix'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Display a “years” suffix after the age'),
      '#default_value' => $this
        ->getSetting('year_suffix'),
    ];
    return $elements;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsSummary() {
    $summary = [];

    // Implement settings summary.
    $setting = $this
      ->getSetting('age_format');
    $year_suffix = $this
      ->getSetting('year_suffix');
    $year_suffix_summary = $this
      ->t('years suffix');
    if ($setting == 'age_only') {
      $format = $this
        ->t('age only');
    }
    elseif ($setting == 'birthdate_nolabel') {
      $format = $this
        ->t('date (age)');
    }
    else {
      $format = $this
        ->t('date (age: xx)');
    }
    if ($year_suffix == true) {
      $format = $format . ' + ' . $year_suffix_summary;
    }
    $summary[] = $this
      ->t('Age format: %format', array(
      '%format' => $format,
    ));
    return $summary;
  }

  /**
   * {@inheritdoc}
   */
  public function viewElements(FieldItemListInterface $items, $langcode) {
    $elements = [];
    foreach ($items as $delta => $item) {
      $elements[$delta] = [
        '#markup' => $this
          ->viewValue($item),
      ];
    }
    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) {
    $from = new DrupalDateTime($item->date);
    $to = new DrupalDateTime();
    $age = $from
      ->diff($to)->y;
    $agelabel = $this
      ->t('Age');
    $setting = $this
      ->getSetting('age_format');
    $year_suffix = $this
      ->getSetting('year_suffix');
    if ($year_suffix == true) {
      $age_suffix = $this->stringTranslation
        ->formatPlural($age, 'year', 'years');
      $age = $age . ' ' . $age_suffix;
    }
    if ($setting == 'birthdate') {
      $age_formatted = $item->value . " (" . $agelabel . ": " . $age . ")";
    }
    elseif ($setting == 'birthdate_nolabel') {
      $age_formatted = $item->value . " (" . $age . ")";
    }
    else {
      $age_formatted = $age;

      // We do not force prefix a label to the value.
    }
    return nl2br(Html::escape($age_formatted));
  }

}

Members

Namesort descending Modifiers Type Description Overrides
AgeFieldFormatter::defaultSettings public static function Defines the default settings for this plugin. Overrides PluginSettingsBase::defaultSettings
AgeFieldFormatter::settingsForm public function Returns a form to configure settings for the formatter. Overrides FormatterBase::settingsForm
AgeFieldFormatter::settingsSummary public function Returns a short summary for the current formatter settings. Overrides FormatterBase::settingsSummary
AgeFieldFormatter::viewElements public function Builds a renderable array for a field value. Overrides FormatterInterface::viewElements
AgeFieldFormatter::viewValue protected function Generate the output appropriate for one field item.
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 1
DependencySerializationTrait::__wakeup public function 2
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::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create 11
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
FormatterBase::__construct public function Constructs a FormatterBase object. Overrides PluginBase::__construct 11
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
PluginBase::$configuration protected property Configuration information passed into the plugin. 1
PluginBase::$pluginDefinition protected property The plugin implementation definition. 1
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 Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId public function Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition public function Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition 3
PluginBase::getPluginId public function Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable public function Determines if the plugin is configurable.
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
StringTranslationTrait::$stringTranslation protected property The string translation service. 1
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. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.