class ConditionConfigure
Same name in other branches
- 8.x-3.x src/Form/ConditionConfigure.php \Drupal\ctools\Form\ConditionConfigure
Base class for condition configur operations.
Hierarchy
- class \Drupal\Core\Form\FormBase implements \Drupal\Core\Form\FormInterface, \Drupal\Core\DependencyInjection\ContainerInjectionInterface uses \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Logger\LoggerChannelTrait, \Drupal\Core\Messenger\MessengerTrait, \Drupal\Core\Routing\RedirectDestinationTrait, \Drupal\Core\StringTranslation\StringTranslationTrait
- class \Drupal\ctools\Form\ConditionConfigure extends \Drupal\Core\Form\FormBase
Expanded class hierarchy of ConditionConfigure
File
-
src/
Form/ ConditionConfigure.php, line 21
Namespace
Drupal\ctools\FormView source
abstract class ConditionConfigure extends FormBase {
/**
* @var \Drupal\Core\TempStore\SharedTempStoreFactory
*/
protected $tempstore;
/**
* @var \Drupal\Core\Condition\ConditionManager
*/
protected $manager;
/**
* @var string
*/
protected $tempstore_id;
/**
* @var string
*/
protected $machine_name;
/**
* {@inheritdoc}
*/
public static function create(ContainerInterface $container) {
return new static($container->get('tempstore.shared'), $container->get('plugin.manager.condition'));
}
/**
* Constructor for Condition Configuration.
*
* @param \Drupal\Core\TempStore\SharedTempStoreFactory $tempstore
* The Tempstore Factory.
* @param \Drupal\Component\Plugin\PluginManagerInterface $manager
* The Plugin Manager.
*/
public function __construct(SharedTempStoreFactory $tempstore, PluginManagerInterface $manager) {
$this->tempstore = $tempstore;
$this->manager = $manager;
}
/**
* {@inheritdoc}
*/
public function getFormId() {
return 'ctools_condition_configure';
}
/**
* {@inheritdoc}
*/
public function buildForm(array $form, FormStateInterface $form_state, $condition = NULL, $tempstore_id = NULL, $machine_name = NULL) {
$this->tempstore_id = $tempstore_id;
$this->machine_name = $machine_name;
$cached_values = $this->tempstore
->get($this->tempstore_id)
->get($this->machine_name);
if (is_numeric($condition) || Uuid::isValid($condition)) {
$id = $condition;
$condition = $this->getConditions($cached_values)[$id];
$instance = $this->manager
->createInstance($condition['id'], $condition);
}
else {
$instance = $this->manager
->createInstance($condition, []);
}
$form_state->setTemporaryValue('gathered_contexts', $this->getContexts($cached_values));
/** @var \Drupal\Core\Condition\ConditionInterface $instance */
$form = $instance->buildConfigurationForm($form, $form_state);
if (isset($id)) {
// Conditionally set this form element so that we can update or add.
$form['id'] = [
'#type' => 'value',
'#value' => $id,
];
}
$form['instance'] = [
'#type' => 'value',
'#value' => $instance,
];
$form['submit'] = [
'#type' => 'submit',
'#value' => $this->t('Save'),
'#ajax' => [
'callback' => [
$this,
'ajaxSave',
],
],
];
return $form;
}
/**
* {@inheritdoc}
*/
public function submitForm(array &$form, FormStateInterface $form_state) {
$cached_values = $this->tempstore
->get($this->tempstore_id)
->get($this->machine_name);
/** @var \Drupal\Core\Condition\ConditionInterface $instance */
$instance = $form_state->getValue('instance');
$instance->submitConfigurationForm($form, $form_state);
$conditions = $this->getConditions($cached_values);
if ($instance instanceof ContextAwarePluginInterface) {
/** @var \Drupal\Core\Plugin\ContextAwarePluginInterface $instance */
$context_mapping = $form_state->hasValue('context_mapping') ? $form_state->getValue('context_mapping') : [];
$instance->setContextMapping($context_mapping);
}
if ($instance instanceof ConstraintConditionInterface) {
/** @var \Drupal\ctools\ConstraintConditionInterface $instance */
$instance->applyConstraints($this->getContexts($cached_values));
}
if ($form_state->hasValue('id')) {
$conditions[$form_state->getValue('id')] = $instance->getConfiguration();
}
else {
$conditions[] = $instance->getConfiguration();
}
$cached_values = $this->setConditions($cached_values, $conditions);
$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);
}
/**
* Ajax callback to save tempstore values.
*
* @param array $form
* The Drupal Form.
* @param \Drupal\Core\Form\FormStateInterface $form_state
* The Form state.
*
* @return \Drupal\Core\Ajax\AjaxResponse
* Ajax values from tempstore.
*/
public function ajaxSave(array &$form, FormStateInterface $form_state) {
$response = new AjaxResponse();
$cached_values = $this->tempstore
->get($this->tempstore_id)
->get($this->machine_name);
[
$route_name,
$route_parameters,
] = $this->getParentRouteInfo($cached_values);
$url = Url::fromRoute($route_name, $route_parameters);
$response->addCommand(new RedirectCommand($url->toString()));
$response->addCommand(new CloseModalDialogCommand());
return $response;
}
/**
* Document the route name and parameters for redirect after submission.
*
* @param array $cached_values
* Cached values to get the route info.
*
* @return array
* In the format of [
* '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 array $cached_values
* Cached values to get contexts from.
*
* @return array
* The conditions attached to cached values.
*/
protected abstract function getConditions(array $cached_values);
/**
* Custom logic for setting the conditions array in cached_values.
*
* @param array $cached_values
* Cached values that will get set.
*
* @param mixed $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 array $cached_values
* Cached values to get contexts from.
*
* @return \Drupal\Core\Plugin\Context\ContextInterface[]
* The contexts from cache.
*/
protected abstract function getContexts(array $cached_values);
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|
ConditionConfigure::$machine_name | protected | property | |||
ConditionConfigure::$manager | protected | property | |||
ConditionConfigure::$tempstore | protected | property | |||
ConditionConfigure::$tempstore_id | protected | property | |||
ConditionConfigure::ajaxSave | public | function | Ajax callback to save tempstore values. | ||
ConditionConfigure::buildForm | public | function | Form constructor. | Overrides FormInterface::buildForm | |
ConditionConfigure::create | public static | function | Instantiates a new instance of this class. | Overrides FormBase::create | |
ConditionConfigure::getConditions | abstract protected | function | Custom logic for retrieving the conditions array from cached_values. | ||
ConditionConfigure::getContexts | abstract protected | function | Custom logic for retrieving the contexts array from cached_values. | ||
ConditionConfigure::getFormId | public | function | Returns a unique string identifying the form. | Overrides FormInterface::getFormId | |
ConditionConfigure::getParentRouteInfo | abstract protected | function | Document the route name and parameters for redirect after submission. | ||
ConditionConfigure::setConditions | abstract protected | function | Custom logic for setting the conditions array in cached_values. | ||
ConditionConfigure::submitForm | public | function | Form submission handler. | Overrides FormInterface::submitForm | |
ConditionConfigure::__construct | public | function | Constructor for Condition Configuration. | ||
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. | ||
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. |