You are here

class ResetStatusEntityConfirmation in CMS Content Sync 8

Same name and namespace in other branches
  1. 2.1.x src/Form/ResetStatusEntityConfirmation.php \Drupal\cms_content_sync\Form\ResetStatusEntityConfirmation
  2. 2.0.x src/Form/ResetStatusEntityConfirmation.php \Drupal\cms_content_sync\Form\ResetStatusEntityConfirmation

Provides the confirmation form for the pool reset entity status action.

@internal

Hierarchy

Expanded class hierarchy of ResetStatusEntityConfirmation

1 string reference to 'ResetStatusEntityConfirmation'
cms_content_sync.routing.yml in ./cms_content_sync.routing.yml
cms_content_sync.routing.yml

File

src/Form/ResetStatusEntityConfirmation.php, line 18

Namespace

Drupal\cms_content_sync\Form
View source
class ResetStatusEntityConfirmation extends ConfirmFormBase {

  /**
   * The pool the status entities should be reset for.
   *
   * @var string
   */
  protected $cms_content_sync_pool;

  /**
   * The pool storage.
   */
  protected $pool_storage;

  /**
   * The current pool.
   */
  protected $pool;

  /**
   * The Messenger service.
   *
   * @var \Drupal\Core\Messenger\Messenger
   */
  protected $messenger;

  /**
   * Constructs a DeleteMultiple form object.
   */
  public function __construct(EntityTypeManager $manager, Messenger $messenger) {
    $this->pool_storage = $manager
      ->getStorage('cms_content_sync_pool');
    $this->messenger = $messenger;
  }

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state, $cms_content_sync_pool = null) {
    $this->cms_content_sync_pool = $cms_content_sync_pool;
    $this->pool = $this->pool_storage
      ->load($this->cms_content_sync_pool);
    return parent::buildForm($form, $form_state);
  }

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

  /**
   * {@inheritdoc}
   */
  public function getQuestion() {
    return 'Are you sure you want to reset the status entities for the Pool: "' . $this->pool
      ->label() . '"?';
  }

  /**
   * {@inheritdoc}
   */
  public function getDescription() {
    return $this
      ->t('By resetting the status of all entities, the date of the last pull
    and the date of the last push will be reset. The dates will no longer be displayed until
    the content is pulled or pushed again and all entities will be pushed / pulled again at
    the next synchronization regardless of whether they have changed or not.');
  }

  /**
   * {@inheritdoc}
   */
  public function getCancelUrl() {
    return new Url('entity.cms_content_sync_pool.collection');
  }

  /**
   * {@inheritdoc}
   */
  public function getConfirmText() {
    return t('Confirm');
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    Pool::resetStatusEntities($this->pool
      ->id());
    $this->messenger
      ->addMessage($this
      ->t('The status entities for the Pool @pool have been reset successfully.', [
      '@pool' => $this->pool
        ->label(),
    ]));
    $form_state
      ->setRedirect('entity.cms_content_sync_pool.collection');
  }

}

Members

Namesort descending Modifiers Type Description Overrides
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 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.
ResetStatusEntityConfirmation::$cms_content_sync_pool protected property The pool the status entities should be reset for.
ResetStatusEntityConfirmation::$messenger protected property The Messenger service. Overrides MessengerTrait::$messenger
ResetStatusEntityConfirmation::$pool protected property The current pool.
ResetStatusEntityConfirmation::$pool_storage protected property The pool storage.
ResetStatusEntityConfirmation::buildForm public function Form constructor. Overrides ConfirmFormBase::buildForm
ResetStatusEntityConfirmation::create public static function Instantiates a new instance of this class. Overrides FormBase::create
ResetStatusEntityConfirmation::getCancelUrl public function Returns the route to go to if the user cancels the action. Overrides ConfirmFormInterface::getCancelUrl
ResetStatusEntityConfirmation::getConfirmText public function Returns a caption for the button that confirms the action. Overrides ConfirmFormBase::getConfirmText
ResetStatusEntityConfirmation::getDescription public function Returns additional text to display as a description. Overrides ConfirmFormBase::getDescription
ResetStatusEntityConfirmation::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
ResetStatusEntityConfirmation::getQuestion public function Returns the question to ask the user. Overrides ConfirmFormInterface::getQuestion
ResetStatusEntityConfirmation::submitForm public function Form submission handler. Overrides FormInterface::submitForm
ResetStatusEntityConfirmation::__construct public function Constructs a DeleteMultiple form 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.