class FieldTimerSimpleTextFormatter in Field Timer 8

Same name and namespace in other branches

2.x src/Plugin/Field/FieldFormatter/FieldTimerSimpleTextFormatter.php \Drupal\field_timer\Plugin\Field\FieldFormatter\FieldTimerSimpleTextFormatter

Plugin implementation of the 'field_timer_simple_text' formatter.

Plugin annotation


@FieldFormatter(
  id = "field_timer_simple_text",
  label = @Translation("Text timer or countdown"),
  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\Core\Field\Plugin\Field\FieldFormatter\TimestampAgoFormatter implements ContainerFactoryPluginInterface
    class \Drupal\datetime\Plugin\Field\FieldFormatter\DateTimeTimeAgoFormatter
    class \Drupal\field_timer\Plugin\Field\FieldFormatter\FieldTimerSimpleTextFormatter

Expanded class hierarchy of FieldTimerSimpleTextFormatter

File

src/Plugin/Field/FieldFormatter/FieldTimerSimpleTextFormatter.php, line 25

Namespace

Drupal\field_timer\Plugin\Field\FieldFormatter

View source

class FieldTimerSimpleTextFormatter extends DateTimeTimeAgoFormatter {

  /**
   * @var \Drupal\Component\Datetime\TimeInterface
   */
  protected $time;

  /**
   * FieldTimerSimpleTextFormatter constructor.
   *
   * @param $plugin_id
   * @param $plugin_definition
   * @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
   * @param array $settings
   * @param $label
   * @param $view_mode
   * @param array $third_party_settings
   * @param \Drupal\Core\Datetime\DateFormatterInterface $date_formatter
   * @param \Symfony\Component\HttpFoundation\Request $request
   * @param \Drupal\Component\Datetime\TimeInterface $time
   */
  public function __construct($plugin_id, $plugin_definition, FieldDefinitionInterface $field_definition, array $settings, $label, $view_mode, array $third_party_settings, DateFormatterInterface $date_formatter, Request $request, TimeInterface $time) {
    parent::__construct($plugin_id, $plugin_definition, $field_definition, $settings, $label, $view_mode, $third_party_settings, $date_formatter, $request);
    $this->time = $time;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($plugin_id, $plugin_definition, $configuration['field_definition'], $configuration['settings'], $configuration['label'], $configuration['view_mode'], $configuration['third_party_settings'], $container
      ->get('date.formatter'), $container
      ->get('request_stack')
      ->getCurrentRequest(), $container
      ->get('datetime.time'));
  }

  /**
   * Formatter types.
   */
  const TYPE_AUTO = 'auto', TYPE_TIMER = 'timer', TYPE_COUNTDOWN = 'countdown';

  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() {
    $settings = [
      'type' => static::TYPE_AUTO,
    ] + parent::defaultSettings();
    return $settings;
  }

  /**
   * {@inheritdoc}
   */
  public function viewElements(FieldItemListInterface $items, $langcode) {
    $elements = parent::viewElements($items, $langcode);
    $type = $this
      ->getSetting('type');
    foreach ($items as $delta => $item) {
      switch ($type) {
        case static::TYPE_TIMER:
          if ($item->date
            ->getTimestamp() >= $this->time
            ->getRequestTime()) {
            unset($elements[$delta]);
          }
          break;
        case static::TYPE_COUNTDOWN:
          if ($item->date
            ->getTimestamp() < $this->time
            ->getRequestTime()) {
            unset($elements[$delta]);
          }
          break;
      }
    }
    return $elements;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    $form = parent::settingsForm($form, $form_state);
    $form['type'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Type'),
      '#default_value' => $this
        ->getSetting('type'),
      '#options' => $this
        ->typeOptions(),
      '#description' => $this
        ->t('Switch timer/countdown automatically or disable it.'),
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsSummary() {
    $summary = parent::settingsSummary();
    $type = $this
      ->getSetting('type');
    $summary[] = $this
      ->t('Type: @type', [
      '@type' => $this
        ->typeOptions()[$type],
    ]);
    return $summary;
  }

  /**
   * {@inheritdoc}
   */
  protected function typeOptions() {
    return [
      static::TYPE_AUTO => $this
        ->t('Auto'),
      static::TYPE_TIMER => $this
        ->t('Timer'),
      static::TYPE_COUNTDOWN => $this
        ->t('Countdown'),
    ];
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DateTimeTimeAgoFormatter::formatDate	protected	function	Formats a date/time as a time interval.
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
FieldTimerSimpleTextFormatter::$time	protected	property
FieldTimerSimpleTextFormatter::create	public static	function	Creates an instance of the plugin. Overrides TimestampAgoFormatter::create
FieldTimerSimpleTextFormatter::defaultSettings	public static	function	Defines the default settings for this plugin. Overrides TimestampAgoFormatter::defaultSettings
FieldTimerSimpleTextFormatter::settingsForm	public	function	Returns a form to configure settings for the formatter. Overrides TimestampAgoFormatter::settingsForm
FieldTimerSimpleTextFormatter::settingsSummary	public	function	Returns a short summary for the current formatter settings. Overrides TimestampAgoFormatter::settingsSummary
FieldTimerSimpleTextFormatter::typeOptions	protected	function
FieldTimerSimpleTextFormatter::TYPE_AUTO		constant	Formatter types.
FieldTimerSimpleTextFormatter::viewElements	public	function	Builds a renderable array for a field value. Overrides DateTimeTimeAgoFormatter::viewElements
FieldTimerSimpleTextFormatter::__construct	public	function	FieldTimerSimpleTextFormatter constructor. Overrides TimestampAgoFormatter::__construct
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
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.
TimestampAgoFormatter::$dateFormatter	protected	property	The date formatter service.
TimestampAgoFormatter::$request	protected	property	The current Request object.
TimestampAgoFormatter::formatTimestamp	protected	function	Formats a timestamp.

You are here

class FieldTimerSimpleTextFormatter in Field Timer 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation