class DateTimeFromStringEnhancer in JSON:API Extras 8.3

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."),
  dependencies = {"datetime"}
)

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 uses \Shaper\DataAdaptor\DataAdaptorValidatorTrait, \Shaper\DataAdaptor\DataAdaptorTransformerTrait
      • class \Drupal\jsonapi_extras\Plugin\DateTimeEnhancerBase
        • class \Drupal\jsonapi_extras\Plugin\jsonapi\FieldEnhancer\DateTimeFromStringEnhancer

File

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

Namespace

Drupal\jsonapi_extras\Plugin\jsonapi\FieldEnhancer

class DateTimeFromStringEnhancer extends DateTimeEnhancerBase {

  /**
   * {@inheritdoc}
   */
  protected function doUndoTransform($data, Context $context) {
    $configuration = $this
      ->getConfiguration();
    $reformat = function ($input) use ($configuration) {
      $storage_timezone = new \DateTimezone(DateTimeItemInterface::STORAGE_TIMEZONE);
      $date = new \DateTime($input, $storage_timezone);
      $output_timezone = new \DateTimezone(date_default_timezone_get());
      $date
        ->setTimezone($output_timezone);
      $output = $date
        ->format($configuration['dateTimeFormat']);
      return $output;
    };
    $result = is_array($data) ? array_map($reformat, $data) : $reformat($data);
    return $result;
  }

  /**
   * {@inheritdoc}
   */
  protected function doTransform($data, Context $context) {
    $reformat = function ($input) {
      $date = new \DateTime($input);

      // Adjust the date for storage.
      $storage_timezone = new \DateTimezone(DateTimeItemInterface::STORAGE_TIMEZONE);
      $date
        ->setTimezone($storage_timezone);
      $output = $date
        ->format(DateTimeItemInterface::DATETIME_STORAGE_FORMAT);
      return $output;
    };
    $result = is_array($data) ? array_map($reformat, $data) : $reformat($data);
    return $result;
  }

  /**
   * {@inheritdoc}
   */
  public function getOutputJsonSchema() {
    $baseType = parent::getOutputJsonSchema();
    return [
      "anyOf" => [
        $baseType,
        [
          "type" => "array",
          "items" => $baseType,
        ],
        [
          "type" => "object",
          "properties" => [
            "value" => $baseType,
            "end_value" => $baseType,
          ],
        ],
      ],
    ];
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DateTimeEnhancerBase::defaultConfiguration	public	function	Overrides ResourceFieldEnhancerBase::defaultConfiguration
DateTimeEnhancerBase::getSettingsForm	public	function	Get a form element to render the settings. Overrides ResourceFieldEnhancerBase::getSettingsForm
DateTimeFromStringEnhancer::doTransform	protected	function
DateTimeFromStringEnhancer::doUndoTransform	protected	function
DateTimeFromStringEnhancer::getOutputJsonSchema	public	function	Get the JSON Schema for the new output. Overrides DateTimeEnhancerBase::getOutputJsonSchema
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.