abstract class RelationshipConfigure 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\ctools\Form\RelationshipConfigure
Expanded class hierarchy of RelationshipConfigure
File
- src/
Form/ RelationshipConfigure.php, line 16
Namespace
Drupal\ctools\FormView source
abstract class RelationshipConfigure extends FormBase {
/**
* @var \Drupal\Core\TempStore\SharedTempStoreFactory
*/
protected $tempstore;
/**
* @var \Drupal\ctools\TypedDataResolver
*/
protected $resolver;
/**
* @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('ctools.typed_data.resolver'));
}
public function __construct(SharedTempStoreFactory $tempstore, TypedDataResolver $resolver) {
$this->tempstore = $tempstore;
$this->resolver = $resolver;
}
/**
* {@inheritdoc}
*/
public function getFormId() {
return 'ctools_relationship_configure';
}
/**
* {@inheritdoc}
*/
public function buildForm(array $form, FormStateInterface $form_state, $context_id = 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);
/** @var \Drupal\Core\Plugin\Context\ContextInterface[] $contexts */
$contexts = $this
->getContexts($cached_values);
$context_object = $this->resolver
->convertTokenToContext($context_id, $contexts);
$form['id'] = [
'#type' => 'value',
'#value' => $context_id,
];
$form['context_object'] = [
'#type' => 'value',
'#value' => $context_object,
];
$form['label'] = [
'#type' => 'textfield',
'#title' => $this
->t('Context label'),
'#default_value' => !empty($contexts[$context_id]) ? $contexts[$context_id]
->getContextDefinition()
->getLabel() : $this->resolver
->getLabelByToken($context_id, $contexts),
'#required' => TRUE,
];
$form['context_data'] = [
'#type' => 'item',
'#title' => $this
->t('Data type'),
'#markup' => $context_object
->getContextDefinition()
->getDataType(),
];
$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);
list($route_name, $route_options) = $this
->getParentRouteInfo($cached_values);
$form_state
->setRedirect($route_name, $route_options);
}
/**
* @param array $form
* @param \Drupal\Core\Form\FormStateInterface $form_state
*
* @return \Drupal\Core\Ajax\AjaxResponse
*/
public function ajaxSave(array &$form, FormStateInterface $form_state) {
$cached_values = $this->tempstore
->get($this->tempstore_id)
->get($this->machine_name);
list($route_name, $route_parameters) = $this
->getParentRouteInfo($cached_values);
$response = new AjaxResponse();
$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
*
* @return array In the format of
* In the format of
* return ['route.name', ['machine_name' => $this->machine_name, 'step' => 'step_name']];
*/
protected abstract function getParentRouteInfo($cached_values);
/**
* Custom logic for setting the conditions array in cached_values.
*
* @param $cached_values
*
* @param $contexts
* The conditions to set within the cached values.
*
* @return mixed
* Return the $cached_values
*/
protected abstract function setContexts($cached_values, $contexts);
/**
* 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 |
---|---|---|---|---|
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. | |
RelationshipConfigure:: |
protected | property | ||
RelationshipConfigure:: |
protected | property | ||
RelationshipConfigure:: |
protected | property | ||
RelationshipConfigure:: |
protected | property | ||
RelationshipConfigure:: |
public | function | ||
RelationshipConfigure:: |
public | function |
Form constructor. Overrides FormInterface:: |
|
RelationshipConfigure:: |
public static | function |
Instantiates a new instance of this class. Overrides FormBase:: |
|
RelationshipConfigure:: |
abstract protected | function | Custom logic for retrieving the contexts array from cached_values. | |
RelationshipConfigure:: |
public | function |
Returns a unique string identifying the form. Overrides FormInterface:: |
|
RelationshipConfigure:: |
abstract protected | function | Document the route name and parameters for redirect after submission. | |
RelationshipConfigure:: |
abstract protected | function | Custom logic for setting the conditions array in cached_values. | |
RelationshipConfigure:: |
public | function |
Form submission handler. Overrides FormInterface:: |
|
RelationshipConfigure:: |
public | function | ||
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. |