class AddtocalView in Add to Cal 8
Same name and namespace in other branches
- 8.2 src/Plugin/Field/FieldFormatter/AddtocalView.php \Drupal\addtocal\Plugin\Field\FieldFormatter\AddtocalView
Plugin annotation
@FieldFormatter(
id = "addtocal_view",
label = @Translation("Add to Cal"),
field_types = {
"date",
"datestamp",
"datetime",
"daterange",
}
)
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
- class \Drupal\Core\Field\PluginSettingsBase implements DependentPluginInterface, PluginSettingsInterface
- class \Drupal\Core\Field\FormatterBase implements FormatterInterface, ContainerFactoryPluginInterface
- class \Drupal\datetime\Plugin\Field\FieldFormatter\DateTimeFormatterBase implements ContainerFactoryPluginInterface
- class \Drupal\datetime\Plugin\Field\FieldFormatter\DateTimeCustomFormatter
- class \Drupal\addtocal\Plugin\Field\FieldFormatter\AddtocalView
- class \Drupal\datetime\Plugin\Field\FieldFormatter\DateTimeCustomFormatter
- class \Drupal\datetime\Plugin\Field\FieldFormatter\DateTimeFormatterBase implements ContainerFactoryPluginInterface
- class \Drupal\Core\Field\FormatterBase implements FormatterInterface, ContainerFactoryPluginInterface
- class \Drupal\Core\Field\PluginSettingsBase implements DependentPluginInterface, PluginSettingsInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
Expanded class hierarchy of AddtocalView
File
- src/
Plugin/ Field/ FieldFormatter/ AddtocalView.php, line 25
Namespace
Drupal\addtocal\Plugin\Field\FieldFormatterView source
class AddtocalView extends DateTimeCustomFormatter {
/**
* Defines the default settings for this plugin.
*
* @return array
* A list of default settings, keyed by the setting name.
*/
public static function defaultSettings() {
return [
'location' => [
'value' => FALSE,
'tokenized' => '',
],
'description' => [
'value' => FALSE,
'tokenized' => '',
],
'past_events' => FALSE,
'separator' => '-',
] + parent::defaultSettings();
}
/**
*
* @return string[]
* A short summary of the formatter settings.
*/
public function settingsSummary() {
$summary = parent::settingsSummary();
$settings = $this
->getSettings();
$location = $settings['location']['value'] ? $settings['location']['value'] : $this
->t("Static Text");
$description = $settings['description']['value'] ? $settings['description']['value'] : $this
->t("Static Text");
$summary[] = $this
->t('Location field: %location', [
'%location' => $location,
]);
$summary[] = $this
->t('Description field: %description', [
'%description' => $description,
]);
// Date Range field type settings
$field = $this->fieldDefinition;
if ($field
->getType() == 'daterange') {
if ($separator = $this
->getSetting('separator')) {
$summary[] = $this
->t('Separator: %separator', [
'%separator' => $separator,
]);
}
}
return $summary;
}
/**
* {@inheritdoc}
*/
public function settingsForm(array $form, FormStateInterface $form_state) {
$form = parent::settingsForm($form, $form_state);
$settings = $this
->getSettings();
$field = $this->fieldDefinition;
$location_field_types = [
'string',
'text_with_summary',
'address',
];
$description_field_types = [
'string',
'text_long',
'text_with_summary',
];
$description_options = $location_options = [
FALSE => 'None',
];
$entity_field_list = \Drupal::service('entity_field.manager')
->getFieldDefinitions($field
->getTargetEntityTypeId(), $field
->getTargetBundle());
foreach ($entity_field_list as $entity_field) {
// Filter out base fields like nid, uuid, revisions, etc.
if ($entity_field
->getFieldStorageDefinition()
->isBaseField() == FALSE) {
if (in_array($entity_field
->get('field_type'), $location_field_types)) {
$location_options[$entity_field
->get('field_name')] = $entity_field
->getLabel();
}
if (in_array($entity_field
->get('field_type'), $description_field_types)) {
$description_options[$entity_field
->get('field_name')] = $entity_field
->getLabel();
}
}
}
// Date Range field type settings
if ($field
->getType() == 'daterange') {
$form['separator'] = [
'#type' => 'textfield',
'#title' => $this
->t('Date separator'),
'#description' => $this
->t('The string to separate the start and end dates'),
'#default_value' => $this
->getSetting('separator'),
];
}
$form['location'] = [
'#type' => 'fieldset',
'#title' => $this
->t('Location'),
'#open' => TRUE,
];
$form['location']['value'] = [
'#title' => $this
->t('Location Field:'),
'#type' => 'select',
'#options' => $location_options,
'#default_value' => isset($settings['location']['value']) ? $settings['location']['value'] : '',
'#description' => $this
->t('A field to use as the location for calendar events.'),
];
$form['location']['tokenized'] = [
'#title' => $this
->t('Tokenized Location Contents:'),
'#type' => 'textarea',
'#default_value' => isset($settings['location']['tokenized']) ? $settings['location']['tokenized'] : '',
'#description' => $this
->t('You can insert static text or use tokens (see the token chart below).'),
];
$form['description'] = [
'#type' => 'fieldset',
'#title' => $this
->t('Description'),
'#open' => TRUE,
];
$form['description']['value'] = [
'#title' => $this
->t('Description Field:'),
'#type' => 'select',
'#options' => $description_options,
'#default_value' => $this
->getSetting('description'),
'#description' => $this
->t('A field to use as the description for calendar events. <em>The contents used from this field will be truncated to 1024 characters</em>.'),
];
$form['description']['tokenized'] = [
'#title' => $this
->t('Tokenized Description Contents:'),
'#type' => 'textarea',
'#default_value' => isset($settings['description']['tokenized']) ? $settings['description']['tokenized'] : '',
'#description' => $this
->t('You can insert static text or use tokens (see the token chart below).'),
];
$form['past_events'] = [
'#title' => $this
->t('Show Add to Cal widget for Past Events'),
'#type' => 'checkbox',
'#default_value' => $settings['past_events'],
'#description' => $this
->t('Show the widget for past events.'),
];
return $form;
}
/**
* {@inheritdoc}
*/
public function viewElements(FieldItemListInterface $items, $langcode) {
$elements = [];
$entity = $items
->getEntity();
$settings = $this
->getSettings();
// Appends the field name into the settings for form use
$field = $this->fieldDefinition;
$field_name = $field
->get('field_name');
$settings['field_name'] = $field_name;
foreach ($items as $delta => $item) {
/** @var \Drupal\Core\Datetime\DrupalDateTime $start_date */
$start_date = NULL;
/** @var \Drupal\Core\Datetime\DrupalDateTime $end_date */
$end_date = NULL;
if ($field
->getType() == 'daterange') {
if (!empty($item->start_date)) {
$start_date = $item->start_date;
}
if (!empty($item->end_date)) {
$end_date = $item->end_date;
}
}
else {
if ($field
->getType() == 'date_recur') {
if (!empty($item->value)) {
$start_date = new DrupalDateTime($item->value, 'UTC');
}
if (!empty($item->end_value)) {
$end_date = new DrupalDateTime($item->end_value, 'UTC');
}
}
else {
if (!empty($item->date)) {
$start_date = $item->date;
}
}
}
if ($start_date && $end_date && $start_date
->format('U') !== $end_date
->format('U')) {
$elements[$delta] = [
'start_date' => $this
->buildDate($start_date),
'separator' => [
'#plain_text' => ' ' . $settings['separator'] . ' ',
],
'end_date' => $this
->buildDate($end_date),
];
}
elseif ($start_date) {
$elements[$delta] = $this
->buildDate($start_date);
}
else {
$elements[$delta] = [];
}
// Attaches the calendar form to each element
$form = new AddToCalForm($entity, $settings, $delta);
$form = \Drupal::formBuilder()
->getForm($form);
$elements[$delta] += $form;
}
return $elements;
}
/**
* Creates a render array from a date object.
*
* @param \Drupal\Core\Datetime\DrupalDateTime $date
* A date object.
*
* @return array
* A render array.
*/
protected function buildDate(DrupalDateTime $date) {
if ($this
->getFieldSetting('datetime_type') == DateTimeItem::DATETIME_TYPE_DATE) {
// A date without time will pick up the current time, use the default.
$date
->setDefaultDateTime();
}
$this
->setTimeZone($date);
$build = [
'#plain_text' => $this
->formatDate($date),
'#cache' => [
'contexts' => [
'timezone',
],
],
];
return $build;
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
AddtocalView:: |
protected | function |
Creates a render array from a date object. Overrides DateTimeFormatterBase:: |
|
AddtocalView:: |
public static | function |
Defines the default settings for this plugin. Overrides DateTimeCustomFormatter:: |
|
AddtocalView:: |
public | function |
Returns a form to configure settings for the formatter. Overrides DateTimeCustomFormatter:: |
|
AddtocalView:: |
public | function |
Overrides DateTimeCustomFormatter:: |
|
AddtocalView:: |
public | function |
Builds a renderable array for a field value. Overrides DateTimeCustomFormatter:: |
|
DateTimeCustomFormatter:: |
protected | function |
Creates a formatted date value as a string. Overrides DateTimeFormatterBase:: |
|
DateTimeFormatterBase:: |
protected | property | The date format entity storage. | |
DateTimeFormatterBase:: |
protected | property | The date formatter service. | |
DateTimeFormatterBase:: |
protected | function | Creates a render array from a date object with ISO date attribute. | |
DateTimeFormatterBase:: |
public static | function |
Creates an instance of the plugin. Overrides FormatterBase:: |
|
DateTimeFormatterBase:: |
protected | function | Gets a settings array suitable for DrupalDateTime::format(). | |
DateTimeFormatterBase:: |
protected | function | Sets the proper time zone on a DrupalDateTime object for the current user. | |
DateTimeFormatterBase:: |
public | function |
Constructs a new DateTimeDefaultFormatter. Overrides FormatterBase:: |
|
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 | |
FormatterBase:: |
protected | property | The field definition. | |
FormatterBase:: |
protected | property | The label display setting. | |
FormatterBase:: |
protected | property |
The formatter settings. Overrides PluginSettingsBase:: |
|
FormatterBase:: |
protected | property | The view mode. | |
FormatterBase:: |
protected | function | Returns the value of a field setting. | |
FormatterBase:: |
protected | function | Returns the array of field settings. | |
FormatterBase:: |
public static | function |
Returns if the formatter can be used for the provided field. Overrides FormatterInterface:: |
14 |
FormatterBase:: |
public | function |
Allows formatters to load information for field values being displayed. Overrides FormatterInterface:: |
2 |
FormatterBase:: |
public | function |
Builds a renderable array for a fully themed field. Overrides FormatterInterface:: |
1 |
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 plugin implementation definition. | 1 |
PluginBase:: |
protected | property | The plugin_id. | |
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 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. | |
PluginSettingsBase:: |
protected | property | Whether default settings have been merged into the current $settings. | |
PluginSettingsBase:: |
protected | property | The plugin settings injected by third party modules. | |
PluginSettingsBase:: |
public | function |
Calculates dependencies for the configured plugin. Overrides DependentPluginInterface:: |
6 |
PluginSettingsBase:: |
public | function |
Returns the value of a setting, or its default value if absent. Overrides PluginSettingsInterface:: |
|
PluginSettingsBase:: |
public | function |
Returns the array of settings, including defaults for missing settings. Overrides PluginSettingsInterface:: |
|
PluginSettingsBase:: |
public | function |
Gets the list of third parties that store information. Overrides ThirdPartySettingsInterface:: |
|
PluginSettingsBase:: |
public | function |
Gets the value of a third-party setting. Overrides ThirdPartySettingsInterface:: |
|
PluginSettingsBase:: |
public | function |
Gets all third-party settings of a given module. Overrides ThirdPartySettingsInterface:: |
|
PluginSettingsBase:: |
protected | function | Merges default settings values into $settings. | |
PluginSettingsBase:: |
public | function |
Informs the plugin that some configuration it depends on will be deleted. Overrides PluginSettingsInterface:: |
3 |
PluginSettingsBase:: |
public | function |
Sets the value of a setting for the plugin. Overrides PluginSettingsInterface:: |
|
PluginSettingsBase:: |
public | function |
Sets the settings for the plugin. Overrides PluginSettingsInterface:: |
|
PluginSettingsBase:: |
public | function |
Sets the value of a third-party setting. Overrides ThirdPartySettingsInterface:: |
|
PluginSettingsBase:: |
public | function |
Unsets a third-party setting. Overrides ThirdPartySettingsInterface:: |
|
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. |