You are here

Home » API reference » Chaos Tool Suite (ctools) 8.3 » EntityFormWizardBase.php

abstract class EntityFormWizardBase in Chaos Tool Suite (ctools) 8.3

The base class for all entity form wizards.

Hierarchy

Expanded class hierarchy of EntityFormWizardBase

1 file declares its use of EntityFormWizardBase
EntityEditWizardTest.php in tests/modules/ctools_wizard_test/src/Wizard/EntityEditWizardTest.php

File

src/Wizard/EntityFormWizardBase.php, line 17

Namespace

Drupal\ctools\Wizard
View source 
abstract class EntityFormWizardBase extends FormWizardBase implements EntityFormWizardInterface {

  /**
   * The entity type manager.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;

  /**
   * @param \Drupal\Core\TempStore\SharedTempStoreFactory $tempstore
   *   Tempstore Factory for keeping track of values in each step of the
   *   wizard.
   * @param \Drupal\Core\Form\FormBuilderInterface $builder
   *   The Form Builder.
   * @param \Drupal\Core\DependencyInjection\ClassResolverInterface $class_resolver
   *   The class resolver.
   * @param \Symfony\Component\EventDispatcher\EventDispatcherInterface $event_dispatcher
   *   The event dispatcher.
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   The entity type manager.
   * @param $tempstore_id
   *   The shared temp store factory collection name.
   * @param null $machine_name
   *   The SharedTempStore key for our current wizard values.
   * @param null $step
   *   The current active step of the wizard.
   */
  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);
  }

  /**
   * {@inheritdoc}
   */
  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'),
    ];

    // Keep the deprecated entity manager service as a parameter as well for
    // BC, so that subclasses still work.
    if (\Drupal::hasService('entity.manager')) {
      $parameters['entity_manager'] = \Drupal::service('entity.manager');
    }
    return $parameters;
  }

  /**
   * {@inheritdoc}
   */
  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();
  }

  /**
   * {@inheritdoc}
   */
  public function finish(array &$form, FormStateInterface $form_state) {
    $cached_values = $form_state
      ->getTemporaryValue('wizard');

    /** @var \Drupal\Core\Entity\EntityInterface $entity */
    $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);
  }

  /**
   * Helper function for generating label and id form elements.
   *
   * @param array $form
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *
   * @return array
   */
  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 the entity already exists, allow for non-linear step interaction.
    if ($entity) {

      // Setup the step rendering theme element.
      $prefix = [
        '#theme' => [
          'ctools_wizard_trail_links',
        ],
        '#wizard' => $this,
        '#cached_values' => $cached_values,
      ];
      $form['#prefix'] = \Drupal::service('renderer')
        ->render($prefix);
    }

    // Get the current form operation.
    $operation = $this
      ->getOperation($cached_values);
    $operations = $this
      ->getOperations($cached_values);
    $default_operation = reset($operations);
    if ($operation['form'] == $default_operation['form']) {

      // Get the plugin definition of this entity.
      $definition = $this->entityTypeManager
        ->getDefinition($this
        ->getEntityType());

      // Create id and label form elements.
      $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;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
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
EntityFormWizardBase::$entityTypeManager protected property The entity type manager.
EntityFormWizardBase::customizeForm protected function Helper function for generating label and id form elements. Overrides FormWizardBase::customizeForm
EntityFormWizardBase::finish public function Form submit handler for finalizing the wizard values. Overrides FormWizardBase::finish
EntityFormWizardBase::getParameters public static function Return an array of parameters required to construct this wizard. Overrides FormWizardBase::getParameters
EntityFormWizardBase::initValues public function Initialize wizard values. Overrides FormWizardBase::initValues
EntityFormWizardBase::__construct public function Overrides FormWizardBase::__construct
EntityFormWizardInterface::exists public function A method for determining if this entity already exists. 1
EntityFormWizardInterface::getEntityType public function The machine name of the entity type. 1
EntityFormWizardInterface::getMachineLabel public function The form element #title for your unique identifier label. 1
EntityFormWizardInterface::getWizardLabel public function The fieldset #title for your label & machine name elements. 1
FormBase::$configFactory protected property The config factory. 1
FormBase::$requestStack protected property The request stack. 1
FormBase::$routeMatch protected property The route match.
FormBase::config protected function Retrieves a configuration object.
FormBase::configFactory protected function Gets the config factory for this form. 1
FormBase::container private function Returns the service container.
FormBase::create public static function Instantiates a new instance of this class. Overrides ContainerInjectionInterface::create 87
FormBase::currentUser protected function Gets the current user.
FormBase::getRequest protected function Gets the request object.
FormBase::getRouteMatch protected function Gets the route match.
FormBase::logger protected function Gets the logger for a specific channel.
FormBase::redirect protected function Returns a redirect response object for the specified route. Overrides UrlGeneratorTrait::redirect
FormBase::resetConfigFactory public function Resets the configuration factory.
FormBase::setConfigFactory public function Sets the config factory for this form.
FormBase::setRequestStack public function Sets the request stack object to use.
FormWizardBase::$builder protected property The Form Builder.
FormWizardBase::$classResolver protected property The class resolver.
FormWizardBase::$dispatcher protected property The event dispatcher.
FormWizardBase::$machine_name protected property The SharedTempStore key for our current wizard values.
FormWizardBase::$step protected property The current active step of the wizard.
FormWizardBase::$tempstore protected property Tempstore Factory for keeping track of values in each step of the wizard.
FormWizardBase::$tempstore_id protected property The shared temp store factory collection name.
FormWizardBase::actions protected function Generates action elements for navigating between the operation steps.
FormWizardBase::ajaxFinish public function Overrides FormWizardInterface::ajaxFinish
FormWizardBase::ajaxPrevious public function Overrides FormWizardInterface::ajaxPrevious
FormWizardBase::ajaxSubmit public function Overrides FormWizardInterface::ajaxSubmit
FormWizardBase::buildForm public function Form constructor. Overrides FormInterface::buildForm
FormWizardBase::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
FormWizardBase::getMachineName public function The SharedTempStore key for our current wizard values. Overrides FormWizardInterface::getMachineName
FormWizardBase::getNextOp public function The translated text of the "Next" button's text.
FormWizardBase::getNextParameters public function The Route parameters for a 'next' step. Overrides FormWizardInterface::getNextParameters
FormWizardBase::getOperation public function Retrieve the current Operation. Overrides FormWizardInterface::getOperation
FormWizardBase::getPreviousParameters public function The Route parameters for a 'previous' step. Overrides FormWizardInterface::getPreviousParameters
FormWizardBase::getRouteName public function The name of the route to which forward or backwards steps redirect. Overrides FormWizardInterface::getRouteName 2
FormWizardBase::getStep public function Retrieve the current active step of the wizard. Overrides FormWizardInterface::getStep
FormWizardBase::getTempstore public function The active SharedTempStore for this wizard. Overrides FormWizardInterface::getTempstore
FormWizardBase::getTempstoreId public function The shared temp store factory collection name. Overrides FormWizardInterface::getTempstoreId
FormWizardBase::populateCachedValues public function Form validation handler that populates the cached values from tempstore. Overrides FormWizardInterface::populateCachedValues
FormWizardBase::previous public function Form submit handler to step backwards in the wizard. Overrides FormWizardInterface::previous
FormWizardBase::submitForm public function Form submission handler. Overrides FormInterface::submitForm
FormWizardBase::validateForm public function Form validation handler. Overrides FormBase::validateForm
FormWizardInterface::getOperations public function Retrieve a list of FormInterface classes by their step key in the wizard. 2
FormWizardInterface::LOAD_VALUES constant Constant value for wizard load event.
LinkGeneratorTrait::$linkGenerator protected property The link generator. 1
LinkGeneratorTrait::getLinkGenerator Deprecated protected function Returns the link generator.
LinkGeneratorTrait::l Deprecated protected function Renders a link to a route given a route name and its parameters.
LinkGeneratorTrait::setLinkGenerator Deprecated public function Sets the link generator service.
LoggerChannelTrait::$loggerFactory protected property The logger channel factory service.
LoggerChannelTrait::getLogger protected function Gets the logger for a specific channel.
LoggerChannelTrait::setLoggerFactory public function Injects the logger channel factory.
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
RedirectDestinationTrait::$redirectDestination protected property The redirect destination service. 1
RedirectDestinationTrait::getDestinationArray protected function Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url.
RedirectDestinationTrait::getRedirectDestination protected function Returns the redirect destination service.
RedirectDestinationTrait::setRedirectDestination public function Sets the redirect destination service.
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.
UrlGeneratorTrait::$urlGenerator protected property The url generator.
UrlGeneratorTrait::getUrlGenerator Deprecated protected function Returns the URL generator service.
UrlGeneratorTrait::setUrlGenerator Deprecated public function Sets the URL generator service.
UrlGeneratorTrait::url Deprecated protected function Generates a URL or path for a specific route based on the given parameters.