class RequiredContextDelete

Same name in other branches
  1. 8.x-3.x src/Form/RequiredContextDelete.php \Drupal\ctools\Form\RequiredContextDelete

Base class for adding a required contexts step to your wizard.

Hierarchy

Expanded class hierarchy of RequiredContextDelete

File

src/Form/RequiredContextDelete.php, line 15

Namespace

Drupal\ctools\Form
View source
abstract class RequiredContextDelete extends ConfirmFormBase {
    
    /**
     * Creates a shared temporary storage for a collection.
     *
     * @var \Drupal\Core\TempStore\SharedTempStoreFactory
     */
    protected $tempstore;
    
    /**
     * The temporary id storage.
     *
     * @var string
     */
    // @codingStandardsIgnoreLine
    protected $tempstore_id;
    
    /**
     * The machine name.
     *
     * @var string
     */
    // @codingStandardsIgnoreLine
    protected $machine_name;
    
    /**
     * The id.
     *
     * @var int
     */
    protected $id;
    
    /**
     * {@inheritdoc}
     */
    public static function create(ContainerInterface $container) {
        return new static($container->get('tempstore.shared'));
    }
    
    /**
     * The constructor.
     *
     * @param \Drupal\Core\TempStore\SharedTempStoreFactory $tempstore
     *   The shared temporary storage.
     */
    public function __construct(SharedTempStoreFactory $tempstore) {
        $this->tempstore = $tempstore;
    }
    
    /**
     * {@inheritdoc}
     */
    public function getFormId() {
        return 'ctools_required_context_delete';
    }
    
    /**
     * {@inheritdoc}
     */
    public function buildForm(array $form, FormStateInterface $form_state, $id = NULL, $tempstore_id = NULL, $machine_name = NULL) {
        $this->tempstore_id = $tempstore_id;
        $this->machine_name = $machine_name;
        $this->id = $id;
        $cached_values = $this->tempstore
            ->get($this->tempstore_id)
            ->get($this->machine_name);
        $form['#title'] = $this->getQuestion($id, $cached_values);
        $form['#attributes']['class'][] = 'confirmation';
        $form['description'] = [
            '#markup' => $this->getDescription(),
        ];
        $form[$this->getFormName()] = [
            '#type' => 'hidden',
            '#value' => 1,
        ];
        // By default, render the form using theme_confirm_form().
        if (!isset($form['#theme'])) {
            $form['#theme'] = 'confirm_form';
        }
        $form['actions'] = [
            '#type' => 'actions',
        ];
        $form['actions'] += $this->actions($form, $form_state);
        return $form;
    }
    
    /**
     * {@inheritdoc}
     */
    public function submitForm(array &$form, FormStateInterface $form_state) {
        $cached_values = $this->tempstore
            ->get($this->tempstore_id)
            ->get($this->machine_name);
        $contexts = $this->getContexts($cached_values);
        unset($contexts[$this->id]);
        $cached_values = $this->setContexts($cached_values, $contexts);
        $this->tempstore
            ->get($this->tempstore_id)
            ->set($this->machine_name, $cached_values);
        [
            $route_name,
            $route_parameters,
        ] = $this->getParentRouteInfo($cached_values);
        $form_state->setRedirect($route_name, $route_parameters);
    }
    
    /**
     * {@inheritdoc}
     */
    public function getQuestion($id = NULL, $cached_values = NULL) {
        $context = $this->getContexts($cached_values)[$id];
        return $this->t('Are you sure you want to delete the @label context?', [
            '@label' => $context['label'],
        ]);
    }
    
    /**
     * {@inheritdoc}
     */
    public function getDescription() {
        return $this->t('This action cannot be undone.');
    }
    
    /**
     * {@inheritdoc}
     */
    public function getFormName() {
        return 'confirm';
    }
    
    /**
     * Provides the action buttons for submitting this form.
     */
    protected function actions(array $form, FormStateInterface $form_state) {
        return [
            'submit' => [
                '#type' => 'submit',
                '#value' => $this->getConfirmText(),
                '#validate' => [
                    [
                        $this,
                        'validate',
                    ],
                ],
                '#submit' => [
                    [
                        $this,
                        'submitForm',
                    ],
                ],
            ],
            'cancel' => ConfirmFormHelper::buildCancelLink($this, $this->getRequest()),
        ];
    }
    
    /**
     * {@inheritdoc}
     */
    public function getCancelUrl() {
        $cached_values = $this->tempstore
            ->get($this->tempstore_id)
            ->get($this->machine_name);
        [
            $route_name,
            $route_parameters,
        ] = $this->getParentRouteInfo($cached_values);
        return new Url($route_name, $route_parameters);
    }
    
    /**
     * {@inheritdoc}
     */
    public function getConfirmText() {
        return $this->t('Delete');
    }
    
    /**
     * {@inheritdoc}
     */
    public function getCancelText() {
        return $this->t('Cancel');
    }
    
    /**
     * Document the route name and parameters for redirect after submission.
     *
     * @param mixed $cached_values
     *   The cached values.
     *
     * @return array
     *   In the format of
     *   return [
     *     'route.name',
     *     ['machine_name' => $this->machine_name,'step' => 'step_name],
     *   ];
     */
    protected abstract function getParentRouteInfo($cached_values);
    
    /**
     * Custom logic for retrieving the contexts array from cached_values.
     *
     * @param mixed $cached_values
     *   The cache values.
     *
     * @return array
     *   Return an array.
     */
    protected abstract function getContexts($cached_values);
    
    /**
     * Custom logic for setting the contexts array in cached_values.
     *
     * @param mixed $cached_values
     *   The cache values.
     * @param mixed $contexts
     *   The contexts to set within the cached values.
     *
     * @return mixed
     *   Return the $cached_values
     */
    protected abstract function setContexts($cached_values, $contexts);

}

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::currentUser protected function Gets the current user. 2
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.
FormBase::validateForm public function Form validation handler. Overrides FormInterface::validateForm 57
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. 16
MessengerTrait::messenger public function Gets the messenger. 16
MessengerTrait::setMessenger public function Sets the messenger.
RedirectDestinationTrait::$redirectDestination protected property The redirect destination service. 2
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.
RequiredContextDelete::$id protected property The id.
RequiredContextDelete::$machine_name protected property
RequiredContextDelete::$tempstore protected property Creates a shared temporary storage for a collection.
RequiredContextDelete::$tempstore_id protected property
RequiredContextDelete::actions protected function Provides the action buttons for submitting this form.
RequiredContextDelete::buildForm public function Form constructor. Overrides ConfirmFormBase::buildForm
RequiredContextDelete::create public static function Instantiates a new instance of this class. Overrides FormBase::create
RequiredContextDelete::getCancelText public function Returns a caption for the link which cancels the action. Overrides ConfirmFormBase::getCancelText
RequiredContextDelete::getCancelUrl public function Returns the route to go to if the user cancels the action. Overrides ConfirmFormInterface::getCancelUrl
RequiredContextDelete::getConfirmText public function Returns a caption for the button that confirms the action. Overrides ConfirmFormBase::getConfirmText
RequiredContextDelete::getContexts abstract protected function Custom logic for retrieving the contexts array from cached_values.
RequiredContextDelete::getDescription public function Returns additional text to display as a description. Overrides ConfirmFormBase::getDescription
RequiredContextDelete::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
RequiredContextDelete::getFormName public function Returns the internal name used to refer to the confirmation item. Overrides ConfirmFormBase::getFormName
RequiredContextDelete::getParentRouteInfo abstract protected function Document the route name and parameters for redirect after submission.
RequiredContextDelete::getQuestion public function Returns the question to ask the user. Overrides ConfirmFormInterface::getQuestion
RequiredContextDelete::setContexts abstract protected function Custom logic for setting the contexts array in cached_values.
RequiredContextDelete::submitForm public function Form submission handler. Overrides FormInterface::submitForm
RequiredContextDelete::__construct public function The constructor.
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.