class StatusForm in Simple XML sitemap 4.x

Class StatusForm

Hierarchy

class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, RedirectDestinationTrait, StringTranslationTrait
- class \Drupal\Core\Form\ConfigFormBase uses ConfigFormBaseTrait
  - class \Drupal\simple_sitemap\Form\SimpleSitemapFormBase
    class \Drupal\simple_sitemap\Form\StatusForm

Expanded class hierarchy of StatusForm

1 file declares its use of StatusForm

SimpleSitemapListBuilder.php in src/SimpleSitemapListBuilder.php

File

src/Form/StatusForm.php, line 17

Namespace

Drupal\simple_sitemap\Form

View source

class StatusForm extends SimpleSitemapFormBase {

  /**
   * @var \Drupal\Core\Database\Connection
   */
  protected $db;

  /**
   * @var \Drupal\Core\Datetime\DateFormatter
   */
  protected $dateFormatter;

  /**
   * @var \Drupal\simple_sitemap\Queue\QueueWorker
   */
  protected $queueWorker;

  /**
   * SitemapsForm constructor.
   *
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
   * @param SimplesitemapOld $generator
   * @param \Drupal\simple_sitemap\Settings $settings
   * @param \Drupal\simple_sitemap\Form\FormHelper $form_helper
   * @param \Drupal\Core\Database\Connection $database
   * @param \Drupal\Core\Datetime\DateFormatter $date_formatter
   * @param \Drupal\simple_sitemap\Queue\QueueWorker $queue_worker
   */
  public function __construct(ConfigFactoryInterface $config_factory, SimplesitemapOld $generator, Settings $settings, FormHelper $form_helper, Connection $database, DateFormatter $date_formatter, QueueWorker $queue_worker) {
    parent::__construct($config_factory, $generator, $settings, $form_helper);
    $this->db = $database;
    $this->dateFormatter = $date_formatter;
    $this->queueWorker = $queue_worker;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('config.factory'), $container
      ->get('simple_sitemap.generator'), $container
      ->get('simple_sitemap.settings'), $container
      ->get('simple_sitemap.form_helper'), $container
      ->get('database'), $container
      ->get('date.formatter'), $container
      ->get('simple_sitemap.queue_worker'));
  }

  /**
   * {@inheritdoc}
   */
  public function getFormId() : string {
    return 'simple_sitemap_status_form';
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) : array {
    $form['#attached']['library'][] = 'simple_sitemap/sitemaps';
    $form['status'] = [
      '#type' => 'fieldset',
      '#title' => $this
        ->t('Sitemap status'),
      '#markup' => '<div class="description">' . $this
        ->t('Sitemaps can be regenerated on demand here.') . '</div>',
    ];
    $form['status']['actions'] = [
      '#prefix' => '<div class="clearfix"><div class="form-item">',
      '#suffix' => '</div></div>',
    ];
    $form['status']['actions']['rebuild_queue_submit'] = [
      '#type' => 'submit',
      '#value' => $this
        ->t('Rebuild queue'),
      '#submit' => [
        self::class . '::rebuildQueue',
      ],
      '#validate' => [],
    ];
    $form['status']['actions']['regenerate_submit'] = [
      '#type' => 'submit',
      '#value' => $this->queueWorker
        ->generationInProgress() ? $this
        ->t('Resume generation') : $this
        ->t('Rebuild queue & generate'),
      '#submit' => [
        self::class . '::generateSitemap',
      ],
      '#validate' => [],
    ];
    $form['status']['progress'] = [
      '#prefix' => '<div class="clearfix">',
      '#suffix' => '</div>',
    ];
    $form['status']['progress']['title']['#markup'] = $this
      ->t('Progress of sitemap regeneration');
    $total_count = $this->queueWorker
      ->getInitialElementCount();
    if (!empty($total_count)) {
      $indexed_count = $this->queueWorker
        ->getProcessedElementCount();
      $percent = round(100 * $indexed_count / $total_count);

      // With all results processed, there still may be some stashed results to be indexed.
      $percent = $percent === 100 && $this->queueWorker
        ->generationInProgress() ? 99 : $percent;
      $index_progress = [
        '#theme' => 'progress_bar',
        '#percent' => $percent,
        '#message' => $this
          ->t('@indexed out of @total queue items have been processed.<br>Each sitemap is published after all of its items have been processed.', [
          '@indexed' => $indexed_count,
          '@total' => $total_count,
        ]),
      ];
      $form['status']['progress']['bar']['#markup'] = render($index_progress);
    }
    else {
      $form['status']['progress']['bar']['#markup'] = '<div class="description">' . $this
        ->t('There are no items to be indexed.') . '</div>';
    }
    return $form;
  }

  /**
   * @param array $form
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   */
  public static function generateSitemap(array &$form, FormStateInterface $form_state) : void {
    \Drupal::service('simple_sitemap.generator')
      ->generateSitemap();
  }

  /**
   * @param array $form
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   */
  public static function rebuildQueue(array &$form, FormStateInterface $form_state) : void {
    \Drupal::service('simple_sitemap.generator')
      ->rebuildQueue();
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ConfigFormBase::submitForm	public	function	Form submission handler. Overrides FormInterface::submitForm	32
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
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.
SimpleSitemapFormBase::$formHelper	protected	property
SimpleSitemapFormBase::$generator	protected	property
SimpleSitemapFormBase::$settings	protected	property
SimpleSitemapFormBase::getEditableConfigNames	protected	function	Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
StatusForm::$dateFormatter	protected	property
StatusForm::$db	protected	property
StatusForm::$queueWorker	protected	property
StatusForm::buildForm	public	function	Form constructor. Overrides ConfigFormBase::buildForm
StatusForm::create	public static	function	Instantiates a new instance of this class. Overrides SimpleSitemapFormBase::create
StatusForm::generateSitemap	public static	function
StatusForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
StatusForm::rebuildQueue	public static	function
StatusForm::__construct	public	function	SitemapsForm constructor. Overrides SimpleSitemapFormBase::__construct
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.

You are here

class StatusForm in Simple XML sitemap 4.x

Hierarchy

File

Namespace

Members

API Navigation