class WizardTest

Same name in other branches
  1. 4.0.x tests/modules/ctools_wizard_test/src/Wizard/WizardTest.php \Drupal\ctools_wizard_test\Wizard\WizardTest

Hierarchy

Expanded class hierarchy of WizardTest

File

tests/modules/ctools_wizard_test/src/Wizard/WizardTest.php, line 11

Namespace

Drupal\ctools_wizard_test\Wizard
View source
class WizardTest extends FormWizardBase {
    
    /**
     * {@inheritdoc}
     */
    public function getWizardLabel() {
        return $this->t('Wizard Information');
    }
    
    /**
     * {@inheritdoc}
     */
    public function getMachineLabel() {
        return $this->t('Wizard Test Name');
    }
    
    /**
     * {@inheritdoc}
     */
    public function getOperations($cached_values) {
        return [
            'one' => [
                'form' => 'Drupal\\ctools_wizard_test\\Form\\OneForm',
                'title' => $this->t('Form One'),
                'values' => [
                    'dynamic' => 'Xylophone',
                ],
                'validate' => [
                    '::stepOneValidate',
                ],
                'submit' => [
                    '::stepOneSubmit',
                ],
            ],
            'two' => [
                'form' => 'Drupal\\ctools_wizard_test\\Form\\TwoForm',
                'title' => $this->t('Form Two'),
                'values' => [
                    'dynamic' => 'Zebra',
                ],
            ],
        ];
    }
    
    /**
     * Validation callback for the first step.
     */
    public function stepOneValidate($form, FormStateInterface $form_state) {
        if ($form_state->getValue('one') == 'wrong') {
            $form_state->setErrorByName('one', $this->t('Cannot set the value to "wrong".'));
        }
    }
    
    /**
     * Submission callback for the first step.
     */
    public function stepOneSubmit($form, FormStateInterface $form_state) {
        $cached_values = $form_state->getTemporaryValue('wizard');
        if ($form_state->getValue('one') == 'magic') {
            $cached_values['one'] = 'Abraham';
        }
        $form_state->setTemporaryValue('wizard', $cached_values);
    }
    
    /**
     * {@inheritdoc}
     */
    public function getRouteName() {
        return 'ctools.wizard.test.step';
    }
    
    /**
     * {@inheritdoc}
     */
    public function finish(array &$form, FormStateInterface $form_state) {
        $cached_values = $form_state->getTemporaryValue('wizard');
        $this->messenger()
            ->addMessage($this->t('Value One: @one', [
            '@one' => $cached_values['one'],
        ]));
        $this->messenger()
            ->addMessage($this->t('Value Two: @two', [
            '@two' => $cached_values['two'],
        ]));
        parent::finish($form, $form_state);
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
FormBase::$configFactory protected property The config factory. 3
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. 3
FormBase::container private function Returns the service container.
FormBase::create public static function Instantiates a new instance of this class. Overrides ContainerInjectionInterface::create 105
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.
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::$renderer protected property Renderer.
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::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::getParameters public static function Return an array of parameters required to construct this wizard. Overrides FormWizardInterface::getParameters 1
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::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::initValues public function Initialize wizard values. Overrides FormWizardInterface::initValues 1
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
FormWizardBase::__construct public function 1
FormWizardInterface::LOAD_VALUES constant Constant value for wizard load event.
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. 17
MessengerTrait::messenger public function Gets the messenger. 17
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. 3
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.
WizardTest::finish public function Form submit handler for finalizing the wizard values. Overrides FormWizardBase::finish
WizardTest::getMachineLabel public function
WizardTest::getOperations public function Retrieve a list of FormInterface classes by their step key in the wizard. Overrides FormWizardInterface::getOperations
WizardTest::getRouteName public function The name of the route to which forward or backwards steps redirect. Overrides FormWizardBase::getRouteName
WizardTest::getWizardLabel public function
WizardTest::stepOneSubmit public function Submission callback for the first step.
WizardTest::stepOneValidate public function Validation callback for the first step.