class DateTimeCustomListFormatter in Formatter Suite 8

Formats multiple custom-formatted dates as a list.

See the EntityListTrait for a description of list formatting features.

Plugin annotation


@FieldFormatter(
  id          = "formatter_suite_datetime_custom_list",
  label       = @Translation("Formatter Suite - Custom date & time list"),
  weight      = 1000,
  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\datetime\Plugin\Field\FieldFormatter\DateTimeFormatterBase implements ContainerFactoryPluginInterface
    class \Drupal\datetime\Plugin\Field\FieldFormatter\DateTimeCustomFormatter
    class \Drupal\formatter_suite\Plugin\Field\FieldFormatter\DateTimeCustomListFormatter uses EntityListTrait

Expanded class hierarchy of DateTimeCustomListFormatter

File

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

Namespace

Drupal\formatter_suite\Plugin\Field\FieldFormatter

View source

class DateTimeCustomListFormatter extends DateTimeCustomFormatter {
  use EntityListTrait;

  /*---------------------------------------------------------------------
   *
   * Settings form.
   *
   *---------------------------------------------------------------------*/

  /**
   * Returns a brief description of the formatter.
   *
   * @return string
   *   Returns a brief translated description of the formatter.
   */
  protected function getDescription() {
    return $this
      ->t("Format multi-value date & time fields as a list. Values may be formatted using a custom date/time format using PHP's format syntax, along with an optional time zone.");
  }

  /**
   * Post-processes the settings form after it has been built.
   *
   * @param array $elements
   *   The form's elements.
   */
  protected function postProcessSettingsForm(array $elements) {

    // The Drupal core DateTimeCustomFormatter creates a textfield for the
    // date/time format, but doesn't set the textfield's size. This makes it
    // hard to lay it out in the formatter's UI. So, give it a small size.
    // CSS then widens it to the width of the UI.
    if (isset($elements['date_format']) === TRUE) {
      $elements['date_format']['#size'] = 10;
      $elements['date_format']['#attributes']['size'] = 10;
      $elements['date_format']['#attributes']['spellcheck'] = FALSE;
      $elements['date_format']['#attributes']['autocomplete'] = 'off';
      $elements['date_format']['#attributes']['autocapitalize'] = 'none';
      $elements['date_format']['#attributes']['autocorrect'] = 'off';
    }
    return $elements;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DateTimeCustomFormatter::formatDate	protected	function	Creates a formatted date value as a string. Overrides DateTimeFormatterBase::formatDate
DateTimeCustomFormatter::viewElements	public	function	Builds a renderable array for a field value. Overrides DateTimeFormatterBase::viewElements
DateTimeCustomListFormatter::getDescription	protected	function	Returns a brief description of the formatter. Overrides EntityListTrait::getDescription
DateTimeCustomListFormatter::postProcessSettingsForm	protected	function	Post-processes the settings form after it has been built. Overrides EntityListTrait::postProcessSettingsForm
DateTimeFormatterBase::$dateFormatStorage	protected	property	The date format entity storage.
DateTimeFormatterBase::$dateFormatter	protected	property	The date formatter service.
DateTimeFormatterBase::buildDate	protected	function	Creates a render array from a date object.
DateTimeFormatterBase::buildDateWithIsoAttribute	protected	function	Creates a render array from a date object with ISO date attribute.
DateTimeFormatterBase::create	public static	function	Creates an instance of the plugin. Overrides FormatterBase::create
DateTimeFormatterBase::getFormatSettings	protected	function	Gets a settings array suitable for DrupalDateTime::format().
DateTimeFormatterBase::setTimeZone	protected	function	Sets the proper time zone on a DrupalDateTime object for the current user.
DateTimeFormatterBase::__construct	public	function	Constructs a new DateTimeDefaultFormatter. Overrides FormatterBase::__construct
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
EntityListTrait::defaultSettings	public static	function
EntityListTrait::getListStyles	protected static	function	Returns an array of list styles.
EntityListTrait::sanitizeListSettings	protected	function	Check current settings and insure they make sense.
EntityListTrait::settingsForm	public	function
EntityListTrait::settingsSummary	public	function
EntityListTrait::view	public	function
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
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.

You are here

class DateTimeCustomListFormatter in Formatter Suite 8

Plugin annotation

Hierarchy

Related topics

File

Namespace

Members

API Navigation