You are here

class DateTimeEnhancer in JSON:API Extras 8.3

Same name and namespace in other branches
  1. 8 src/Plugin/jsonapi/FieldEnhancer/DateTimeEnhancer.php \Drupal\jsonapi_extras\Plugin\jsonapi\FieldEnhancer\DateTimeEnhancer
  2. 8.2 src/Plugin/jsonapi/FieldEnhancer/DateTimeEnhancer.php \Drupal\jsonapi_extras\Plugin\jsonapi\FieldEnhancer\DateTimeEnhancer

Perform additional manipulations to timestamp fields.

Plugin annotation


@ResourceFieldEnhancer(
  id = "date_time",
  label = @Translation("Date Time (Timestamp field)"),
  description = @Translation("Formats a date based the configured date format for timestamp fields."),
  dependencies = {"datetime"}
)

Hierarchy

Expanded class hierarchy of DateTimeEnhancer

File

src/Plugin/jsonapi/FieldEnhancer/DateTimeEnhancer.php, line 19

Namespace

Drupal\jsonapi_extras\Plugin\jsonapi\FieldEnhancer
View source
class DateTimeEnhancer extends DateTimeEnhancerBase {

  /**
   * {@inheritdoc}
   */
  protected function doUndoTransform($data, Context $context) {
    $date = new \DateTime();
    $date
      ->setTimestamp(is_int($data) ? $data : (new DrupalDateTime($data))
      ->getTimestamp());
    $configuration = $this
      ->getConfiguration();
    return $date
      ->format($configuration['dateTimeFormat']);
  }

  /**
   * {@inheritdoc}
   */
  protected function doTransform($data, Context $context) {
    $date = new \DateTime($data);
    return (int) $date
      ->format('U');
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DateTimeEnhancer::doTransform protected function
DateTimeEnhancer::doUndoTransform protected function
DateTimeEnhancerBase::defaultConfiguration public function Overrides ResourceFieldEnhancerBase::defaultConfiguration
DateTimeEnhancerBase::getOutputJsonSchema public function Get the JSON Schema for the new output. Overrides ResourceFieldEnhancerInterface::getOutputJsonSchema 1
DateTimeEnhancerBase::getSettingsForm public function Get a form element to render the settings. Overrides ResourceFieldEnhancerBase::getSettingsForm
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
ResourceFieldEnhancerBase::getConfiguration public function
ResourceFieldEnhancerBase::getInputValidator public function
ResourceFieldEnhancerBase::getInternalValidator public function
ResourceFieldEnhancerBase::getOutputValidator public function
ResourceFieldEnhancerBase::setConfiguration public function
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.