class DefaultWizard in Flexiform 8

Provides a default form wizard.

Hierarchy

class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
- class \Drupal\ctools\Wizard\FormWizardBase implements FormWizardInterface
  - class \Drupal\flexiform_wizard\Wizard\DefaultWizard

Expanded class hierarchy of DefaultWizard

File

contrib/wizard/src/Wizard/DefaultWizard.php, line 16

Namespace

Drupal\flexiform_wizard\Wizard

View source

class DefaultWizard extends FormWizardBase {

  /**
   * The wizard configuration object.
   *
   * @var \Drupal\flexiform_wizard\Entity\Wizard
   */
  protected $wizard = NULL;

  /**
   * The provided entities.
   *
   * @var \Drupal\Core\Entity\FieldableEntityInterface[]
   */
  protected $provided = [];

  /**
   * Build the wizard object.
   *
   * @param \Drupal\Core\TempStore\PrivateTempStoreFactory $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\Routing\RouteMatchInterface $route_match
   *   The route match service.
   * @param \Drupal\flexiform_wizard\Entity\Wizard $wizard
   *   The wizard configuration entity.
   * @param string|null $step
   *   The current active step of the wizard.
   */
  public function __construct(PrivateTempStoreFactory $tempstore, FormBuilderInterface $builder, ClassResolverInterface $class_resolver, EventDispatcherInterface $event_dispatcher, RouteMatchInterface $route_match, WizardEntity $wizard, $step = NULL) {
    parent::__construct($tempstore, $builder, $class_resolver, $event_dispatcher, $route_match, 'flexiform_wizard.' . $wizard
      ->id(), 'flexiform_wizard__' . $wizard
      ->id(), $step);
    $this->wizard = $wizard;
    $provided = [];
    foreach ($this->wizard
      ->get('parameters') as $param_name => $param_info) {
      if ($provided_entity = $route_match
        ->getParameter($param_name)) {
        $provided[$param_name] = $provided_entity;
      }
    }
    $this->provided = $provided;
  }

  /**
   * {@inheritdoc}
   */
  public static function getParameters() {
    return [
      'tempstore' => \Drupal::service('user.private_tempstore'),
      'builder' => \Drupal::service('form_builder'),
      'class_resolver' => \Drupal::service('class_resolver'),
      'event_dispatcher' => \Drupal::service('event_dispatcher'),
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function initValues() {
    $values = parent::initValues();
    $values['entities'] += $this->provided;
    return $values;
  }

  /**
   * {@inheritdoc}
   */
  public function getMachineName() {
    return $this->wizard
      ->id();
  }

  /**
   * {@inheritdoc}
   */
  public function getTempstore() {
    return \Drupal::service('user.private_tempstore')
      ->get($this
      ->getTempstoreId());
  }

  /**
   * {@inheritdoc}
   */
  public function getOperations($cached_values) {
    $operations = [];
    foreach ($this->wizard
      ->getPages() as $name => $page) {
      $operations[$name] = [
        'form' => 'Drupal\\flexiform_wizard\\Form\\DefaultWizardOperation',
        'title' => $page['name'],
      ];
    }
    return $operations;
  }

  /**
   * {@inheritdoc}
   */
  public function getRouteName() {
    return 'flexiform_wizard.' . $this->wizard
      ->id() . '.step';
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DefaultWizard::$provided	protected	property	The provided entities.
DefaultWizard::$wizard	protected	property	The wizard configuration object.
DefaultWizard::getMachineName	public	function	The SharedTempStore key for our current wizard values. Overrides FormWizardBase::getMachineName
DefaultWizard::getOperations	public	function	Retrieve a list of FormInterface classes by their step key in the wizard. Overrides FormWizardInterface::getOperations
DefaultWizard::getParameters	public static	function	Return an array of parameters required to construct this wizard. Overrides FormWizardBase::getParameters
DefaultWizard::getRouteName	public	function	The name of the route to which forward or backwards steps redirect. Overrides FormWizardBase::getRouteName
DefaultWizard::getTempstore	public	function	The active SharedTempStore for this wizard. Overrides FormWizardBase::getTempstore
DefaultWizard::initValues	public	function	Initialize wizard values. Overrides FormWizardBase::initValues
DefaultWizard::__construct	public	function	Build the wizard object. Overrides FormWizardBase::__construct
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
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::customizeForm	protected	function	Helper function for generating default form elements.	1
FormWizardBase::finish	public	function	Form submit handler for finalizing the wizard values. Overrides FormWizardInterface::finish	2
FormWizardBase::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
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::getStep	public	function	Retrieve the current active step of the wizard. Overrides FormWizardInterface::getStep
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::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.

You are here

class DefaultWizard in Flexiform 8

Hierarchy

File

Namespace

Members

API Navigation