class ConfigHandlerExtra
Same name in other branches
- 8.9.x core/modules/views_ui/src/Form/Ajax/ConfigHandlerExtra.php \Drupal\views_ui\Form\Ajax\ConfigHandlerExtra
- 10 core/modules/views_ui/src/Form/Ajax/ConfigHandlerExtra.php \Drupal\views_ui\Form\Ajax\ConfigHandlerExtra
- 11.x core/modules/views_ui/src/Form/Ajax/ConfigHandlerExtra.php \Drupal\views_ui\Form\Ajax\ConfigHandlerExtra
Provides a form for configuring extra information for a Views UI item.
@internal
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\views_ui\Form\Ajax\ViewsFormBase extends \Drupal\Core\Form\FormBase implements \Drupal\views_ui\Form\Ajax\ViewsFormInterface
- class \Drupal\views_ui\Form\Ajax\ConfigHandlerExtra extends \Drupal\views_ui\Form\Ajax\ViewsFormBase
- class \Drupal\views_ui\Form\Ajax\ViewsFormBase extends \Drupal\Core\Form\FormBase implements \Drupal\views_ui\Form\Ajax\ViewsFormInterface
Expanded class hierarchy of ConfigHandlerExtra
File
-
core/
modules/ views_ui/ src/ Form/ Ajax/ ConfigHandlerExtra.php, line 14
Namespace
Drupal\views_ui\Form\AjaxView source
class ConfigHandlerExtra extends ViewsFormBase {
/**
* Constructs a new ConfigHandlerExtra object.
*/
public function __construct($type = NULL, $id = NULL) {
$this->setType($type);
$this->setID($id);
}
/**
* {@inheritdoc}
*/
public function getFormKey() {
return 'handler-extra';
}
/**
* {@inheritdoc}
*/
public function getForm(ViewEntityInterface $view, $display_id, $js, $type = NULL, $id = NULL) {
$this->setType($type);
$this->setID($id);
return parent::getForm($view, $display_id, $js);
}
/**
* {@inheritdoc}
*/
public function getFormId() {
return 'views_ui_config_item_extra_form';
}
/**
* {@inheritdoc}
*/
public function buildForm(array $form, FormStateInterface $form_state) {
$view = $form_state->get('view');
$display_id = $form_state->get('display_id');
$type = $form_state->get('type');
$id = $form_state->get('id');
$form = [
'options' => [
'#tree' => TRUE,
'#theme_wrappers' => [
'container',
],
'#attributes' => [
'class' => [
'scroll',
],
'data-drupal-views-scroll' => TRUE,
],
],
];
$executable = $view->getExecutable();
if (!$executable->setDisplay($display_id)) {
$form['markup'] = [
'#markup' => $this->t('Invalid display id @display', [
'@display' => $display_id,
]),
];
return $form;
}
$item = $executable->getHandler($display_id, $type, $id);
if ($item) {
$handler = $executable->display_handler
->getHandler($type, $id);
if (empty($handler)) {
$form['markup'] = [
'#markup' => $this->t("Error: handler for @table > @field doesn't exist!", [
'@table' => $item['table'],
'@field' => $item['field'],
]),
];
}
else {
$handler->init($executable, $executable->display_handler, $item);
$types = ViewExecutable::getHandlerTypes();
$form['#title'] = $this->t('Configure extra settings for @type %item', [
'@type' => $types[$type]['lstitle'],
'%item' => $handler->adminLabel(),
]);
$form['#section'] = $display_id . '-' . $type . '-' . $id;
// Get form from the handler.
$handler->buildExtraOptionsForm($form['options'], $form_state);
$form_state->set('handler', $handler);
}
$view->getStandardButtons($form, $form_state, 'views_ui_config_item_extra_form');
}
return $form;
}
/**
* {@inheritdoc}
*/
public function validateForm(array &$form, FormStateInterface $form_state) {
$form_state->get('handler')
->validateExtraOptionsForm($form['options'], $form_state);
}
/**
* {@inheritdoc}
*/
public function submitForm(array &$form, FormStateInterface $form_state) {
$view = $form_state->get('view');
$handler = $form_state->get('handler');
// Run it through the handler's submit function.
$handler->submitExtraOptionsForm($form['options'], $form_state);
$item = $handler->options;
// Store the data we're given.
foreach ($form_state->getValue('options') as $key => $value) {
$item[$key] = $value;
}
// Store the item back on the view
$view->getExecutable()
->setHandler($form_state->get('display_id'), $form_state->get('type'), $form_state->get('id'), $item);
// Write to cache
$view->cacheSet();
}
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|
ConfigHandlerExtra::buildForm | public | function | Form constructor. | Overrides FormInterface::buildForm | |
ConfigHandlerExtra::getForm | public | function | Creates a new instance of this form. | Overrides ViewsFormBase::getForm | |
ConfigHandlerExtra::getFormId | public | function | Returns a unique string identifying the form. | Overrides FormInterface::getFormId | |
ConfigHandlerExtra::getFormKey | public | function | Returns the key that represents this form. | Overrides ViewsFormInterface::getFormKey | |
ConfigHandlerExtra::submitForm | public | function | Form submission handler. | Overrides ViewsFormBase::submitForm | |
ConfigHandlerExtra::validateForm | public | function | Form validation handler. | Overrides ViewsFormBase::validateForm | |
ConfigHandlerExtra::__construct | public | function | Constructs a new ConfigHandlerExtra object. | ||
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::create | public static | function | Instantiates a new instance of this class. | Overrides ContainerInjectionInterface::create | 105 |
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. | ||
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. | ||
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. | 17 | |
MessengerTrait::messenger | public | function | Gets the messenger. | 17 | |
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. | ||
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. | ||
ViewsFormBase::$id | protected | property | The ID of the item this form is manipulating. | ||
ViewsFormBase::$type | protected | property | The type of item this form is manipulating. | ||
ViewsFormBase::ajaxFormWrapper | protected | function | Wrapper for handling AJAX forms. | ||
ViewsFormBase::getFormState | public | function | Gets the form state for this form. | Overrides ViewsFormInterface::getFormState | 1 |
ViewsFormBase::setID | protected | function | Sets the ID for this form. | ||
ViewsFormBase::setType | protected | function | Sets the type for this form. |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.