You are here

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

abstract class ResolverRelationshipDelete in Chaos Tool Suite (ctools) 8.3

Hierarchy

Expanded class hierarchy of ResolverRelationshipDelete

File

src/Form/ResolverRelationshipDelete.php, line 13

Namespace

Drupal\ctools\Form
View source 
abstract class ResolverRelationshipDelete extends ConfirmFormBase {

  /**
   * @var \Drupal\Core\TempStore\SharedTempStoreFactory
   */
  protected $tempstore;

  /**
   * @var \Drupal\ctools\TypedDataResolver
   */
  protected $resolver;

  /**
   * @var string
   */
  protected $tempstore_id;

  /**
   * @var string
   */
  protected $machine_name;

  /**
   * @var string
   */
  protected $id;

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('tempstore.shared'), $container
      ->get('ctools.typed_data.resolver'));
  }

  /**
   * @param \Drupal\Core\TempStore\SharedTempStoreFactory $tempstore
   *   The shared tempstore.
   * @param \Drupal\ctools\TypedDataResolver $resolver
   *   The typed data resolver.
   */
  public function __construct(SharedTempStoreFactory $tempstore, TypedDataResolver $resolver) {
    $this->tempstore = $tempstore;
    $this->resolver = $resolver;
  }

  /**
   * {@inheritdoc}
   */
  public function getFormId() {
    return 'ctools_resolver_relationship_delete';
  }

  /**
   * {@inheritdoc}
   */
  public function getQuestion($id = NULL, $cached_values = []) {
    $context = $this
      ->getContexts($cached_values)[$id];
    return $this
      ->t('Are you sure you want to delete the @label relationship?', [
      '@label' => $context
        ->getContextDefinition()
        ->getLabel(),
    ]);
  }

  /**
   * {@inheritdoc}
   */
  public abstract function getCancelUrl($cached_values = []);

  /**
   * {@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, $cached_values);
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $cached_values = $this->tempstore
      ->get($this->tempstore_id)
      ->get($this->machine_name);
    $form_state
      ->setRedirectUrl($this
      ->getCancelUrl($cached_values));
  }

  /**
   * A custom form actions method.
   *
   * @param array $form
   *   The form array.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The current form state.
   * @param $cached_values
   *   The current wizard cached values.
   *
   * @return array
   */
  protected function actions(array $form, FormStateInterface $form_state, $cached_values) {
    return [
      'submit' => [
        '#type' => 'submit',
        '#value' => $this
          ->getConfirmText(),
        '#validate' => [
          [
            $this,
            'validate',
          ],
        ],
        '#submit' => [
          [
            $this,
            'submitForm',
          ],
        ],
      ],
      'cancel' => ConfirmFormHelper::buildCancelLink($this, $this
        ->getRequest()),
    ];
  }

  /**
   * Extract contexts from the cached values.
   *
   * @param array $cached_values
   *   The cached values.
   *
   * @return \Drupal\Core\Plugin\Context\ContextInterface[]
   */
  public abstract function getContexts($cached_values);

}

Members

Namesort descending Modifiers Type Description Overrides
ConfirmFormBase::getCancelText public function Returns a caption for the link which cancels the action. Overrides ConfirmFormInterface::getCancelText 1
ConfirmFormBase::getConfirmText public function Returns a caption for the button that confirms the action. Overrides ConfirmFormInterface::getConfirmText 20
ConfirmFormBase::getDescription public function Returns additional text to display as a description. Overrides ConfirmFormInterface::getDescription 11
ConfirmFormBase::getFormName public function Returns the internal name used to refer to the confirmation item. Overrides ConfirmFormInterface::getFormName
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::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.
FormBase::validateForm public function Form validation handler. Overrides FormInterface::validateForm 62
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.
ResolverRelationshipDelete::$id protected property
ResolverRelationshipDelete::$machine_name protected property
ResolverRelationshipDelete::$resolver protected property
ResolverRelationshipDelete::$tempstore protected property
ResolverRelationshipDelete::$tempstore_id protected property
ResolverRelationshipDelete::actions protected function A custom form actions method.
ResolverRelationshipDelete::buildForm public function Form constructor. Overrides ConfirmFormBase::buildForm
ResolverRelationshipDelete::create public static function Instantiates a new instance of this class. Overrides FormBase::create
ResolverRelationshipDelete::getCancelUrl abstract public function Returns the route to go to if the user cancels the action. Overrides ConfirmFormInterface::getCancelUrl
ResolverRelationshipDelete::getContexts abstract public function Extract contexts from the cached values.
ResolverRelationshipDelete::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
ResolverRelationshipDelete::getQuestion public function Returns the question to ask the user. Overrides ConfirmFormInterface::getQuestion
ResolverRelationshipDelete::submitForm public function Form submission handler. Overrides FormInterface::submitForm
ResolverRelationshipDelete::__construct public function
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.