You are here

Home » API reference » Entity Export CSV 8 » DateTimeExport.php

class DateTimeExport in Entity Export CSV 8

Defines a Datetime field type export plugin.

Plugin annotation


@FieldTypeExport(
  id = "datetime_export",
  label = @Translation("Datetime export"),
  description = @Translation("Datetime export"),
  weight = 0,
  field_type = {
    "datetime",
  },
  entity_type = {},
  bundle = {},
  field_name = {},
  exclusive = FALSE,
)

Hierarchy

Expanded class hierarchy of DateTimeExport

File

src/Plugin/FieldTypeExport/DateTimeExport.php, line 29

Namespace

Drupal\entity_export_csv\Plugin\FieldTypeExport
View source 
class DateTimeExport extends FieldTypeExportBase {

  /**
   * An array of date_format entity keyed by format and langcode.
   *
   * @var array
   */
  protected $dateFormats = [];

  /**
   * {@inheritdoc}
   */
  public function getSummary() {
    return [
      'message' => [
        '#markup' => $this
          ->t('Datetime field type exporter.'),
      ],
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state, FieldDefinitionInterface $field_definition) {
    $configuration = $this
      ->getConfiguration();
    $build = parent::buildConfigurationForm($form, $form_state, $field_definition);
    $build['custom_date_format'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Custom date format'),
      '#description' => $this
        ->t('See <a href="http://php.net/manual/function.date.php" target="_blank">the documentation for PHP date formats</a>.'),
      '#default_value' => !empty($configuration['custom_date_format']) ? $configuration['custom_date_format'] : '',
    ];
    $build['custom_date_format']['#states']['visible'][] = [
      ':input[name="fields[' . $field_definition
        ->getName() . '][form][options][format]"]' => [
        'value' => 'custom',
      ],
    ];
    return $build;
  }

  /**
   * {@inheritdoc}
   */
  public function massageExportPropertyValue(FieldItemInterface $field_item, $property_name, FieldDefinitionInterface $field_definition, $options = []) {
    if ($field_item
      ->isEmpty()) {
      return NULL;
    }
    $configuration = $this
      ->getConfiguration();
    if (empty($configuration['format'])) {
      return $field_item
        ->get($property_name)
        ->getValue();
    }
    $langcode = $this->languageManager
      ->getCurrentLanguage()
      ->getId();
    $timezone = NULL;
    $format = NULL;
    $settings = [
      'langcode' => $langcode,
    ];
    $date_format_id = $configuration['format'];
    $custom_date_format = !empty($configuration['custom_date_format']) ? $configuration['custom_date_format'] : '';

    // If an RFC2822 date format is requested, then the month and day have to
    // be in English. @see http://www.faqs.org/rfcs/rfc2822.html
    if ($date_format_id === 'custom' && $custom_date_format === 'r') {
      $langcode = 'en';
      $settings['langcode'] = $langcode;
    }
    if (!empty($custom_date_format) && $date_format_id === 'custom') {
      $format = $custom_date_format;
    }
    else {
      if ($date_format = $this
        ->getDateFormat($date_format_id, $langcode)) {
        $format = $date_format
          ->getPattern();
      }
    }
    $date = $field_item->date;
    if ($date instanceof DrupalDateTime && $format) {
      return $date
        ->format($format, $settings);
    }

    // Fallback to the raw value.
    return $field_item
      ->get($property_name)
      ->getValue();
  }

  /**
   * {@inheritdoc}
   */
  protected function getFormatExportOptions(FieldDefinitionInterface $field_definition) {
    $options = parent::getFormatExportOptions($field_definition);
    $date_formats = [];
    foreach ($this->entityTypeManager
      ->getStorage('date_format')
      ->loadMultiple() as $machine_name => $value) {
      $date_formats[$machine_name] = $this
        ->t('@name format: @date', [
        '@name' => $value
          ->label(),
        '@date' => $this->dateFormatter
          ->format(REQUEST_TIME, $machine_name),
      ]);
    }
    $date_formats['custom'] = $this
      ->t('Custom');
    return $options + $date_formats;
  }

  /**
   * Loads the given format pattern for the given langcode.
   *
   * @param string $format
   *   The machine name of the date format.
   * @param string $langcode
   *   The langcode of the language to use.
   *
   * @return \Drupal\Core\Datetime\DateFormatInterface|null
   *   The configuration entity for the date format in the given language for
   *   non-custom formats, NULL otherwise.
   */
  protected function getDateFormat($format, $langcode) {
    if (!isset($this->dateFormats[$format][$langcode])) {
      $original_language = $this->languageManager
        ->getConfigOverrideLanguage();
      $this->languageManager
        ->setConfigOverrideLanguage(new Language([
        'id' => $langcode,
      ]));
      $this->dateFormats[$format][$langcode] = $this->entityTypeManager
        ->getStorage('date_format')
        ->load($format);
      $this->languageManager
        ->setConfigOverrideLanguage($original_language);
    }
    return $this->dateFormats[$format][$langcode];
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DateTimeExport::$dateFormats protected property An array of date_format entity keyed by format and langcode.
DateTimeExport::buildConfigurationForm public function Build the configuration form. Overrides FieldTypeExportBase::buildConfigurationForm
DateTimeExport::getDateFormat protected function Loads the given format pattern for the given langcode.
DateTimeExport::getFormatExportOptions protected function Get the format options to export. Overrides FieldTypeExportBase::getFormatExportOptions
DateTimeExport::getSummary public function
DateTimeExport::massageExportPropertyValue public function Massage the field item property value to CSV value. Overrides FieldTypeExportBase::massageExportPropertyValue
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
DependencyTrait::$dependencies protected property The object's dependencies.
DependencyTrait::addDependencies protected function Adds multiple dependencies.
DependencyTrait::addDependency protected function Adds a dependency.
FieldTypeExportBase::$configFactory protected property The config factory service.
FieldTypeExportBase::$dateFormatter protected property Drupal\Core\Datetime\DateFormatterInterface definition.
FieldTypeExportBase::$entityFieldManager protected property Drupal\Core\Entity\EntityFieldManagerInterface definition.
FieldTypeExportBase::$entityRepository protected property Drupal\Core\Entity\EntityRepositoryInterface definition.
FieldTypeExportBase::$entityTypeManager protected property Drupal\Core\Entity\EntityTypeManagerInterface definition.
FieldTypeExportBase::$languageManager protected property The language manager service.
FieldTypeExportBase::$moduleHandler protected property Drupal\Core\Extension\ModuleHandlerInterface definition.
FieldTypeExportBase::$properties protected property The field properties.
FieldTypeExportBase::allowExportMultipleProperties protected function Default method to allow to export multiple properties.
FieldTypeExportBase::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
FieldTypeExportBase::defaultConfiguration public function
FieldTypeExportBase::export public function Export the value of a field. Overrides FieldTypeExportInterface::export
FieldTypeExportBase::fieldDefinitionIsMultiple protected function Is the field is multiple ?
FieldTypeExportBase::getColumns public function Get the columns to generate during the export. Overrides FieldTypeExportInterface::getColumns
FieldTypeExportBase::getConfiguration public function
FieldTypeExportBase::getDescription public function Retrieves the generator description. Overrides FieldTypeExportInterface::getDescription
FieldTypeExportBase::getFieldProperties public function Gets the field's properties. Overrides FieldTypeExportInterface::getFieldProperties 1
FieldTypeExportBase::getHeaderLabel public function Get the header label for a field. Overrides FieldTypeExportInterface::getHeaderLabel
FieldTypeExportBase::getHeaderOptions protected function Get the header export options.
FieldTypeExportBase::getHeaders public function Get the header columns for a field. Overrides FieldTypeExportInterface::getHeaders
FieldTypeExportBase::getLabel public function Retrieves the label. Overrides FieldTypeExportInterface::getLabel
FieldTypeExportBase::getMainPropertyName protected function Get the main property name of a field.
FieldTypeExportBase::getMaxColumns protected function Get the max columns for multiple fields.
FieldTypeExportBase::getPropertiesSelected protected function Get the field properties selected.
FieldTypeExportBase::getPropertyColumnSeparator protected function Get the property separator selected.
FieldTypeExportBase::getPropertyColumnSeparatorOptions protected function Get the property separator options.
FieldTypeExportBase::getPropertyExportOptions protected function Get the properties options to export.
FieldTypeExportBase::getPropertyLabel protected function Get the property header label.
FieldTypeExportBase::getSeparatorsOptions protected function Get the separator options when exporting in a single column.
FieldTypeExportBase::import public function Import a value into a field. Overrides FieldTypeExportInterface::import
FieldTypeExportBase::propertiesInSeparateColumns protected function Should properties be exported in separated columns ?
FieldTypeExportBase::setConfiguration public function
FieldTypeExportBase::summary public function Provides a human readable summary of the plugin's configuration. Overrides FieldTypeExportInterface::summary
FieldTypeExportBase::validateConfigurationForm public function Validates a configuration form for this plugin. Overrides FieldTypeExportInterface::validateConfigurationForm
FieldTypeExportBase::__construct public function LogGeneratorBase constructor. Overrides PluginBase::__construct
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.
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.