class HighlightSettingsForm in Highlight 8

Configure highlight settings for this site.

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\highlight\Form\HighlightSettingsForm

Expanded class hierarchy of HighlightSettingsForm

1 string reference to 'HighlightSettingsForm'

highlight.routing.yml in ./highlight.routing.yml: highlight.routing.yml

File

src/Form/HighlightSettingsForm.php, line 11

Namespace

Drupal\highlight\Form

View source

class HighlightSettingsForm extends ConfigFormBase {

  /**
   * Config settings.
   *
   * @var string
   */
  const SETTINGS = 'highlight.settings';

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

  /**
   * {@inheritdoc}
   */
  protected function getEditableConfigNames() {
    return [
      static::SETTINGS,
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $config = $this
      ->config(static::SETTINGS);
    $form['area'] = [
      '#type' => 'textarea',
      '#title' => $this
        ->t('Highlight area'),
      '#default_value' => $config
        ->get('area'),
      '#description' => $this
        ->t('Use jQuery selector to set the part of HTML you want to highlight.'),
    ];
    $form['class'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Highlight CSS class'),
      '#default_value' => $config
        ->get('class'),
      '#description' => $this
        ->t('Set the highlight CSS class that will be used for the enclosing highlight HTML tag.'),
    ];
    $form['color'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Highlight color'),
      '#default_value' => $config
        ->get('color'),
      '#description' => $this
        ->t('Set the highlight color with CSS value.'),
    ];
    $form['text_color'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Highlighted text color'),
      '#default_value' => $config
        ->get('text_color'),
      '#description' => $this
        ->t('Set the highlight color with CSS value.'),
    ];
    $form['wordsonly'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Highlight words'),
      '#default_value' => $config
        ->get('wordsonly'),
      '#description' => $this
        ->t('Highlight only full words.'),
    ];
    $form['patterns'] = [
      '#type' => 'textarea',
      '#title' => $this
        ->t('Local search patterns'),
      '#default_value' => implode("\n", $config
        ->get('patterns')),
      '#description' => $this
        ->t('Set the patterns to get local search keywords to highlight. Use JavaScript Regex and put each parttern per line.'),
    ];
    $form['patterns_referrer'] = [
      '#type' => 'textarea',
      '#title' => $this
        ->t('Referrer patterns'),
      '#default_value' => implode("\n", $config
        ->get('patterns_referrer')),
      '#description' => $this
        ->t('Set the referrer patterns for search engines. Use JavaScript Regex and put each parttern per line.'),
    ];
    $form['stopwords'] = [
      '#type' => 'textarea',
      '#title' => $this
        ->t('Stopwords'),
      '#default_value' => $config
        ->get('stopwords'),
      '#description' => $this
        ->t("Stopwords which shouldn't be highlighted."),
    ];
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $this->configFactory
      ->getEditable(static::SETTINGS)
      ->set('area', $form_state
      ->getValue('area'))
      ->set('class', $form_state
      ->getValue('class'))
      ->set('color', $form_state
      ->getValue('color'))
      ->set('text_color', $form_state
      ->getValue('text_color'))
      ->set('wordsonly', $form_state
      ->getValue('wordsonly'))
      ->set('patterns', explode("\n", $form_state
      ->getValue('patterns')))
      ->set('patterns_referrer', explode("\n", $form_state
      ->getValue('patterns_referrer')))
      ->set('stopwords', $form_state
      ->getValue('stopwords'))
      ->save();
    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
HighlightSettingsForm::buildForm	public	function	Form constructor. Overrides ConfigFormBase::buildForm
HighlightSettingsForm::getEditableConfigNames	protected	function	Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
HighlightSettingsForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
HighlightSettingsForm::SETTINGS		constant	Config settings.
HighlightSettingsForm::submitForm	public	function	Form submission handler. Overrides ConfigFormBase::submitForm
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.

You are here

class HighlightSettingsForm in Highlight 8

Hierarchy

File

Namespace

Members

API Navigation