You are here

Home » API reference » Custom Breadcrumbs 1.x » CustomBreadcrumbsSettingsForm.php

class CustomBreadcrumbsSettingsForm in Custom Breadcrumbs 1.x

Configure Custom breadcrumb settings for this site.

Hierarchy

Expanded class hierarchy of CustomBreadcrumbsSettingsForm

1 string reference to 'CustomBreadcrumbsSettingsForm'
custom_breadcrumbs.routing.yml in ./custom_breadcrumbs.routing.yml
custom_breadcrumbs.routing.yml

File

src/Form/CustomBreadcrumbsSettingsForm.php, line 11

Namespace

Drupal\custom_breadcrumbs\Form
View source 
class CustomBreadcrumbsSettingsForm extends ConfigFormBase {

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

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $config = $this
      ->config('custom_breadcrumbs.settings');
    $form['home'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Prepend default "Home" link'),
      '#default_value' => $config
        ->get('home'),
    ];
    $form['home_link'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('"Home" text'),
      '#default_value' => $config
        ->get('home_link'),
      '#states' => [
        'visible' => [
          'input[name="home"]' => [
            'checked' => TRUE,
          ],
        ],
      ],
    ];
    $form['current_page'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Append curent page title like the latest crumb'),
      '#default_value' => $config
        ->get('current_page'),
    ];
    $form['current_page_link'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Last crumb with link'),
      '#default_value' => $config
        ->get('current_page_link'),
      '#states' => [
        'visible' => [
          'input[name="current_page"]' => [
            'checked' => TRUE,
          ],
        ],
      ],
    ];
    $form['trim_title'] = [
      '#type' => 'number',
      '#title' => $this
        ->t('Trim title length'),
      '#default_value' => $config
        ->get('trim_title'),
      '#min' => 0,
    ];
    $form['admin_pages_disable'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Disable on admin pages'),
      '#description' => $this
        ->t('If checked, Custom breadcrumb will be disabled on admin pages.'),
      '#default_value' => $config
        ->get('admin_pages_disable'),
    ];
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $this
      ->config('custom_breadcrumbs.settings')
      ->set('home', $form_state
      ->getValue('home'))
      ->set('home_link', $form_state
      ->getValue('home_link'))
      ->set('current_page', $form_state
      ->getValue('current_page'))
      ->set('current_page_link', $form_state
      ->getValue('current_page_link'))
      ->set('trim_title', $form_state
      ->getValue('trim_title'))
      ->set('admin_pages_disable', $form_state
      ->getValue('admin_pages_disable'))
      ->save();
    parent::submitForm($form, $form_state);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
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. 16
ConfigFormBaseTrait::config protected function Retrieves a configuration object.
CustomBreadcrumbsSettingsForm::buildForm public function Form constructor. Overrides ConfigFormBase::buildForm
CustomBreadcrumbsSettingsForm::getEditableConfigNames protected function Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
CustomBreadcrumbsSettingsForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
CustomBreadcrumbsSettingsForm::submitForm public function Form submission handler. Overrides ConfigFormBase::submitForm
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 2
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.
FormBase::validateForm public function Form validation handler. Overrides FormInterface::validateForm 72
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. 27
MessengerTrait::messenger public function Gets the messenger. 27
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. 4
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.