abstract class DateTimeEnhancerBase in JSON:API Extras 8

Base class for date and time based resourceFieldEnhancer plugins.

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\jsonapi_extras\Plugin\ResourceFieldEnhancerBase implements ResourceFieldEnhancerInterface
      • class \Drupal\jsonapi_extras\Plugin\DateTimeEnhancerBase

2 files declare their use of DateTimeEnhancerBase

DateTimeEnhancer.php in src/Plugin/jsonapi/FieldEnhancer/DateTimeEnhancer.php

DateTimeFromStringEnhancer.php in src/Plugin/jsonapi/FieldEnhancer/DateTimeFromStringEnhancer.php

File

src/Plugin/DateTimeEnhancerBase.php, line 8

Namespace

Drupal\jsonapi_extras\Plugin

abstract class DateTimeEnhancerBase extends ResourceFieldEnhancerBase {

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    return [
      'dateTimeFormat' => \DateTime::ISO8601,
    ];
  }

  /**
   * {@inheritdoc}
   */
  public abstract function postProcess($value);

  /**
   * {@inheritdoc}
   */
  public abstract function prepareForInput($value);

  /**
   * {@inheritdoc}
   */
  public function getJsonSchema() {
    return [
      'type' => 'string',
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function getSettingsForm(array $resource_field_info) {
    $settings = empty($resource_field_info['enhancer']['settings']) ? $this
      ->getConfiguration() : $resource_field_info['enhancer']['settings'];
    return [
      'dateTimeFormat' => [
        '#type' => 'textfield',
        '#title' => $this
          ->t('Format'),
        '#description' => $this
          ->t('Use a valid date format.'),
        '#default_value' => $settings['dateTimeFormat'],
      ],
    ];
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DateTimeEnhancerBase::defaultConfiguration	public	function	Gets default configuration for this plugin. Overrides ResourceFieldEnhancerBase::defaultConfiguration
DateTimeEnhancerBase::getJsonSchema	public	function	Get the JSON Schema for the new output. Overrides ResourceFieldEnhancerInterface::getJsonSchema
DateTimeEnhancerBase::getSettingsForm	public	function	Get a form element to render the settings. Overrides ResourceFieldEnhancerBase::getSettingsForm
DateTimeEnhancerBase::postProcess	abstract public	function	Apply the last transformations to the output value of a single field. Overrides ResourceFieldEnhancerInterface::postProcess	2
DateTimeEnhancerBase::prepareForInput	abstract public	function	Apply the initial transformations to the input value of a single field. Overrides ResourceFieldEnhancerInterface::prepareForInput	2
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
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
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.
PluginBase::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object.	92
ResourceFieldEnhancerBase::$configuration	protected	property	Holds the plugin configuration. Overrides PluginBase::$configuration
ResourceFieldEnhancerBase::calculateDependencies	public	function	Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies
ResourceFieldEnhancerBase::getConfiguration	public	function	Gets this plugin's configuration. Overrides ConfigurablePluginInterface::getConfiguration
ResourceFieldEnhancerBase::setConfiguration	public	function	Sets the configuration for this plugin instance. Overrides ConfigurablePluginInterface::setConfiguration
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.