class AgeFieldFormatter in Age Field Formatter 3.0.x

Same name and namespace in other branches

8.2 src/Plugin/Field/FieldFormatter/AgeFieldFormatter.php \Drupal\age_field_formatter\Plugin\Field\FieldFormatter\AgeFieldFormatter
8 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

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\age_field_formatter\Plugin\Field\FieldFormatter\AgeFieldFormatter implements ContainerFactoryPluginInterface

Expanded class hierarchy of AgeFieldFormatter

File

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

Namespace

Drupal\age_field_formatter\Plugin\Field\FieldFormatter

View source

class AgeFieldFormatter extends FormatterBase implements ContainerFactoryPluginInterface {

  /**
   * The date formatter service.
   *
   * @var \Drupal\Core\Datetime\DateFormatterInterface
   */
  protected $dateFormatter;

  /**
   * The date format entity storage.
   *
   * @var \Drupal\Core\Entity\EntityStorageInterface
   */
  protected $dateFormatStorage;

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    $formatter = new static($plugin_id, $plugin_definition, $configuration['field_definition'], $configuration['settings'], $configuration['label'], $configuration['view_mode'], $configuration['third_party_settings']);
    $container
      ->get('date.formatter');
    $formatter
      ->setDateFormatter($container
      ->get('date.formatter'));
    $formatter
      ->setDateFormat($container
      ->get('entity_type.manager')
      ->getStorage('date_format'));
    return $formatter;
  }

  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() {
    $options = parent::defaultSettings();
    $options['date_format'] = DateTimeItemInterface::DATETIME_STORAGE_FORMAT;
    $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'),
      '#attributes' => array(
        'class' => array(
          'age-format-select',
        ),
      ),
    ];
    $elements['year_suffix'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Display a “years” suffix after the age'),
      '#default_value' => $this
        ->getSetting('year_suffix'),
    ];
    $elements['date_format'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Date/time format'),
      '#description' => $this
        ->t('See <a href="http://php.net/manual/function.date.php" target="_blank">the documentation for PHP date formats</a>.'),
      '#default_value' => $this
        ->getSetting('date_format'),
      '#attributes' => array(
        'class' => array(
          'date-format',
        ),
      ),
    ];
    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;
    }

    /* @TODO
       $date = new DrupalDateTime();
       $this->setTimeZone($date);
       $summary[] = $date->format($this->getSetting('date_format'), $this->getFormatSettings());
        */
    $summary[] = $this
      ->t('Age format: %format', [
      '%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');
    $format = $this
      ->getSetting('date_format');
    $timezone = $this
      ->getSetting('timezone_override');
    $date_raw = $item
      ->getValue();
    $date = strtotime($date_raw['value']);
    $date_formatted = $this->dateFormatter
      ->format($date, 'custom', $format, $timezone != '' ? $timezone : NULL);
    if ($year_suffix == true) {
      $age_suffix = $this->stringTranslation
        ->formatPlural($age, 'year', 'years');
      $age = $age . ' ' . $age_suffix;
    }
    if ($setting == 'birthdate') {
      $age_formatted = $date_formatted . " (" . $agelabel . ": " . $age . ")";
    }
    elseif ($setting == 'birthdate_nolabel') {
      $age_formatted = $date_formatted . " (" . $age . ")";
    }
    else {
      $age_formatted = $age;

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

  /**
   * Sets date formatter.
   *
   * @param \Drupal\Core\Datetime\DateFormatterInterface $date_formatter
   *   The date formatter service.
   */
  public function setDateFormatter(DateFormatterInterface $date_formatter) {
    $this->dateFormatter = $date_formatter;
  }

  /**
   * Sets date format storage.
   *
   * @param \Drupal\Core\Entity\EntityStorageInterface $date_format_storage
   *   The date format storage.
   */
  public function setDateFormat(EntityStorageInterface $date_format_storage) {
    $this->dateFormatStorage = $date_format_storage;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
AgeFieldFormatter::$dateFormatStorage	protected	property	The date format entity storage.
AgeFieldFormatter::$dateFormatter	protected	property	The date formatter service.
AgeFieldFormatter::create	public static	function	Creates an instance of the plugin. Overrides FormatterBase::create
AgeFieldFormatter::defaultSettings	public static	function	Defines the default settings for this plugin. Overrides PluginSettingsBase::defaultSettings
AgeFieldFormatter::setDateFormat	public	function	Sets date format storage.
AgeFieldFormatter::setDateFormatter	public	function	Sets date formatter.
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
DependencySerializationTrait::$_serviceIds	protected	property
DependencySerializationTrait::__sleep	public	function		2
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::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	12
MessengerTrait::$messenger	protected	property	The messenger.	27
MessengerTrait::messenger	public	function	Gets the messenger.	27
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	2
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.	4
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.

You are here

class AgeFieldFormatter in Age Field Formatter 3.0.x

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation