You are here

class PushChanges in CMS Content Sync 2.0.x

Same name in this branch
  1. 2.0.x src/Controller/PushChanges.php \Drupal\cms_content_sync\Controller\PushChanges
  2. 2.0.x src/Plugin/Action/PushChanges.php \Drupal\cms_content_sync\Plugin\Action\PushChanges
Same name and namespace in other branches
  1. 8 src/Controller/PushChanges.php \Drupal\cms_content_sync\Controller\PushChanges
  2. 2.1.x src/Controller/PushChanges.php \Drupal\cms_content_sync\Controller\PushChanges

Push changes controller.

Hierarchy

Expanded class hierarchy of PushChanges

1 file declares its use of PushChanges
cms_content_sync.module in ./cms_content_sync.module
Module file for cms_content_sync.

File

src/Controller/PushChanges.php, line 16

Namespace

Drupal\cms_content_sync\Controller
View source
class PushChanges extends ControllerBase {

  /**
   * Published entity to Sync Core.
   *
   * @param string                              $flow_id
   * @param \Drupal\Core\Entity\EntityInterface $entity
   * @param string                              $entity_type
   *
   * @throws \Exception
   *
   * @return \Symfony\Component\HttpFoundation\RedirectResponse
   */
  public static function pushChanges($flow_id, $entity, $entity_type = '') {
    if (!$entity instanceof EntityInterface) {
      if ('' == $entity_type) {
        throw new \Exception(t('If no entity object is given, the entity_type is required.'));
      }
      $entity = \Drupal::entityTypeManager()
        ->getStorage($entity_type)
        ->load($entity);
      if (!$entity instanceof EntityInterface) {
        throw new \Exception(t('Entity could not be loaded.'));
      }
    }
    $flow = Flow::load($flow_id);
    if (!PushIntent::pushEntityFromUi($entity, PushIntent::PUSH_FORCED, SyncIntent::ACTION_UPDATE, $flow)) {
      $messenger = \Drupal::messenger();
      $messenger
        ->addWarning(t('%label has not been pushed to your @repository: @reason', [
        '%label' => $entity
          ->label(),
        '@repository' => _cms_content_sync_get_repository_name(),
        '@reason' => PushIntent::getNoPushReason($entity, true),
      ]));
    }
    return new RedirectResponse('/');
  }

  /**
   * Returns an read_list entities for Sync Core.
   *
   * @todo Should be removed when read_list will be allowed to omit.
   */
  public function pushChangesEntitiesList() {
    return new Response('[]');
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ControllerBase::$configFactory protected property The configuration factory.
ControllerBase::$currentUser protected property The current user service. 1
ControllerBase::$entityFormBuilder protected property The entity form builder.
ControllerBase::$entityTypeManager protected property The entity type manager.
ControllerBase::$formBuilder protected property The form builder. 2
ControllerBase::$keyValue protected property The key-value storage. 1
ControllerBase::$languageManager protected property The language manager. 1
ControllerBase::$moduleHandler protected property The module handler. 2
ControllerBase::$stateService protected property The state service.
ControllerBase::cache protected function Returns the requested cache bin.
ControllerBase::config protected function Retrieves a configuration object.
ControllerBase::container private function Returns the service container.
ControllerBase::create public static function Instantiates a new instance of this class. Overrides ContainerInjectionInterface::create 46
ControllerBase::currentUser protected function Returns the current user. 1
ControllerBase::entityFormBuilder protected function Retrieves the entity form builder.
ControllerBase::entityTypeManager protected function Retrieves the entity type manager.
ControllerBase::formBuilder protected function Returns the form builder service. 2
ControllerBase::keyValue protected function Returns a key/value storage collection. 1
ControllerBase::languageManager protected function Returns the language manager service. 1
ControllerBase::moduleHandler protected function Returns the module handler. 2
ControllerBase::redirect protected function Returns a redirect response object for the specified route.
ControllerBase::state protected function Returns the state storage 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. 27
MessengerTrait::messenger public function Gets the messenger. 27
MessengerTrait::setMessenger public function Sets the messenger.
PushChanges::pushChanges public static function Published entity to Sync Core.
PushChanges::pushChangesEntitiesList public function Returns an read_list entities for Sync Core.
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. 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.