class EditDetails

Same name in other branches
  1. 9 core/modules/views_ui/src/Form/Ajax/EditDetails.php \Drupal\views_ui\Form\Ajax\EditDetails
  2. 10 core/modules/views_ui/src/Form/Ajax/EditDetails.php \Drupal\views_ui\Form\Ajax\EditDetails
  3. 11.x core/modules/views_ui/src/Form/Ajax/EditDetails.php \Drupal\views_ui\Form\Ajax\EditDetails

Provides a form for editing the details of a View.

@internal

Hierarchy

Expanded class hierarchy of EditDetails

File

core/modules/views_ui/src/Form/Ajax/EditDetails.php, line 13

Namespace

Drupal\views_ui\Form\Ajax
View source
class EditDetails extends ViewsFormBase {
    
    /**
     * {@inheritdoc}
     */
    public function getFormKey() {
        return 'edit-details';
    }
    
    /**
     * {@inheritdoc}
     */
    public function getFormId() {
        return 'views_ui_edit_details_form';
    }
    
    /**
     * {@inheritdoc}
     */
    public function buildForm(array $form, FormStateInterface $form_state) {
        $view = $form_state->get('view');
        $form['#title'] = $this->t('Name and description');
        $form['#section'] = 'details';
        $form['details'] = [
            '#theme_wrappers' => [
                'container',
            ],
            '#attributes' => [
                'class' => [
                    'scroll',
                ],
                'data-drupal-views-scroll' => TRUE,
            ],
        ];
        $form['details']['label'] = [
            '#type' => 'textfield',
            '#title' => t('Administrative name'),
            '#default_value' => $view->label(),
        ];
        $form['details']['langcode'] = [
            '#type' => 'language_select',
            '#title' => $this->t('View language'),
            '#description' => $this->t('Language of labels and other textual elements in this view.'),
            '#default_value' => $view->get('langcode'),
        ];
        $form['details']['description'] = [
            '#type' => 'textfield',
            '#title' => t('Administrative description'),
            '#default_value' => $view->get('description'),
        ];
        $form['details']['tag'] = [
            '#type' => 'textfield',
            '#title' => t('Administrative tags'),
            '#description' => t('Enter a comma-separated list of words to describe your view.'),
            '#default_value' => $view->get('tag'),
            '#autocomplete_route_name' => 'views_ui.autocomplete',
        ];
        $view->getStandardButtons($form, $form_state, 'views_ui_edit_details_form');
        return $form;
    }
    
    /**
     * {@inheritdoc}
     */
    public function submitForm(array &$form, FormStateInterface $form_state) {
        $view = $form_state->get('view');
        foreach ($form_state->getValues() as $key => $value) {
            // Only save values onto the view if they're actual view properties
            // (as opposed to 'op' or 'form_build_id').
            if (isset($form['details'][$key])) {
                $view->set($key, $value);
            }
        }
        $bases = Views::viewsData()->fetchBaseTables();
        $page_title = $view->label();
        if (isset($bases[$view->get('base_table')])) {
            $page_title .= ' (' . $bases[$view->get('base_table')]['title'] . ')';
        }
        $form_state->set('page_title', $page_title);
        $view->cacheSet();
    }

}

Members

Title Sort descending Deprecated Modifiers Object type Summary Overriden Title Overrides
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
EditDetails::buildForm public function Form constructor. Overrides FormInterface::buildForm
EditDetails::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
EditDetails::getFormKey public function Returns the key that represents this form. Overrides ViewsFormInterface::getFormKey
EditDetails::submitForm public function Form submission handler. Overrides ViewsFormBase::submitForm
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. 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.
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. 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.
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.
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::getForm public function Creates a new instance of this form. Overrides ViewsFormInterface::getForm 6
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.
ViewsFormBase::validateForm public function Form validation handler. Overrides FormBase::validateForm 3

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.