Code owners
Assign users and groups as approvers for specific file changes. Learn more.
EventSeriesForm.php 11.90 KiB
<?php
namespace Drupal\recurring_events\Form;
use Drupal\Core\Entity\ContentEntityForm;
use Drupal\Core\Form\FormStateInterface;
use Symfony\Component\DependencyInjection\ContainerInterface;
use Drupal\recurring_events\EventCreationService;
use Drupal\Core\Entity\EntityStorageInterface;
use Drupal\Core\Messenger\Messenger;
use Drupal\Core\Datetime\DateFormatter;
use Drupal\Core\Entity\EntityFieldManager;
use Drupal\Core\Field\FieldTypePluginManager;
use Drupal\recurring_events\Plugin\Field\FieldWidget\ConsecutiveRecurringDateWidget;
use Drupal\Core\Entity\EntityTypeBundleInfoInterface;
use Drupal\Core\Entity\EntityRepositoryInterface;
use Drupal\Component\Datetime\TimeInterface;
use Drupal\Core\Session\AccountProxyInterface;
use Drupal\Core\Config\ConfigFactory;
use Drupal\Core\Extension\ModuleHandler;
/**
* Form controller for the eventseries entity create form.
*
* @ingroup recurring_events
*/
class EventSeriesForm extends ContentEntityForm {
/**
* The current step of the form.
*
* @var int
*/
protected $step = 0;
/**
* The event creation service.
*
* @var \Drupal\recurring_events\EventCreationService
*/
protected $creationService;
/**
* The entity storage interface.
*
* @var \Drupal\Core\Entity\EntityStorageInterface
*/
protected $storage;
/**
* The messenger service.
*
* @var \Drupal\Core\Messenger\Messenger
*/
protected $messenger;
/**
* The date formatter service.
*
* @var \Drupal\Core\Datetime\DateFormatter
*/
protected $dateFormatter;
/**
* The entity field manager.
*
* @var Drupal\Core\Entity\EntityFieldManager
*/
protected $entityFieldManager;
/**
* The field type plugin manager.
*
* @var Drupal\Core\Field\FieldTypePluginManager
*/
protected $fieldTypePluginManager;
/**
* The current user.
*
* @var \Drupal\Core\Session\AccountProxyInterface
*/
protected $currentUser;
/**
* The time service.
*
* @var \Drupal\Component\Datetime\TimeInterface
*/
protected $time;
/**
* The module handler service.
*
* @var \Drupal\Core\Extension\ModuleHandler
*/
protected $moduleHandler;
/**
* The configuration factory.
*
* @var \Drupal\Core\Config\ConfigFactory
*/
protected $configFactory;
/**
* {@inheritdoc}
*/
public static function create(ContainerInterface $container) {
return new static(
$container->get('recurring_events.event_creation_service'),
$container->get('entity_type.manager')->getStorage('eventseries'),
$container->get('messenger'),
$container->get('date.formatter'),
$container->get('entity_field.manager'),
$container->get('plugin.manager.field.field_type'),
$container->get('entity.repository'),
$container->get('entity_type.bundle.info'),
$container->get('datetime.time'),
$container->get('current_user'),
$container->get('module_handler'),
$container->get('config.factory')
);
}
/**
* Construct an EventSeriesForm.
*
* @param \Drupal\recurring_events\EventCreationService $creation_service
* The event creation service.
* @param \Drupal\Core\Entity\EntityStorageInterface $storage
* The storage interface.
* @param \Drupal\Core\Messenger\Messenger $messenger
* The messenger service.
* @param \Drupal\Core\Datetime\DateFormatter $date_formatter
* The date formatter service.
* @param \Drupal\Core\Entity\EntityFieldManager $entity_field_manager
* The entity field manager.
* @param \Drupal\Core\Field\FieldTypePluginManager $field_type_plugin_manager
* The field type plugin manager. * @param \Drupal\Core\Entity\EntityRepositoryInterface $entity_repository
* The entity repository interface.
* @param \Drupal\Core\Entity\EntityTypeBundleInfoInterface $entity_type_bundle_info
* The entity type bundle info interface.
* @param \Drupal\Component\Datetime\TimeInterface $time
* The time interface.
* @param \Drupal\Core\Session\AccountProxyInterface $current_user
* The current user.
* @param \Drupal\Core\Extension\ModuleHandler $module_handler
* The module handler service.
* @param \Drupal\Core\Config\ConfigFactory $config_factory
* The config factory.
*/
public function __construct(EventCreationService $creation_service, EntityStorageInterface $storage, Messenger $messenger, DateFormatter $date_formatter, EntityFieldManager $entity_field_manager, FieldTypePluginManager $field_type_plugin_manager, EntityRepositoryInterface $entity_repository, EntityTypeBundleInfoInterface $entity_type_bundle_info = NULL, TimeInterface $time = NULL, AccountProxyInterface $current_user = NULL, ModuleHandler $module_handler = NULL, ConfigFactory $config_factory = NULL) {
$this->creationService = $creation_service;
$this->storage = $storage;
$this->messenger = $messenger;
$this->dateFormatter = $date_formatter;
$this->entityFieldManager = $entity_field_manager;
$this->fieldTypePluginManager = $field_type_plugin_manager;
$this->time = $time;
$this->currentUser = $current_user;
$this->moduleHandler = $module_handler;
$this->configFactory = $config_factory;
parent::__construct($entity_repository, $entity_type_bundle_info, $time);
}
/**
* {@inheritdoc}
*/
public function buildForm(array $form, FormStateInterface $form_state) {
$form = parent::buildForm($form, $form_state);
$config = $this->configFactory->get('recurring_events.eventseries.config');
/* @var $entity \Drupal\recurring_events\Entity\EventSeries */
$entity = $this->entity;
$editing = ($form_state->getBuildInfo()['form_id'] == 'eventseries_' . $entity->bundle() . '_edit_form');
$form['custom_date']['#states'] = [
'visible' => [
':input[name="recur_type"]' => ['value' => 'custom'],
],
];
// Get all the available recur type fields. Suppress altering so that we can
// get a list of all the fields, so that after we alter, we can remove the
// necessary fields from the entity form.
$recur_fields = $this->creationService->getRecurFieldTypes(FALSE);
$all_recur_fields = $recur_fields;
$this->moduleHandler->alter('recurring_events_recur_field_types', $recur_fields);
$form['recur_type']['widget']['#options'] = $recur_fields;
// Loop through all the recurring date configuration fields and if any were
// suppressed then also suppress the fields associated with that.
foreach ($all_recur_fields as $field_name => $field_label) {
if (!isset($recur_fields[$field_name])) {
unset($form[$field_name]);
}
}
if ($editing) {
$original = $this->storage->loadUnchanged($entity->id());
if ($this->step === 1) {
$diff_array = $this->creationService->buildDiffArray($original, $form_state);
if (!empty($diff_array)) {
$this->step = 0; $form['diff'] = [
'#type' => 'container',
'#weight' => -10,
];
$form['diff']['diff_title'] = [
'#type' => '#markup',
'#prefix' => '<h2>',
'#markup' => $this->t('Confirm Date Changes'),
'#suffix' => '</h2>',
];
$form['diff']['diff_message'] = [
'#type' => '#markup',
'#prefix' => '<p>',
'#markup' => $this->t('Recurrence configuration has been changed, as a result all instances will be removed and recreated. This action cannot be undone.'),
'#suffix' => '</p>',
];
$form['diff']['table'] = [
'#type' => 'table',
'#header' => [
$this->t('Data'),
$this->t('Stored'),
$this->t('Overridden'),
],
'#rows' => $diff_array,
];
if ($config->get('threshold_warning')) {
$total = ConsecutiveRecurringDateWidget::checkDuration($form_state);
if ($total > $config->get('threshold_count')) {
$message = $config->get('threshold_message');
$message = str_replace('@total', $total, $message);
$form['diff']['count_warning'] = [
'#type' => 'markup',
'#prefix' => '<p class="form-item--error-message">',
'#markup' => $message,
'#suffix' => '</p>',
];
}
}
$form['diff']['confirm'] = [
'#type' => 'submit',
'#value' => $this->t('Confirm Date Changes'),
'#submit' => [
'::submitForm',
'::save',
],
];
}
}
}
$form['advanced']['#attributes']['class'][] = 'entity-meta';
$form['meta'] = [
'#type' => 'details',
'#group' => 'advanced',
'#weight' => -10,
'#title' => $this->t('Status'),
'#attributes' => ['class' => ['entity-meta__header']],
'#tree' => TRUE,
'#access' => $this->currentUser->hasPermission('administer eventseries'),
];
$form['meta']['published'] = [
'#type' => 'item',
'#markup' => $entity->isPublished() ? $this->t('Published') : $this->t('Not published'),
'#access' => !$entity->isNew(), '#wrapper_attributes' => ['class' => ['entity-meta__title']],
];
$form['meta']['changed'] = [
'#type' => 'item',
'#title' => $this->t('Last saved'),
'#markup' => !$entity->isNew() ? $this->dateFormatter->format($entity->getChangedTime(), 'short') : $this->t('Not saved yet'),
'#wrapper_attributes' => ['class' => ['entity-meta__last-saved']],
];
$form['meta']['author'] = [
'#type' => 'item',
'#title' => $this->t('Author'),
'#markup' => $entity->getOwner()->getDisplayName(),
'#wrapper_attributes' => ['class' => ['entity-meta__author']],
];
$form['#attached']['library'][] = 'recurring_events/recurring_events.create_form';
return $form;
}
/**
* {@inheritdoc}
*/
public function validateForm(array &$form, FormStateInterface $form_state) {
parent::validateForm($form, $form_state);
/* @var $entity \Drupal\recurring_events\Entity\EventSeries */
$entity = $this->entity;
$editing = ($form_state->getBuildInfo()['form_id'] == 'eventseries_' . $entity->bundle() . '_edit_form');
$trigger = $form_state->getTriggeringElement();
$ignored_triggers = [
'consecutive_recurring_date[0][duration]',
'consecutive_recurring_date[0][duration_units]',
];
if ($trigger['#id'] !== 'edit-confirm' && array_search($trigger['#name'], $ignored_triggers) === FALSE && $editing) {
$original = $this->storage->loadUnchanged($entity->id());
if (empty($form_state->getErrors()) && $this->creationService->checkForFormRecurConfigChanges($original, $form_state)) {
$this->step = 1;
$form_state->setRebuild(TRUE);
}
}
}
/**
* {@inheritdoc}
*/
public function save(array $form, FormStateInterface $form_state) {
$entity = $this->getEntity();
// Save as a new revision if requested to do so.
if (!$form_state->isValueEmpty('revision') && $form_state->getValue('revision') != FALSE) {
$entity->setNewRevision();
// If a new revision is created, save the current user as revision author.
$entity->setRevisionCreationTime($this->time->getRequestTime());
$entity->setRevisionUserId($this->currentUser->id());
}
else {
$entity->setNewRevision(FALSE);
}
if ($entity->isDefaultTranslation()) {
$this->messenger->addStatus($this->t('Successfully saved the %name event series', [
'%name' => $entity->title->value,
]));
}
else {
$this->messenger->addStatus($this->t('@language translation of the @type %label has been saved.', [ '@language' => $entity->language()->getName(),
'@type' => 'Event ',
'%label' => $entity->getUntranslated()->title->value,
]));
}
parent::save($form, $form_state);
$form_state->setRedirect('entity.eventseries.canonical', ['eventseries' => $entity->id()]);
}
}