abstract class ConditionDelete in Chaos Tool Suite (ctools) 8.3
Hierarchy
- class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
- class \Drupal\Core\Form\ConfirmFormBase implements ConfirmFormInterface
- class \Drupal\ctools\Form\ConditionDelete
- class \Drupal\Core\Form\ConfirmFormBase implements ConfirmFormInterface
Expanded class hierarchy of ConditionDelete
File
- src/
Form/ ConditionDelete.php, line 15
Namespace
Drupal\ctools\FormView source
abstract class ConditionDelete extends ConfirmFormBase {
/**
* @var \Drupal\Core\TempStore\SharedTempStoreFactory
*/
protected $tempstore;
/**
* @var \Drupal\Core\Condition\ConditionManager
*/
protected $manager;
/**
* @var string
*/
protected $tempstore_id;
/**
* @var string
*/
protected $machine_name;
/**
* @var int
*/
protected $id;
/**
* {@inheritdoc}
*/
public static function create(ContainerInterface $container) {
return new static($container
->get('tempstore.shared'), $container
->get('plugin.manager.condition'));
}
public function __construct(SharedTempStoreFactory $tempstore, PluginManagerInterface $manager) {
$this->tempstore = $tempstore;
$this->manager = $manager;
}
/**
* {@inheritdoc}
*/
public function getFormId() {
return 'ctools_condition_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);
$conditions = $this
->getConditions($cached_values);
/** @var $instance \Drupal\ctools\ConstraintConditionInterface */
$instance = $this->manager
->createInstance($conditions[$this->id]['id'], $conditions[$this->id]);
if ($instance instanceof ConstraintConditionInterface) {
$instance
->removeConstraints($this
->getContexts($cached_values));
}
unset($conditions[$this->id]);
$cached_values = $this
->setConditions($cached_values, $conditions);
$this->tempstore
->get($this->tempstore_id)
->set($this->machine_name, $cached_values);
list($route_name, $route_parameters) = $this
->getParentRouteInfo($cached_values);
$form_state
->setRedirect($route_name, $route_parameters);
}
public function getQuestion($id = NULL, $cached_values = NULL) {
$condition = $this
->getConditions($cached_values)[$id];
return $this
->t('Are you sure you want to delete the @label condition?', [
'@label' => $condition['id'],
]);
}
/**
* {@inheritdoc}
*/
public function getDescription() {
return $this
->t('This action cannot be undone.');
}
/**
* {@inheritdoc}
*/
public function getFormName() {
return 'confirm';
}
/**
* {@inheritdoc}
*/
protected function actions(array $form, FormStateInterface $form_state) {
return [
'submit' => [
'#type' => 'submit',
'#value' => $this
->getConfirmText(),
'#validate' => [
[
$this,
'validateForm',
],
],
'#submit' => [
[
$this,
'submitForm',
],
],
],
'cancel' => ConfirmFormHelper::buildCancelLink($this, $this
->getRequest()),
];
}
/**
* Returns the route to go to if the user cancels the action.
*
* @return \Drupal\Core\Url
* A URL object.
*/
public function getCancelUrl() {
$cached_values = $this->tempstore
->get($this->tempstore_id)
->get($this->machine_name);
list($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 $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 conditions array from cached_values.
*
* @param $cached_values
*
* @return array
*/
protected abstract function getConditions($cached_values);
/**
* Custom logic for setting the conditions array in cached_values.
*
* @param $cached_values
*
* @param $conditions
* The conditions to set within the cached values.
*
* @return mixed
* Return the $cached_values
*/
protected abstract function setConditions($cached_values, $conditions);
/**
* Custom logic for retrieving the contexts array from cached_values.
*
* @param $cached_values
*
* @return \Drupal\Core\Plugin\Context\ContextInterface[]
*/
protected abstract function getContexts($cached_values);
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
ConditionDelete:: |
protected | property | ||
ConditionDelete:: |
protected | property | ||
ConditionDelete:: |
protected | property | ||
ConditionDelete:: |
protected | property | ||
ConditionDelete:: |
protected | property | ||
ConditionDelete:: |
protected | function | ||
ConditionDelete:: |
public | function |
Form constructor. Overrides ConfirmFormBase:: |
|
ConditionDelete:: |
public static | function |
Instantiates a new instance of this class. Overrides FormBase:: |
|
ConditionDelete:: |
public | function |
Returns a caption for the link which cancels the action. Overrides ConfirmFormBase:: |
|
ConditionDelete:: |
public | function |
Returns the route to go to if the user cancels the action. Overrides ConfirmFormInterface:: |
|
ConditionDelete:: |
abstract protected | function | Custom logic for retrieving the conditions array from cached_values. | |
ConditionDelete:: |
public | function |
Returns a caption for the button that confirms the action. Overrides ConfirmFormBase:: |
|
ConditionDelete:: |
abstract protected | function | Custom logic for retrieving the contexts array from cached_values. | |
ConditionDelete:: |
public | function |
Returns additional text to display as a description. Overrides ConfirmFormBase:: |
|
ConditionDelete:: |
public | function |
Returns a unique string identifying the form. Overrides FormInterface:: |
|
ConditionDelete:: |
public | function |
Returns the internal name used to refer to the confirmation item. Overrides ConfirmFormBase:: |
|
ConditionDelete:: |
abstract protected | function | Document the route name and parameters for redirect after submission. | |
ConditionDelete:: |
public | function |
Returns the question to ask the user. Overrides ConfirmFormInterface:: |
|
ConditionDelete:: |
abstract protected | function | Custom logic for setting the conditions array in cached_values. | |
ConditionDelete:: |
public | function |
Form submission handler. Overrides FormInterface:: |
|
ConditionDelete:: |
public | function | ||
DependencySerializationTrait:: |
protected | property | An array of entity type IDs keyed by the property name of their storages. | |
DependencySerializationTrait:: |
protected | property | An array of service IDs keyed by property name used for serialization. | |
DependencySerializationTrait:: |
public | function | 1 | |
DependencySerializationTrait:: |
public | function | 2 | |
FormBase:: |
protected | property | The config factory. | 1 |
FormBase:: |
protected | property | The request stack. | 1 |
FormBase:: |
protected | property | The route match. | |
FormBase:: |
protected | function | Retrieves a configuration object. | |
FormBase:: |
protected | function | Gets the config factory for this form. | 1 |
FormBase:: |
private | function | Returns the service container. | |
FormBase:: |
protected | function | Gets the current user. | |
FormBase:: |
protected | function | Gets the request object. | |
FormBase:: |
protected | function | Gets the route match. | |
FormBase:: |
protected | function | Gets the logger for a specific channel. | |
FormBase:: |
protected | function |
Returns a redirect response object for the specified route. Overrides UrlGeneratorTrait:: |
|
FormBase:: |
public | function | Resets the configuration factory. | |
FormBase:: |
public | function | Sets the config factory for this form. | |
FormBase:: |
public | function | Sets the request stack object to use. | |
FormBase:: |
public | function |
Form validation handler. Overrides FormInterface:: |
62 |
LinkGeneratorTrait:: |
protected | property | The link generator. | 1 |
LinkGeneratorTrait:: |
protected | function | Returns the link generator. | |
LinkGeneratorTrait:: |
protected | function | Renders a link to a route given a route name and its parameters. | |
LinkGeneratorTrait:: |
public | function | Sets the link generator service. | |
LoggerChannelTrait:: |
protected | property | The logger channel factory service. | |
LoggerChannelTrait:: |
protected | function | Gets the logger for a specific channel. | |
LoggerChannelTrait:: |
public | function | Injects the logger channel factory. | |
MessengerTrait:: |
protected | property | The messenger. | 29 |
MessengerTrait:: |
public | function | Gets the messenger. | 29 |
MessengerTrait:: |
public | function | Sets the messenger. | |
RedirectDestinationTrait:: |
protected | property | The redirect destination service. | 1 |
RedirectDestinationTrait:: |
protected | function | Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url. | |
RedirectDestinationTrait:: |
protected | function | Returns the redirect destination service. | |
RedirectDestinationTrait:: |
public | function | Sets the redirect destination service. | |
StringTranslationTrait:: |
protected | property | The string translation service. | 1 |
StringTranslationTrait:: |
protected | function | Formats a string containing a count of items. | |
StringTranslationTrait:: |
protected | function | Returns the number of plurals supported by a given language. | |
StringTranslationTrait:: |
protected | function | Gets the string translation service. | |
StringTranslationTrait:: |
public | function | Sets the string translation service to use. | 2 |
StringTranslationTrait:: |
protected | function | Translates a string to the current language or to a given language. | |
UrlGeneratorTrait:: |
protected | property | The url generator. | |
UrlGeneratorTrait:: |
protected | function | Returns the URL generator service. | |
UrlGeneratorTrait:: |
public | function | Sets the URL generator service. | |
UrlGeneratorTrait:: |
protected | function | Generates a URL or path for a specific route based on the given parameters. |