class SettingsForm in BugHerd 8

Class SettingsForm.

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\bugherd\Form\SettingsForm

Expanded class hierarchy of SettingsForm

1 string reference to 'SettingsForm'

bugherd.routing.yml in ./bugherd.routing.yml: bugherd.routing.yml

File

src/Form/SettingsForm.php, line 16

Namespace

Drupal\bugherd\Form

View source

class SettingsForm extends ConfigFormBase {

  /**
   * The cache tags invalidator service.
   *
   * @var Drupal\Core\Cache\CacheTagsInvalidatorInterface
   */
  protected $cacheTagsInvalidator;

  /**
   * {@inheritdoc}
   */
  public function __construct(ConfigFactoryInterface $config_factory, CacheTagsInvalidatorInterface $cache_tags_invalidator) {
    parent::__construct($config_factory);
    $this->cacheTagsInvalidator = $cache_tags_invalidator;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('config.factory'), $container
      ->get('cache_tags.invalidator'));
  }

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

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $config = $this
      ->config('bugherd.settings');
    $form['bugherd_project_key'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('BugHerd Project key'),
      '#description' => $this
        ->t('To obtain your project key login or sign up for BugHerd at @link.', [
        '@link' => Link::fromTextAndUrl('link', Url::fromUri('https://www.bugherd.com'))
          ->toString(),
      ]),
      '#maxlength' => 128,
      '#size' => 64,
      '#default_value' => $config
        ->get('bugherd_project_key'),
    ];
    $form['bugherd_disable_on_admin'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Disable on admin pages'),
      '#description' => $this
        ->t('Ticking the checkbox will prevent the BugHerd button being available on admin pages'),
      '#default_value' => $config
        ->get('bugherd_disable_on_admin'),
    ];
    $form['public_feedback'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Public feedback features'),
      '#open' => FALSE,
    ];
    $form['public_feedback']['public_feedback_message'] = [
      '#markup' => $this
        ->t('Those features work only for the public feedback. In order to enable the feedback for every visitor, follow the BugHerd documentation: @link', [
        '@link' => Link::fromTextAndUrl('Setting up the public feedback', Url::fromUri('https://support.bugherd.com/hc/en-us/articles/207581263-Setting-Up-The-Public-Feedback-Tab'))
          ->toString(),
      ]),
    ];
    $form['public_feedback']['bugherd_widget_position'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Position'),
      '#description' => $this
        ->t('Choose the default location of the BugHerd widget'),
      '#default_value' => $config
        ->get('bugherd_widget_position'),
      '#options' => [
        'bottom-right' => 'Bottom right',
        'bottom-left' => 'Bottom left',
      ],
    ];
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    parent::submitForm($form, $form_state);
    $this
      ->config('bugherd.settings')
      ->set('bugherd_project_key', $form_state
      ->getValue('bugherd_project_key'))
      ->set('bugherd_disable_on_admin', $form_state
      ->getValue('bugherd_disable_on_admin'))
      ->set('bugherd_widget_position', $form_state
      ->getValue('bugherd_widget_position'))
      ->save();

    // Clear all pages tagged with BugHerd cache tag.
    $this->cacheTagsInvalidator
      ->invalidateTags([
      'bugherd',
    ]);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
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.
SettingsForm::$cacheTagsInvalidator	protected	property	The cache tags invalidator service.
SettingsForm::buildForm	public	function	Form constructor. Overrides ConfigFormBase::buildForm
SettingsForm::create	public static	function	Instantiates a new instance of this class. Overrides ConfigFormBase::create
SettingsForm::getEditableConfigNames	protected	function	Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
SettingsForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
SettingsForm::submitForm	public	function	Form submission handler. Overrides ConfigFormBase::submitForm
SettingsForm::__construct	public	function	Constructs a \Drupal\system\ConfigFormBase object. Overrides ConfigFormBase::__construct
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.

You are here

class SettingsForm in BugHerd 8

Hierarchy

File

Namespace

Members

API Navigation