View source
<?php
namespace Drupal\ctools\Wizard;
use Drupal\Core\DependencyInjection\ClassResolverInterface;
use Drupal\Core\Entity\EntityTypeManagerInterface;
use Drupal\Core\Form\FormBuilderInterface;
use Drupal\Core\Form\FormStateInterface;
use Drupal\Core\Routing\RouteMatchInterface;
use Drupal\ctools\Event\WizardEvent;
use Drupal\Core\TempStore\SharedTempStoreFactory;
use Symfony\Component\EventDispatcher\EventDispatcherInterface;
abstract class EntityFormWizardBase extends FormWizardBase implements EntityFormWizardInterface {
protected $entityTypeManager;
public function __construct(SharedTempStoreFactory $tempstore, FormBuilderInterface $builder, ClassResolverInterface $class_resolver, EventDispatcherInterface $event_dispatcher, EntityTypeManagerInterface $entity_type_manager, RouteMatchInterface $route_match, $tempstore_id, $machine_name = NULL, $step = NULL) {
$this->entityTypeManager = $entity_type_manager;
parent::__construct($tempstore, $builder, $class_resolver, $event_dispatcher, $route_match, $tempstore_id, $machine_name, $step);
}
public static function getParameters() {
$parameters = [
'tempstore' => \Drupal::service('tempstore.shared'),
'builder' => \Drupal::service('form_builder'),
'class_resolver' => \Drupal::service('class_resolver'),
'event_dispatcher' => \Drupal::service('event_dispatcher'),
'entity_type_manager' => \Drupal::service('entity_type.manager'),
];
if (\Drupal::hasService('entity.manager')) {
$parameters['entity_manager'] = \Drupal::service('entity.manager');
}
return $parameters;
}
public function initValues() {
$storage = $this->entityTypeManager
->getStorage($this
->getEntityType());
if ($this
->getMachineName()) {
$values = $this
->getTempstore()
->get($this
->getMachineName());
if (!$values) {
$entity = $storage
->load($this
->getMachineName());
$values[$this
->getEntityType()] = $entity;
$values['id'] = $entity
->id();
$values['label'] = $entity
->label();
}
}
else {
$entity = $storage
->create([]);
$values[$this
->getEntityType()] = $entity;
}
$event = new WizardEvent($this, $values);
$this->dispatcher
->dispatch(FormWizardInterface::LOAD_VALUES, $event);
return $event
->getValues();
}
public function finish(array &$form, FormStateInterface $form_state) {
$cached_values = $form_state
->getTemporaryValue('wizard');
$entity = $cached_values[$this
->getEntityType()];
$entity
->set('id', $cached_values['id']);
$entity
->set('label', $cached_values['label']);
$status = $entity
->save();
$arguments = [
'@entity-type' => $entity
->getEntityType()
->getSingularLabel(),
'%label' => $entity
->label(),
];
if ($status === SAVED_UPDATED) {
$this
->messenger()
->addMessage($this
->t('The @entity-type %label has been updated.', $arguments));
$this
->logger($entity
->getEntityType()
->getProvider())
->notice('Updated @entity-type %label.', $arguments);
}
elseif ($status === SAVED_NEW) {
$this
->messenger()
->addMessage($this
->t('The @entity-type %label has been added.', $arguments));
$this
->logger($entity
->getEntityType()
->getProvider())
->notice('Added @entity-type %label.', $arguments);
}
$form_state
->setRedirectUrl($entity
->toUrl('collection'));
parent::finish($form, $form_state);
}
protected function customizeForm(array $form, FormStateInterface $form_state) {
$form = parent::customizeForm($form, $form_state);
if ($this->machine_name) {
$entity = $this->entityTypeManager
->getStorage($this
->getEntityType())
->load($this->machine_name);
}
else {
$entity = NULL;
}
$cached_values = $form_state
->getTemporaryValue('wizard');
if ($entity) {
$prefix = [
'#theme' => [
'ctools_wizard_trail_links',
],
'#wizard' => $this,
'#cached_values' => $cached_values,
];
$form['#prefix'] = \Drupal::service('renderer')
->render($prefix);
}
$operation = $this
->getOperation($cached_values);
$operations = $this
->getOperations($cached_values);
$default_operation = reset($operations);
if ($operation['form'] == $default_operation['form']) {
$definition = $this->entityTypeManager
->getDefinition($this
->getEntityType());
$form['name'] = [
'#type' => 'fieldset',
'#attributes' => [
'class' => [
'fieldset-no-legend',
],
],
'#title' => $this
->getWizardLabel(),
];
$form['name']['label'] = [
'#type' => 'textfield',
'#title' => $this
->getMachineLabel(),
'#required' => TRUE,
'#size' => 32,
'#default_value' => !empty($cached_values['label']) ? $cached_values['label'] : '',
'#maxlength' => 255,
'#disabled' => !empty($cached_values['label']),
];
$form['name']['id'] = [
'#type' => 'machine_name',
'#maxlength' => 128,
'#machine_name' => [
'source' => [
'name',
'label',
],
'exists' => $this
->exists(),
],
'#description' => $this
->t('A unique machine-readable name for this @entity_type. It must only contain lowercase letters, numbers, and underscores.', [
'@entity_type' => $definition
->getLabel(),
]),
'#default_value' => !empty($cached_values['id']) ? $cached_values['id'] : '',
'#disabled' => !empty($cached_values['id']),
];
}
return $form;
}
}