class BookSettingsForm

Same name in other branches
  1. 8.9.x core/modules/book/src/Form/BookSettingsForm.php \Drupal\book\Form\BookSettingsForm
  2. 10 core/modules/book/src/Form/BookSettingsForm.php \Drupal\book\Form\BookSettingsForm
  3. 11.x core/modules/book/src/Form/BookSettingsForm.php \Drupal\book\Form\BookSettingsForm

Configure book settings for this site.

@internal

Hierarchy

Expanded class hierarchy of BookSettingsForm

1 string reference to 'BookSettingsForm'
book.routing.yml in core/modules/book/book.routing.yml
core/modules/book/book.routing.yml

File

core/modules/book/src/Form/BookSettingsForm.php, line 13

Namespace

Drupal\book\Form
View source
class BookSettingsForm extends ConfigFormBase {
    
    /**
     * {@inheritdoc}
     */
    public function getFormId() {
        return 'book_admin_settings';
    }
    
    /**
     * {@inheritdoc}
     */
    protected function getEditableConfigNames() {
        return [
            'book.settings',
        ];
    }
    
    /**
     * {@inheritdoc}
     */
    public function buildForm(array $form, FormStateInterface $form_state) {
        $types = node_type_get_names();
        $config = $this->config('book.settings');
        $form['book_allowed_types'] = [
            '#type' => 'checkboxes',
            '#title' => $this->t('Content types allowed in book outlines'),
            '#default_value' => $config->get('allowed_types'),
            '#options' => $types,
            '#description' => $this->t('Users with the %outline-perm permission can add all content types.', [
                '%outline-perm' => $this->t('Administer book outlines'),
            ]),
            '#required' => TRUE,
        ];
        $form['book_child_type'] = [
            '#type' => 'radios',
            '#title' => $this->t('Content type for the <em>Add child page</em> link'),
            '#default_value' => $config->get('child_type'),
            '#options' => $types,
            '#required' => TRUE,
        ];
        return parent::buildForm($form, $form_state);
    }
    
    /**
     * {@inheritdoc}
     */
    public function validateForm(array &$form, FormStateInterface $form_state) {
        $child_type = $form_state->getValue('book_child_type');
        if ($form_state->isValueEmpty([
            'book_allowed_types',
            $child_type,
        ])) {
            $form_state->setErrorByName('book_child_type', $this->t('The content type for the %add-child link must be one of those selected as an allowed book outline type.', [
                '%add-child' => $this->t('Add child page'),
            ]));
        }
        parent::validateForm($form, $form_state);
    }
    
    /**
     * {@inheritdoc}
     */
    public function submitForm(array &$form, FormStateInterface $form_state) {
        $allowed_types = array_filter($form_state->getValue('book_allowed_types'));
        // We need to save the allowed types in an array ordered by machine_name so
        // that we can save them in the correct order if node type changes.
        // @see book_node_type_update().
        sort($allowed_types);
        $this->config('book.settings')
            ->set('allowed_types', $allowed_types)
            ->set('child_type', $form_state->getValue('book_child_type'))
            ->save();
        parent::submitForm($form, $form_state);
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
BookSettingsForm::buildForm public function Form constructor. Overrides ConfigFormBase::buildForm
BookSettingsForm::getEditableConfigNames protected function Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
BookSettingsForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
BookSettingsForm::submitForm public function Form submission handler. Overrides ConfigFormBase::submitForm
BookSettingsForm::validateForm public function Form validation handler. Overrides FormBase::validateForm
ConfigFormBase::create public static function Instantiates a new instance of this class. Overrides FormBase::create 18
ConfigFormBase::__construct public function Constructs a \Drupal\system\ConfigFormBase object. 17
ConfigFormBaseTrait::config protected function Retrieves a configuration 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::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.
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 &#039;destination&#039; 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.

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