abstract class DateTargetBase in Feeds 8.3
A base class for date targets.
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
- class \Drupal\feeds\Plugin\Type\PluginBase implements FeedsPluginInterface uses DependencyTrait
- class \Drupal\feeds\Plugin\Type\ConfigurablePluginBase implements PluginFormInterface
- class \Drupal\feeds\Plugin\Type\Target\TargetBase implements TargetInterface
- class \Drupal\feeds\Plugin\Type\Target\FieldTargetBase implements ConfigurableTargetInterface, TranslatableTargetInterface
- class \Drupal\feeds\Feeds\Target\DateTargetBase implements ConfigurableTargetInterface
- class \Drupal\feeds\Plugin\Type\Target\FieldTargetBase implements ConfigurableTargetInterface, TranslatableTargetInterface
- class \Drupal\feeds\Plugin\Type\Target\TargetBase implements TargetInterface
- class \Drupal\feeds\Plugin\Type\ConfigurablePluginBase implements PluginFormInterface
- class \Drupal\feeds\Plugin\Type\PluginBase implements FeedsPluginInterface uses DependencyTrait
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
Expanded class hierarchy of DateTargetBase
File
- src/
Feeds/ Target/ DateTargetBase.php, line 13
Namespace
Drupal\feeds\Feeds\TargetView source
abstract class DateTargetBase extends FieldTargetBase implements ConfigurableTargetInterface {
/**
* Prepares a date value.
*
* @param string $value
* The value to convert to a date.
*
* @return \Drupal\Core\Datetime\DrupalDateTime|null
* A datetime object or null, if there is no value or if the date value
* has errors.
*/
protected function convertToDate($value) {
$value = trim($value);
// This is a year value.
if (ctype_digit($value) && strlen($value) === 4) {
$value = 'January ' . $value;
}
if (is_numeric($value)) {
$date = DrupalDateTime::createFromTimestamp($value, $this
->getTimezoneConfiguration());
}
elseif (strtotime($value)) {
$date = new DrupalDateTime($value, $this
->getTimezoneConfiguration());
}
if (isset($date) && !$date
->hasErrors()) {
return $date;
}
}
/**
* {@inheritdoc}
*/
public function defaultConfiguration() {
return parent::defaultConfiguration() + [
'timezone' => 'UTC',
];
}
/**
* {@inheritdoc}
*/
public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
$form = parent::buildConfigurationForm($form, $form_state);
$form['timezone'] = [
'#type' => 'select',
'#title' => $this
->t('Timezone handling'),
'#options' => $this
->getTimezoneOptions(),
'#default_value' => $this->configuration['timezone'],
'#description' => $this
->t('This value will only be used if the timezone is missing.'),
];
return $form;
}
/**
* Returns the timezone options.
*
* @return array
* A map of timezone options.
*/
public function getTimezoneOptions() {
return [
'__SITE__' => $this
->t('Site default'),
] + system_time_zones();
}
/**
* {@inheritdoc}
*/
public function getSummary() {
$summary = parent::getSummary();
$options = $this
->getTimezoneOptions();
$summary[] = $this
->t('Default timezone: %zone', [
'%zone' => $options[$this->configuration['timezone']],
]);
return $summary;
}
/**
* Returns the timezone configuration.
*/
public function getTimezoneConfiguration() {
return $this->configuration['timezone'] == '__SITE__' ? \Drupal::config('system.date')
->get('timezone.default') : $this->configuration['timezone'];
}
}
Members
Name![]() |
Modifiers | Type | Description | Overrides |
---|---|---|---|---|
ConfigurablePluginBase:: |
public | function |
Form validation handler. Overrides PluginFormInterface:: |
|
DateTargetBase:: |
public | function |
Form constructor. Overrides FieldTargetBase:: |
|
DateTargetBase:: |
protected | function | Prepares a date value. | |
DateTargetBase:: |
public | function |
Gets default configuration for this plugin. Overrides FieldTargetBase:: |
1 |
DateTargetBase:: |
public | function |
Returns the summary for a target. Overrides FieldTargetBase:: |
|
DateTargetBase:: |
public | function | Returns the timezone configuration. | |
DateTargetBase:: |
public | function | Returns the timezone options. | |
DependencySerializationTrait:: |
protected | property | An array of entity type IDs keyed by the property name of their storages. | |
DependencySerializationTrait:: |
protected | property | An array of service IDs keyed by property name used for serialization. | |
DependencySerializationTrait:: |
public | function | 1 | |
DependencySerializationTrait:: |
public | function | 2 | |
DependencyTrait:: |
protected | property | The object's dependencies. | |
DependencyTrait:: |
protected | function | Adds multiple dependencies. | |
DependencyTrait:: |
protected | function | Adds a dependency. | |
FieldTargetBase:: |
protected | property | The field settings. | |
FieldTargetBase:: |
protected | property | The language manager. | |
FieldTargetBase:: |
protected | function | Adds a message. | |
FieldTargetBase:: |
public | function |
Calculates dependencies for the configured plugin. Overrides PluginBase:: |
|
FieldTargetBase:: |
public | function | Get entity, or entity translation to set the map. | |
FieldTargetBase:: |
public | function |
Gets the configured language. Overrides TranslatableTargetInterface:: |
|
FieldTargetBase:: |
protected | function | Gets the language manager. | |
FieldTargetBase:: |
protected | function | Returns the messenger to use. | |
FieldTargetBase:: |
protected | function | Constructs a base query which is used to find an existing entity. | |
FieldTargetBase:: |
public | function | Looks for an existing entity and returns an entity ID if found. | |
FieldTargetBase:: |
public | function |
Returns if the value for the target is empty. Overrides TargetInterface:: |
|
FieldTargetBase:: |
public | function |
Returns if the target is mutable. Overrides TargetInterface:: |
1 |
FieldTargetBase:: |
protected | function | Checks if the targeted field is translatable. | |
FieldTargetBase:: |
public | function |
Checks if the target is translatable. Overrides TranslatableTargetInterface:: |
|
FieldTargetBase:: |
public | function |
Checks if the language selected on the target exists. Overrides TranslatableTargetInterface:: |
|
FieldTargetBase:: |
public | function |
Allows a plugin to define whether it should be removed. Overrides TargetBase:: |
|
FieldTargetBase:: |
protected static | function | Prepares a target definition. | 10 |
FieldTargetBase:: |
protected | function | Prepares a single value. | 12 |
FieldTargetBase:: |
protected | function | Prepares the the values that will be mapped to an entity. | |
FieldTargetBase:: |
public | function | Sets the language manager. | |
FieldTargetBase:: |
public | function |
Sets the values on an object. Overrides TargetInterface:: |
4 |
FieldTargetBase:: |
public static | function |
Returns the targets defined by this plugin. Overrides TargetInterface:: |
1 |
FieldTargetBase:: |
public | function |
Constructs a TargetBase object. Overrides TargetBase:: |
5 |
MessengerTrait:: |
protected | property | The messenger. | 29 |
MessengerTrait:: |
public | function | Gets the messenger. | 29 |
MessengerTrait:: |
public | function | Sets the messenger. | |
PluginBase:: |
protected | property | Configuration information passed into the plugin. | 1 |
PluginBase:: |
protected | property | The importer this plugin is working for. | |
PluginBase:: |
protected | property | The link generator. | |
PluginBase:: |
protected | property | The plugin implementation definition. | 1 |
PluginBase:: |
protected | property | The plugin_id. | |
PluginBase:: |
protected | property | The url generator. | |
PluginBase:: |
private | function | Returns the service container. | |
PluginBase:: |
public | function |
Returns default feed configuration. Overrides FeedsPluginInterface:: |
3 |
PluginBase:: |
constant | A string which is used to separate base plugin IDs from the derivative ID. | ||
PluginBase:: |
public | function |
Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets this plugin's configuration. Overrides ConfigurableInterface:: |
|
PluginBase:: |
public | function |
Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the definition of the plugin implementation. Overrides PluginInspectionInterface:: |
3 |
PluginBase:: |
public | function |
Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface:: |
|
PluginBase:: |
public | function | Determines if the plugin is configurable. | |
PluginBase:: |
protected | function | Renders a link to a route given a route name and its parameters. | |
PluginBase:: |
protected | function | Returns the link generator service. | |
PluginBase:: |
public | function | A feed is being deleted. | 3 |
PluginBase:: |
public | function | A feed is being saved. | |
PluginBase:: |
public | function | The feed type is being deleted. | 1 |
PluginBase:: |
public | function | The feed type is being saved. | 1 |
PluginBase:: |
public | function |
Returns the type of plugin. Overrides FeedsPluginInterface:: |
|
PluginBase:: |
public | function |
Sets the configuration for this plugin instance. Overrides ConfigurableInterface:: |
1 |
PluginBase:: |
protected | function | Generates a URL or path for a specific route based on the given parameters. | |
PluginBase:: |
protected | function | Returns the URL generator service. | |
StringTranslationTrait:: |
protected | property | The string translation service. | 1 |
StringTranslationTrait:: |
protected | function | Formats a string containing a count of items. | |
StringTranslationTrait:: |
protected | function | Returns the number of plurals supported by a given language. | |
StringTranslationTrait:: |
protected | function | Gets the string translation service. | |
StringTranslationTrait:: |
public | function | Sets the string translation service to use. | 2 |
StringTranslationTrait:: |
protected | function | Translates a string to the current language or to a given language. | |
TargetBase:: |
protected | property | The target definition. | |
TargetBase:: |
public | function |
Returns the target's definition. Overrides TargetInterface:: |
|
TargetBase:: |
public | function |
Form submission handler. Overrides ConfigurablePluginBase:: |