class ForumSettingsForm in Drupal 9

Configure forum settings for this site.

@internal

Hierarchy

• class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, RedirectDestinationTrait, StringTranslationTrait
  • class \Drupal\Core\Form\ConfigFormBase uses ConfigFormBaseTrait
    • class \Drupal\forum\ForumSettingsForm

1 string reference to 'ForumSettingsForm'

forum.routing.yml in core/modules/forum/forum.routing.yml

core/modules/forum/forum.routing.yml

File

core/modules/forum/src/ForumSettingsForm.php, line 13

Namespace

Drupal\forum

class ForumSettingsForm extends ConfigFormBase {

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

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $config = $this
      ->config('forum.settings');
    $options = [
      5,
      10,
      15,
      20,
      25,
      30,
      35,
      40,
      50,
      60,
      80,
      100,
      150,
      200,
      250,
      300,
      350,
      400,
      500,
    ];
    $form['forum_hot_topic'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Hot topic threshold'),
      '#default_value' => $config
        ->get('topics.hot_threshold'),
      '#options' => array_combine($options, $options),
      '#description' => $this
        ->t('The number of replies a topic must have to be considered "hot".'),
    ];
    $options = [
      10,
      25,
      50,
      75,
      100,
    ];
    $form['forum_per_page'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Topics per page'),
      '#default_value' => $config
        ->get('topics.page_limit'),
      '#options' => array_combine($options, $options),
      '#description' => $this
        ->t('Default number of forum topics displayed per page.'),
    ];
    $order = [
      1 => $this
        ->t('Date - newest first'),
      2 => $this
        ->t('Date - oldest first'),
      3 => $this
        ->t('Posts - most active first'),
      4 => $this
        ->t('Posts - least active first'),
    ];
    $form['forum_order'] = [
      '#type' => 'radios',
      '#title' => $this
        ->t('Default order'),
      '#default_value' => $config
        ->get('topics.order'),
      '#options' => $order,
      '#description' => $this
        ->t('Default display order for topics.'),
    ];
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $this
      ->config('forum.settings')
      ->set('topics.hot_threshold', $form_state
      ->getValue('forum_hot_topic'))
      ->set('topics.page_limit', $form_state
      ->getValue('forum_per_page'))
      ->set('topics.order', $form_state
      ->getValue('forum_order'))
      ->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	18
ConfigFormBase::__construct	public	function	Constructs a \Drupal\system\ConfigFormBase object.	16
ConfigFormBaseTrait::config	protected	function	Retrieves a configuration object.
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
ForumSettingsForm::buildForm	public	function	Form constructor. Overrides ConfigFormBase::buildForm
ForumSettingsForm::getEditableConfigNames	protected	function	Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
ForumSettingsForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
ForumSettingsForm::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.	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.