class CommentDeleteSettingsForm in Comment Delete 8

Form to configure comment delete settings.

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\comment_delete\Form\CommentDeleteSettingsForm

Expanded class hierarchy of CommentDeleteSettingsForm

1 string reference to 'CommentDeleteSettingsForm'

comment_delete.routing.yml in ./comment_delete.routing.yml: comment_delete.routing.yml

File

src/Form/CommentDeleteSettingsForm.php, line 12

Namespace

Drupal\comment_delete\Form

View source

class CommentDeleteSettingsForm extends ConfigFormBase {

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

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $config = $this
      ->config('comment_delete.config');
    $form['default'] = [
      '#type' => 'radios',
      '#title' => $this
        ->t('Default selection'),
      '#description' => $this
        ->t('Default operation selected on the delete confirmation form.'),
      '#options' => [
        CommentDeleteManager::DELETE_REPLIES => $this
          ->t('Delete comment and its replies (full hard delete)'),
        CommentDeleteManager::MOVE_REPLIES => $this
          ->t('Delete comment and move its replies up one level (partial hard delete)'),
        CommentDeleteManager::KEEP_REPLIES => $this
          ->t('Delete comment and keep its replies (soft delete)'),
      ],
      '#required' => TRUE,
      '#default_value' => $config
        ->get('default_selection'),
    ];
    $form['soft'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Force soft delete'),
      '#description' => $this
        ->t('If enabled comments will never be fully deleted regardless of the chosen operation. See "Soft delete mode" setting.'),
      '#default_value' => $config
        ->get('soft'),
    ];
    $form['soft_mode'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Soft delete mode'),
      '#description' => $this
        ->t('WARNING: Set to unpublished (hide) does not re-thread comments. For instance, replies to a hidden comment still appear indented.'),
      '#options' => [
        'unset_values' => $this
          ->t('Unset values (recommended)'),
        'unpublished' => $this
          ->t('Set to unpublished (hide)'),
      ],
      '#default_value' => $config
        ->get('soft_mode'),
      '#required' => TRUE,
    ];
    $form['soft_user'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Remove author on soft delete (set as anonymous)'),
      '#description' => $this
        ->t('By default a soft deleted comment keeps its original author.'),
      '#default_value' => $config
        ->get('soft_user'),
    ];
    $form['threshold'] = [
      '#type' => 'number',
      '#title' => $this
        ->t('Threshold limit'),
      '#description' => $this
        ->t('Maximum time in seconds after creation that a comment can be deleted. Use zero (0) to disable.'),
      '#min' => 0,
      '#default_value' => $config
        ->get('threshold'),
      '#required' => TRUE,
    ];
    $form['message'] = [
      '#type' => 'textarea',
      '#title' => $this
        ->t('Confirmation message'),
      '#description' => $this
        ->t('A message shown after a comment has been deleted.'),
      '#default_value' => $config
        ->get('message'),
      '#required' => TRUE,
    ];
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $this
      ->config('comment_delete.config')
      ->set('default_selection', $form_state
      ->getValue('default'))
      ->set('soft', $form_state
      ->getValue('soft'))
      ->set('soft_mode', $form_state
      ->getValue('soft_mode'))
      ->set('soft_user', $form_state
      ->getValue('soft_user'))
      ->set('threshold', $form_state
      ->getValue('threshold'))
      ->set('message', $form_state
      ->getValue('message'))
      ->save();
    parent::submitForm($form, $form_state);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
CommentDeleteSettingsForm::buildForm	public	function	Form constructor. Overrides ConfigFormBase::buildForm
CommentDeleteSettingsForm::getEditableConfigNames	protected	function	Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
CommentDeleteSettingsForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
CommentDeleteSettingsForm::submitForm	public	function	Form submission handler. Overrides ConfigFormBase::submitForm
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.
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 CommentDeleteSettingsForm in Comment Delete 8

Hierarchy

File

Namespace

Members

API Navigation