You are here

class SanitizerForm in Layout Builder Block Sanitizer 8

Class SanitizerForm.

Hierarchy

Expanded class hierarchy of SanitizerForm

1 string reference to 'SanitizerForm'
layout_builder_block_sanitizer.routing.yml in ./layout_builder_block_sanitizer.routing.yml
layout_builder_block_sanitizer.routing.yml

File

src/Form/SanitizerForm.php, line 15

Namespace

Drupal\layout_builder_block_sanitizer\Form
View source
class SanitizerForm extends FormBase implements ContainerInjectionInterface {

  /**
   * The layout builder block sanitizer manager.
   *
   * @var Drupal\layout_builder_block_sanitizer\LayoutBuilderBlockSanitizerManager
   */
  protected $layoutBuilderBlockSanitizerManager;

  /**
   * The layout builder block sanitizer batch class.
   *
   * @var Drupal\layout_builder_block_sanitizer\LayoutBuilderBlockSanitizerBatch
   */
  protected $layoutBuilderBlockSanitizerBatch;

  /**
   * Constructs a new SanitizerForm object.
   */
  public function __construct(LayoutBuilderBlockSanitizerManager $layout_builder_block_sanitizer_manager, LayoutBuilderBlockSanitizerBatch $layout_builder_block_sanitizer_batch) {
    $this->layoutBuilderBlockSanitizerManager = $layout_builder_block_sanitizer_manager;
    $this->layoutBuilderBlockSanitizerBatch = $layout_builder_block_sanitizer_batch;
  }

  /**
   * Create method.
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('layout_builder_block_sanitizer.manager'), $container
      ->get('layout_builder_block_sanitizer.batch'));
  }

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $form['individual_node_sanitize'] = [
      '#type' => 'fieldset',
      '#title' => 'Individual node sanitization',
    ];
    $form['individual_node_sanitize']['node_to_sanitize'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Node to sanitize'),
      '#description' => $this
        ->t('Enter a node ID to sanitize non-existent blocks from it. Be sure to clear caches if blocks have recently been created.'),
      '#maxlength' => 64,
      '#size' => 64,
    ];
    $form['individual_node_sanitize']['submit'] = [
      '#type' => 'submit',
      '#value' => $this
        ->t('Sanitize a single node'),
    ];
    $form['bulk_node_sanitize'] = [
      '#type' => 'fieldset',
      '#title' => 'Bulk node sanitization',
    ];
    $form['bulk_node_sanitize']['sanitize_all_nodes'] = [
      '#type' => 'submit',
      '#submit' => [
        '::batchSanitizeAllNodesStart',
      ],
      '#value' => 'Sanitize all nodes via batch',
      '#description' => $this
        ->t('Note that caches will be cleared during this process automatically.'),
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $nid_to_sanitize = $form_state
      ->getValue('node_to_sanitize');
    $this->layoutBuilderBlockSanitizerManager
      ->sanitizeNode($nid_to_sanitize);
  }

  /**
   * Kick off batch process to sanitize all nodes on site.
   */
  public function batchSanitizeAllNodesStart(array &$form, FormStateInterface $form_state) {
    $this->layoutBuilderBlockSanitizerBatch
      ->batchSanitizeAllNodesStart();
  }

}

Members

Namesort descending Modifiers Type Description Overrides
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::config protected function Retrieves a configuration object.
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.
SanitizerForm::$layoutBuilderBlockSanitizerBatch protected property The layout builder block sanitizer batch class.
SanitizerForm::$layoutBuilderBlockSanitizerManager protected property The layout builder block sanitizer manager.
SanitizerForm::batchSanitizeAllNodesStart public function Kick off batch process to sanitize all nodes on site.
SanitizerForm::buildForm public function Form constructor. Overrides FormInterface::buildForm
SanitizerForm::create public static function Create method. Overrides FormBase::create
SanitizerForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
SanitizerForm::submitForm public function Form submission handler. Overrides FormInterface::submitForm
SanitizerForm::__construct public function Constructs a new SanitizerForm object.
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.