You are here

class DateTimeFromStringEnhancer in JSON:API Extras 8

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

Perform additional manipulations to datetime fields.

Plugin annotation


@ResourceFieldEnhancer(
  id = "date_time_from_string",
  label = @Translation("Date Time (Date Time field)"),
  description = @Translation("Formats a date based the configured date format for date fields.")
)

Hierarchy

Expanded class hierarchy of DateTimeFromStringEnhancer

File

src/Plugin/jsonapi/FieldEnhancer/DateTimeFromStringEnhancer.php, line 16

Namespace

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

  /**
   * {@inheritdoc}
   */
  public function postProcess($value) {
    $storage_timezone = new \DateTimezone(DATETIME_STORAGE_TIMEZONE);
    $date = new \DateTime($value, $storage_timezone);
    $configuration = $this
      ->getConfiguration();
    $output_timezone = new \DateTimezone(drupal_get_user_timezone());
    $date
      ->setTimezone($output_timezone);
    return $date
      ->format($configuration['dateTimeFormat']);
  }

  /**
   * {@inheritdoc}
   */
  public function prepareForInput($value) {
    $date = new \DateTime($value);

    // Adjust the date for storage.
    $storage_timezone = new \DateTimezone(DATETIME_STORAGE_TIMEZONE);
    $date
      ->setTimezone($storage_timezone);
    return $date
      ->format(DATETIME_DATETIME_STORAGE_FORMAT);
  }

}

Members

Namesort descending 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
DateTimeFromStringEnhancer::postProcess public function Apply the last transformations to the output value of a single field. Overrides DateTimeEnhancerBase::postProcess
DateTimeFromStringEnhancer::prepareForInput public function Apply the initial transformations to the input value of a single field. Overrides DateTimeEnhancerBase::prepareForInput
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.