You are here

Home » API reference » Quote 8.2 » SettingsForm.php

class SettingsForm in Quote 8.2

Class Settings Form.

@package Drupal\quote\Form

Hierarchy

Expanded class hierarchy of SettingsForm

1 string reference to 'SettingsForm'
quote.routing.yml in ./quote.routing.yml
quote.routing.yml

File

src/Form/SettingsForm.php, line 16

Namespace

Drupal\quote\Form
View source 
class SettingsForm extends ConfigFormBase {

  /**
   * A cache backend interface instance.
   *
   * @var \Drupal\Core\Cache\CacheBackendInterface
   */
  protected $cacheRender;

  /**
   * Module handler.
   *
   * @var \Drupal\Core\Extension\ModuleHandlerInterface
   */
  protected $moduleHandler;

  /**
   * SettingsForm constructor.
   *
   * @param \Drupal\Core\Cache\CacheBackendInterface $cacheRender
   *   CacheBackendInterface.
   * @param \Drupal\Core\Extension\ModuleHandlerInterface $moduleHandler
   *   ModuleHandlerInterface.
   */
  public function __construct(CacheBackendInterface $cacheRender, ModuleHandlerInterface $moduleHandler) {
    $this->cacheRender = $cacheRender;
    $this->moduleHandler = $moduleHandler;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('cache.render'), $container
      ->get('module_handler'));
  }

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

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $config = $this
      ->config('quote.settings');
    $form['modes'] = [
      '#type' => 'fieldset',
      '#title' => $this
        ->t('Select quote modes'),
    ];
    $form['modes']['quote_modes_quote_sel'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Quote selected'),
      '#default_value' => $config
        ->get('quote_modes_quote_sel'),
    ];
    $form['modes']['quote_modes_quote_all'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Quote all'),
      '#default_value' => $config
        ->get('quote_modes_quote_all'),
    ];
    $form['modes']['quote_modes_quote_reply_all'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Quote and reply all'),
      '#default_value' => $config
        ->get('quote_modes_quote_reply_all'),
    ];
    $form['modes']['quote_modes_quote_reply_sel'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Quote and reply selected'),
      '#default_value' => $config
        ->get('quote_modes_quote_reply_sel'),
      '#disabled' => TRUE,
    ];
    $form['where'] = [
      '#type' => 'fieldset',
      '#title' => $this
        ->t('Allow quotes in the:'),
    ];
    $form['where']['quote_allow_types'] = [
      '#type' => 'checkboxes',
      '#title' => $this
        ->t('Content types'),
      '#options' => node_type_get_names(),
      '#default_value' => $config
        ->get('quote_allow_types'),
    ];
    $form['where']['quote_allow_comments'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Comments'),
      '#description' => $this
        ->t('Checkbox works if node type allow quoting'),
      '#default_value' => $config
        ->get('quote_allow_comments'),
    ];
    $form['ckeditor_support_set'] = [
      '#type' => 'fieldset',
      '#title' => $this
        ->t('CKEditor support'),
    ];
    $form['ckeditor_support_set']['quote_ckeditor_support'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('CKEditor support'),
      '#description' => $this
        ->t('If checkbox checked and CKEditor found on the page, CKEditor will have a priority'),
      '#default_value' => $config
        ->get('quote_ckeditor_support'),
      '#disabled' => !$this->moduleHandler
        ->moduleExists('ckeditor'),
    ];
    $form['other'] = [
      '#type' => 'fieldset',
      '#title' => $this
        ->t('Other settings'),
    ];
    $form['other']['quote_selector'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('CSS selector of your comment form textarea (where you write new comments)'),
      '#description' => $this
        ->t('By default it is: #comment-form textarea'),
      '#default_value' => $config
        ->get('quote_selector'),
    ];
    $form['other']['quote_selector_comment_quote_all'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('CSS selector of your comment body class (where you quote all)'),
      '#description' => $this
        ->t('By default it is: .field--name-comment-body'),
      '#default_value' => $config
        ->get('quote_selector_comment_quote_all'),
    ];
    $form['other']['quote_selector_node_quote_all'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('CSS selector of your node body class (where you quote all)'),
      '#description' => $this
        ->t('By default it is: .field--name-body'),
      '#default_value' => $config
        ->get('quote_selector_node_quote_all'),
    ];
    $form['other']['quote_limit'] = [
      '#type' => 'number',
      '#title' => $this
        ->t('Quote limit'),
      '#default_value' => $config
        ->get('quote_limit'),
      '#max' => 9999,
      '#min' => 1,
    ];
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    parent::submitForm($form, $form_state);
    $allow_types = array_filter($form_state
      ->getValue('quote_allow_types', []));
    $this
      ->config('quote.settings')
      ->set('quote_modes_quote_sel', $form_state
      ->getValue('quote_modes_quote_sel'))
      ->set('quote_modes_quote_all', $form_state
      ->getValue('quote_modes_quote_all'))
      ->set('quote_modes_quote_reply_all', $form_state
      ->getValue('quote_modes_quote_reply_all'))
      ->set('quote_modes_quote_reply_sel', $form_state
      ->getValue('quote_modes_quote_reply_sel'))
      ->set('quote_allow_comments', $form_state
      ->getValue('quote_allow_comments'))
      ->set('quote_allow_types', $allow_types)
      ->set('quote_selector', $form_state
      ->getValue('quote_selector'))
      ->set('quote_limit', $form_state
      ->getValue('quote_limit'))
      ->set('quote_selector_comment_quote_all', $form_state
      ->getValue('quote_selector_comment_quote_all'))
      ->set('quote_selector_node_quote_all', $form_state
      ->getValue('quote_selector_node_quote_all'))
      ->set('quote_ckeditor_support', $form_state
      ->getValue('quote_ckeditor_support'))
      ->save();
    $this->cacheRender
      ->invalidateAll();
  }

}

Members

Namesort descending 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::$cacheRender protected property A cache backend interface instance.
SettingsForm::$moduleHandler protected property Module handler.
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 SettingsForm constructor. 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.