class ConfigForm in Taxonomy Access Control Lite 8

Builds the configuration form.

Hierarchy

• class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
  • class \Drupal\Core\Form\ConfigFormBase uses ConfigFormBaseTrait
    • class \Drupal\tac_lite\Form\ConfigForm

1 string reference to 'ConfigForm'

tac_lite.routing.yml in ./tac_lite.routing.yml

tac_lite.routing.yml

File

src/Form/ConfigForm.php, line 13

Namespace

Drupal\tac_lite\Form

class ConfigForm extends ConfigFormBase {

  /**
   * {@inheritdoc}
   */
  public function getEditableConfigNames() {
    return [
      'tac_lite.settings',
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function getFormId() {
    return 'tac_lite_admin_settings';
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $vocabularies = Vocabulary::loadMultiple();
    if (!count($vocabularies)) {
      $form['body'] = [
        '#markup' => $this
          ->t('You must <a href=":url">create a vocabulary</a> before you can use
          tac_lite.', [
          ':url' => Url::fromRoute('entity.taxonomy_vocabulary.add_form')
            ->toString(),
        ]),
      ];
      return $form;
    }
    else {
      $settings = $this->configFactory
        ->get('tac_lite.settings');
      $options = [];
      foreach ($vocabularies as $vocab) {
        $options[$vocab
          ->get('vid')] = $vocab
          ->get('name');
      }
      $form['tac_lite_categories'] = [
        '#type' => 'select',
        '#title' => $this
          ->t('Vocabularies'),
        '#default_value' => $settings
          ->get('tac_lite_categories'),
        '#options' => $options,
        '#description' => $this
          ->t('Select one or more vocabularies to control privacy.<br/>Use caution with hierarchical (nested) taxonomies as <em>visibility</em> settings may cause problems on node edit forms.<br/>Do not select free tagging vocabularies, they are not supported.'),
        '#multiple' => TRUE,
        '#required' => TRUE,
      ];
      $scheme_options = [];

      // Currently only view, edit, delete permissions possible, so 7
      // permutations will be more than enough.
      for ($i = 1; $i < 8; $i++) {
        $scheme_options[$i] = $i;
      }
      $form['tac_lite_schemes'] = [
        '#type' => 'select',
        '#title' => $this
          ->t('Number of Schemes'),
        '#description' => $this
          ->t('Each scheme allows for a different set of permissions.  For example, use scheme 1 for read-only permission; scheme 2 for read and update; scheme 3 for delete; etc. Additional schemes increase the size of your node_access table, so use no more than you need.'),
        '#default_value' => $settings
          ->get('tac_lite_schemes'),
        '#options' => $scheme_options,
        '#required' => TRUE,
      ];
      $form['tac_lite_rebuild'] = [
        '#type' => 'checkbox',
        '#title' => $this
          ->t('Rebuild content permissions now'),
        // Default false because usually only needed after scheme
        // has been changed.
        '#default_value' => FALSE,
        '#description' => $this
          ->t('Do this once, after you have fully configured access by taxonomy.'),
      ];
    }
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {

    // Clear the cache if new schemes are created/deleted, so that tabs are correctly displayed/removed.
    if ($this
      ->config('tac_lite.settings')
      ->get('tac_lite_schemes') != $form_state
      ->getValue('tac_lite_schemes')) {
      \Drupal::cache('render')
        ->deleteAll();
    }

    // Change configuration.
    $this
      ->config('tac_lite.settings')
      ->set('tac_lite_categories', $form_state
      ->getValue('tac_lite_categories'))
      ->set('tac_lite_schemes', $form_state
      ->getValue('tac_lite_schemes'))
      ->save();

    // Rebuild the node_access table.
    $rebuild = $form_state
      ->getValue('tac_lite_rebuild');
    if ($rebuild) {
      node_access_rebuild(TRUE);
    }
    else {
      $this
        ->messenger()
        ->addWarning($this
        ->t('Do not forget to <a href=:url>rebuild node access permissions </a> after you have configured taxonomy-based access.', [
        ':url' => Url::fromRoute('node.configure_rebuild_confirm')
          ->toString(),
      ]));
    }

    // And rebuild menus, in case the number of schemes has changed.
    \Drupal::service('router.builder')
      ->rebuild();
    parent::submitForm($form, $form_state);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ConfigForm::buildForm	public	function	Form constructor. Overrides ConfigFormBase::buildForm
ConfigForm::getEditableConfigNames	public	function	Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
ConfigForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
ConfigForm::submitForm	public	function	Form submission handler. Overrides ConfigFormBase::submitForm
ConfigFormBase::create	public static	function	Instantiates a new instance of this class. Overrides FormBase::create	13
ConfigFormBase::__construct	public	function	Constructs a \Drupal\system\ConfigFormBase object.	11
ConfigFormBaseTrait::config	protected	function	Retrieves a configuration object.
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
FormBase::$configFactory	protected	property	The config factory.	1
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.	1
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. 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.
FormBase::validateForm	public	function	Form validation handler. Overrides FormInterface::validateForm	62
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.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
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.	1
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.