class LiveChatSettingsForm in LiveChat 8

Same name and namespace in other branches

8.2 src/Form/LiveChatSettingsForm.php \Drupal\livechat\Form\LiveChatSettingsForm

Configure Coffee 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\livechat\Form\LiveChatSettingsForm

Expanded class hierarchy of LiveChatSettingsForm

1 string reference to 'LiveChatSettingsForm'

livechat.routing.yml in ./livechat.routing.yml: livechat.routing.yml

File

src/Form/LiveChatSettingsForm.php, line 11

Namespace

Drupal\livechat\Form

View source

class LiveChatSettingsForm extends ConfigFormBase {

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

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $config = $this
      ->config(LIVECHAT_CONFIGURATION_NAME);
    $form['path'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Visibility'),
      '#open' => TRUE,
    ];
    $form['path']['livechat_visibility'] = [
      '#type' => 'radios',
      '#title' => $this
        ->t('Show LiveChat on'),
      '#options' => array(
        LIVECHAT_VISIBILITY_NOTLISTED => $this
          ->t('All pages except those listed'),
        LIVECHAT_VISIBILITY_LISTED => $this
          ->t('Only the listed pages'),
      ),
      '#default_value' => $config
        ->get('livechat_visibility'),
    ];
    $form['path']['livechat_pages'] = [
      '#type' => 'textarea',
      '#default_value' => $config
        ->get('livechat_pages'),
      '#description' => $this
        ->t("Specify pages by using their paths. Enter one path per\n      line. The '*' character is a wildcard. Example paths are %blog for the blog\n      page and %blog-wildcard for every personal blog. %front is the\n      front page.", [
        '%blog' => 'blog',
        '%blog-wildcard' => 'blog/*',
        '%front' => '<front>',
      ]),
    ];
    $form['path']['livechat_exclude_system_paths'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Disable LiveChat on common system paths (recommended)'),
      '#description' => $this
        ->t('LiveChat will not trigger on the following paths: %paths', [
        '%paths' => str_replace("\n", ', ', LIVECHAT_VISIBILITY_SYSTEM_PATHS),
      ]),
      '#default_value' => $config
        ->get('livechat_exclude_system_paths'),
    ];
    $form['livechat_group'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Group Id'),
      '#description' => $this
        ->t('If you are using LiveChat on more than one website,
       enter the id of the website here'),
      '#default_value' => $config
        ->get('livechat_group'),
    ];
    $form['livechat_enabled'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Enable LiveChat'),
      '#description' => $this
        ->t('Uncheck this box to disable LiveChat.'),
      '#default_value' => $config
        ->get('livechat_enabled'),
    ];
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $values = $form_state
      ->getValues();
    $this
      ->config(LIVECHAT_CONFIGURATION_NAME)
      ->set('livechat_visibility', $values['livechat_visibility'])
      ->set('livechat_pages', $values['livechat_pages'])
      ->set('livechat_exclude_system_paths', $values['livechat_exclude_system_paths'])
      ->set('livechat_group', $values['livechat_group'])
      ->set('livechat_enabled', $values['livechat_enabled'])
      ->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
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.
LiveChatSettingsForm::buildForm	public	function	Form constructor. Overrides ConfigFormBase::buildForm
LiveChatSettingsForm::getEditableConfigNames	protected	function	Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
LiveChatSettingsForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
LiveChatSettingsForm::submitForm	public	function	Form submission handler. Overrides ConfigFormBase::submitForm
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 LiveChatSettingsForm in LiveChat 8

Hierarchy

File

Namespace

Members

API Navigation