class TaxonomyBreadcrumbAdminSettings in Taxonomy Breadcrumb 8

Class TaxonomyBreadcrumbAdminSettings.

@package Drupal\taxonomy_breadcrumb\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\taxonomy_breadcrumb\Form\TaxonomyBreadcrumbAdminSettings

Expanded class hierarchy of TaxonomyBreadcrumbAdminSettings

1 string reference to 'TaxonomyBreadcrumbAdminSettings'

taxonomy_breadcrumb.routing.yml in ./taxonomy_breadcrumb.routing.yml: taxonomy_breadcrumb.routing.yml

File

src/Form/TaxonomyBreadcrumbAdminSettings.php, line 13

Namespace

Drupal\taxonomy_breadcrumb\Form

View source

class TaxonomyBreadcrumbAdminSettings extends ConfigFormBase {

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

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $form['settings'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Basic settings'),
      '#open' => TRUE,
    ];
    $form['settings']['taxonomy_breadcrumb_home'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Home breadcrumb text'),
      '#default_value' => \Drupal::config('taxonomy_breadcrumb.settings')
        ->get('taxonomy_breadcrumb_home'),
      '#description' => $this
        ->t('Text to display at top of breadcrumb trail. Typically home or your site name. Leave blank to have no home breadcrumb.'),
    ];
    $form['settings']['taxonomy_breadcrumb_page_title'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Show current page title in breadcrumb trail'),
      '#default_value' => \Drupal::config('taxonomy_breadcrumb.settings')
        ->get('taxonomy_breadcrumb_page_title'),
      '#description' => $this
        ->t("If enabled, the page title will be added as the last item in the breadcrumb trail."),
      '#weight' => 30,
    ];
    $form['advanced'] = [
      '#type' => 'details',
      '#description' => $this
        ->t('Use these advanced settings to control which node types the taxonomy-based breadcrumbs will be generated for.  This allows the taxonomy breadcrumb module to peacefully coexist with modules that define their own breadcrumbs, such as the book module.'),
      '#title' => $this
        ->t('Advanced settings'),
      '#open' => TRUE,
    ];
    $form['advanced']['taxonomy_breadcrumb_include_nodes'] = [
      '#type' => 'radios',
      '#title' => $this
        ->t('Include or exclude the following node types'),
      '#default_value' => \Drupal::config('taxonomy_breadcrumb.settings')
        ->get('taxonomy_breadcrumb_include_nodes'),
      '#options' => [
        1 => $this
          ->t('Include'),
        0 => $this
          ->t('Exclude'),
      ],
      '#weight' => 10,
    ];
    $tb_types = (array) \Drupal::config('taxonomy_breadcrumb.settings')
      ->get('taxonomy_breadcrumb_node_types');
    $default = [];
    foreach ($tb_types as $index => $value) {
      if ($value) {
        $default[] = $index;
      }
    }
    $form['advanced']['taxonomy_breadcrumb_node_types'] = [
      '#type' => 'checkboxes',
      '#title' => $this
        ->t('Node types to include or exclude'),
      '#default_value' => $default,
      '#options' => node_type_get_names(),
      '#description' => $this
        ->t('A list of node types to include or exclude when applying taxonomy-based breadcrumbs.'),
      '#weight' => 20,
    ];
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $config = $this
      ->config('taxonomy_breadcrumb.settings');
    $config
      ->set('taxonomy_breadcrumb_home', $form_state
      ->getValue('taxonomy_breadcrumb_home'));
    $config
      ->set('taxonomy_breadcrumb_page_title', $form_state
      ->getValue('taxonomy_breadcrumb_page_title'));
    $config
      ->set('taxonomy_breadcrumb_include_nodes', $form_state
      ->getValue('taxonomy_breadcrumb_include_nodes'));
    $config
      ->set('taxonomy_breadcrumb_node_types', $form_state
      ->getValue('taxonomy_breadcrumb_node_types'));
    $config
      ->save();
    if (method_exists($this, '_submitForm')) {
      $this
        ->_submitForm($form, $form_state);
    }
    parent::submitForm($form, $form_state);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
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.
TaxonomyBreadcrumbAdminSettings::buildForm	public	function	Form constructor. Overrides ConfigFormBase::buildForm
TaxonomyBreadcrumbAdminSettings::getEditableConfigNames	protected	function	Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
TaxonomyBreadcrumbAdminSettings::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
TaxonomyBreadcrumbAdminSettings::submitForm	public	function	Form submission handler. Overrides ConfigFormBase::submitForm
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.

You are here

class TaxonomyBreadcrumbAdminSettings in Taxonomy Breadcrumb 8

Hierarchy

File

Namespace

Members

API Navigation