You are here

Home » API reference » CMS Content Sync 8 » PushChangesConfirm.php

class PushChangesConfirm in CMS Content Sync 8

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

Provides a node deletion confirmation form.

@internal

Hierarchy

Expanded class hierarchy of PushChangesConfirm

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

File

src/Form/PushChangesConfirm.php, line 20

Namespace

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

  /**
   * The tempstore factory.
   *
   * @var \Drupal\Core\TempStore\PrivateTempStoreFactory
   */
  protected $tempStoreFactory;

  /**
   * The node storage.
   *
   * @var \Drupal\Core\Entity\EntityStorageInterface
   */
  protected $storage;

  /**
   * The nodes to push.
   *
   * @var array
   */
  protected $nodes;

  /**
   * Constructs a DeleteMultiple form object.
   *
   * @param \Drupal\Core\TempStore\PrivateTempStoreFactory $temp_store_factory
   *                                                                           The tempstore factory
   * @param \Drupal\Core\Entity\EntityTypeManager          $manager
   *                                                                           The entity manager
   *
   * @throws \Drupal\Component\Plugin\Exception\InvalidPluginDefinitionException
   * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
   */
  public function __construct(PrivateTempStoreFactory $temp_store_factory, EntityTypeManager $manager) {
    $this->tempStoreFactory = $temp_store_factory;
    $this->storage = $manager
      ->getStorage('node');
    $this->nodes = $this->tempStoreFactory
      ->get('node_cms_content_sync_push_changes_confirm')
      ->get('nodes');
  }

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

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

  /**
   * {@inheritdoc}
   */
  public function getQuestion() {
    return 'Are you sure you want to push this content? Depending on the amount and complexity of it, this action may take a while.';
  }

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

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    if (empty($this->nodes)) {
      return new RedirectResponse($this
        ->getCancelUrl()
        ->setAbsolute()
        ->toString());
    }
    $items = [];
    foreach ($this->nodes as $node) {
      $items[$node
        ->id()] = $node
        ->label();
    }
    $form['nodes'] = [
      '#theme' => 'item_list',
      '#items' => $items,
    ];
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    if ($form_state
      ->getValue('confirm')) {
      $ignored = 0;

      /** @var \Drupal\node\NodeInterface[] $nodes */
      foreach ($this->nodes as $node) {
        if (!PushIntent::pushEntityFromUi($node, PushIntent::PUSH_MANUALLY, SyncIntent::ACTION_UPDATE)) {
          ++$ignored;
        }
      }

      // @todo Improve "ignore" messages (see individual "Push" operation)
      \Drupal::messenger()
        ->addMessage(t('Pushed @count content items.', [
        '@count' => count($this->nodes) - $ignored,
      ]));
      if ($ignored) {
        \Drupal::messenger()
          ->addWarning(t('@count content items have been ignored as they\'re not configured to be pushed.', [
          '@count' => $ignored,
        ]));
      }
      $this
        ->logger('cms_content_sync')
        ->notice('Pushed @count content, ignored @ignored.', [
        '@count' => count($this->nodes) - $ignored,
        '@ignored' => $ignored,
      ]);
      $this->tempStoreFactory
        ->get('node_cms_content_sync_push_changes_confirm')
        ->delete('nodes');
    }
    $form_state
      ->setRedirect('system.admin_content');
  }

}

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::getDescription public function Returns additional text to display as a description. Overrides ConfirmFormInterface::getDescription 11
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.
PushChangesConfirm::$nodes protected property The nodes to push.
PushChangesConfirm::$storage protected property The node storage.
PushChangesConfirm::$tempStoreFactory protected property The tempstore factory.
PushChangesConfirm::buildForm public function Form constructor. Overrides ConfirmFormBase::buildForm
PushChangesConfirm::create public static function Instantiates a new instance of this class. Overrides FormBase::create
PushChangesConfirm::getCancelUrl public function Returns the route to go to if the user cancels the action. Overrides ConfirmFormInterface::getCancelUrl
PushChangesConfirm::getConfirmText public function Returns a caption for the button that confirms the action. Overrides ConfirmFormBase::getConfirmText
PushChangesConfirm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
PushChangesConfirm::getQuestion public function Returns the question to ask the user. Overrides ConfirmFormInterface::getQuestion
PushChangesConfirm::submitForm public function Form submission handler. Overrides FormInterface::submitForm
PushChangesConfirm::__construct public function Constructs a DeleteMultiple form object.
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.