class ConfirmClearReplicationQueueForm in Workspace 8

Class ConfirmClearReplicationQueueForm.

@package Drupal\replication\Form

Hierarchy

• class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
  • class \Drupal\Core\Form\ConfirmFormBase implements ConfirmFormInterface
    • class \Drupal\workspace\Form\ConfirmClearReplicationQueueForm

1 string reference to 'ConfirmClearReplicationQueueForm'

workspace.routing.yml in ./workspace.routing.yml

workspace.routing.yml

File

src/Form/ConfirmClearReplicationQueueForm.php, line 17

Namespace

Drupal\workspace\Form

class ConfirmClearReplicationQueueForm extends ConfirmFormBase {

  /**
   * The entity type storage service.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;
  public function __construct(EntityTypeManagerInterface $entity_type_manager) {
    $this->entityTypeManager = $entity_type_manager;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('entity.manager'));
  }

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

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    if ($this
      ->clearReplicationQueue()) {
      $message = $this
        ->t('All the queued deployments have been marked as failed and have been removed from the replication queue.');
    }
    else {
      $message = $this
        ->t('There were not any queued deployments in the replication queue.');
    }
    $form_state
      ->setRedirectUrl($this
      ->getCancelUrl());
    $this
      ->messenger()
      ->addMessage($message);
  }

  /**
   * Clears the replication queue.
   *
   * @see \Drupal\workspace\Plugin\QueueWorker\WorkspaceReplication::processItem().
   */
  public function clearReplicationQueue() {

    // We actually don't clear the replication queue, we just mark as failed all
    // the queued replications - this will allow, during the queue item
    // processing to not do any actual processing for an item that contains the
    // failed replication, it will just go out the queue without doing anything
    // with it.
    $queued_items_deleted = FALSE;

    /** @var Replication[] $queued_replications */
    $queued_replications = $this->entityTypeManager
      ->getStorage('replication')
      ->loadByProperties([
      'replication_status' => Replication::QUEUED,
    ]);
    foreach ($queued_replications as $replication) {
      $replication
        ->setReplicationStatusFailed()
        ->setReplicationFailInfo($this
        ->t('This deployment has been marked as failed manually, when clearing the replication queue.'))
        ->save();
      $queued_items_deleted = TRUE;
    }
    return $queued_items_deleted;
  }

  /**
   * {@inheritdoc}
   */
  public function getDescription() {
    return $this
      ->t('All replications will be marked as failed and removed from the cron queue, except those that are in progress. This action cannot be undone.');
  }

  /**
   * {@inheritdoc}
   */
  public function getQuestion() {
    return $this
      ->t('Are you sure you want to clear the replication queue?');
  }

  /**
   * {@inheritdoc}
   */
  public function getCancelUrl() {
    return new Url('replication.settings_form');
  }

  /**
   * {@inheritdoc}
   */
  public function getConfirmText() {
    return $this
      ->t('Clear queue');
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ConfirmClearReplicationQueueForm::$entityTypeManager	protected	property	The entity type storage service.
ConfirmClearReplicationQueueForm::clearReplicationQueue	public	function	Clears the replication queue.
ConfirmClearReplicationQueueForm::create	public static	function	Instantiates a new instance of this class. Overrides FormBase::create
ConfirmClearReplicationQueueForm::getCancelUrl	public	function	Returns the route to go to if the user cancels the action. Overrides ConfirmFormInterface::getCancelUrl
ConfirmClearReplicationQueueForm::getConfirmText	public	function	Returns a caption for the button that confirms the action. Overrides ConfirmFormBase::getConfirmText
ConfirmClearReplicationQueueForm::getDescription	public	function	Returns additional text to display as a description. Overrides ConfirmFormBase::getDescription
ConfirmClearReplicationQueueForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
ConfirmClearReplicationQueueForm::getQuestion	public	function	Returns the question to ask the user. Overrides ConfirmFormInterface::getQuestion
ConfirmClearReplicationQueueForm::submitForm	public	function	Form submission handler. Overrides FormInterface::submitForm
ConfirmClearReplicationQueueForm::__construct	public	function
ConfirmFormBase::buildForm	public	function	Form constructor. Overrides FormInterface::buildForm	21
ConfirmFormBase::getCancelText	public	function	Returns a caption for the link which cancels the action. Overrides ConfirmFormInterface::getCancelText	1
ConfirmFormBase::getFormName	public	function	Returns the internal name used to refer to the confirmation item. Overrides ConfirmFormInterface::getFormName
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.
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.