You are here

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

class ManualPull in CMS Content Sync 8

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

Provides a listing of Flow.

Hierarchy

Expanded class hierarchy of ManualPull

File

src/Controller/ManualPull.php, line 16

Namespace

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

  /**
   * Ensure that the pull tab is just show if a flow exists which contains
   * and entity type that has its pull set to "manual".
   */
  public function access() {
    $flows = Flow::getAll();
    $manually_pulled_entity_types = [];
    foreach ($flows as $flow) {
      if (!empty($flow
        ->getEntityTypesToPull(PullIntent::PULL_MANUALLY))) {
        $manually_pulled_entity_types[$flow
          ->id()] = $flow
          ->getEntityTypesToPull(PullIntent::PULL_MANUALLY);
      }
    }
    return AccessResult::allowedIf(!empty($manually_pulled_entity_types))
      ->addCacheableDependency($flows);
  }

  /**
   * Render the content synchronization Angular frontend.
   *
   * @throws \Drupal\Component\Plugin\Exception\InvalidPluginDefinitionException
   * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
   * @throws \EdgeBox\SyncCore\Exception\SyncCoreException
   *
   * @return array
   */
  public function content() {
    $settings = ContentSyncSettings::getInstance();
    $config = [
      'siteUrl' => $settings
        ->getSiteBaseUrl(),
      'pools' => [],
      'flows' => [],
      'entity_types' => [],
    ];
    $pools = Pool::getAll();
    $cloud = _cms_content_sync_is_cloud_version() && $settings
      ->isDirectSyncCoreAccessEnabled();
    $sync_core_settings = null;
    $connection_id = null;
    foreach (Flow::getAll() as $id => $flow) {
      $config['flows'][$flow->id] = [
        'id' => $flow->id,
        'name' => $flow->name,
      ];
      foreach ($flow
        ->getEntityTypeConfig() as $definition) {
        if (!$flow
          ->canPullEntity($definition['entity_type_name'], $definition['bundle_name'], PullIntent::PULL_MANUALLY)) {
          continue;
        }
        foreach ($flow
          ->getEntityTypeConfig($definition['entity_type_name'], $definition['bundle_name'])['import_pools'] as $id => $option) {
          if (Pool::POOL_USAGE_ALLOW != $option) {
            continue;
          }
          $pool = $pools[$id];
          $config['pools'][$pool->id] = [
            'id' => $pool->id,
            'label' => $pool->label,
            'site_id' => DrupalApplication::get()
              ->getSiteMachineName(),
          ];
          if (!$sync_core_settings) {
            $sync_core_settings = $pool
              ->getClient()
              ->getSyndicationService()
              ->configurePullDashboard();
          }
        }
        $index = $definition['entity_type_name'] . '.' . $definition['bundle_name'];
        if (!isset($config['entity_types'][$index])) {

          // Get the entity type and bundle name.
          $entity_type_storage = \Drupal::entityTypeManager()
            ->getStorage($definition['entity_type_name']);
          $entity_type = $entity_type_storage
            ->getEntityType();
          $entity_type_label = $entity_type
            ->getLabel()
            ->render();
          $bundle_info = \Drupal::service('entity_type.bundle.info')
            ->getBundleInfo($definition['entity_type_name']);
          $bundle_label = $bundle_info[$definition['bundle_name']]['label'];
          $config['entity_types'][$index] = [
            'entity_type_name' => $definition['entity_type_name'],
            'entity_type_label' => $entity_type_label,
            'bundle_name' => $definition['bundle_name'],
            'bundle_label' => $bundle_label,
            'version' => $definition['version'],
            'pools' => [],
            'preview' => $definition['preview'] ?? Flow::PREVIEW_DISABLED,
          ];
        }
        else {
          if (Flow::PREVIEW_DISABLED == $config['entity_types'][$index]['preview'] || Flow::PREVIEW_TABLE != $definition['preview']) {
            $config['entity_types'][$index]['preview'] = $definition['preview'] ?? Flow::PREVIEW_DISABLED;
          }
        }
        foreach ($definition['import_pools'] as $id => $action) {
          if (!isset($config['entity_types'][$index]['pools'][$id]) || Pool::POOL_USAGE_FORCE == $action || Pool::POOL_USAGE_FORBID == $config['entity_types'][$index]['pools'][$id]) {
            $config['entity_types'][$index]['pools'][$id] = $action;
          }
        }
      }
    }

    // Provide additional conditions for "subscribe only to" filters.
    if ($cloud) {
      $entity_type_ids = [];

      /**
       * @var \Drupal\Core\Entity\EntityFieldManager $entityFieldManager
       */
      $entityFieldManager = \Drupal::service('entity_field.manager');
      foreach (Flow::getAll() as $flow) {
        foreach ($flow
          ->getEntityTypeConfig() as $definition) {
          if (!$flow
            ->canPullEntity($definition['entity_type_name'], $definition['bundle_name'], PullIntent::PULL_MANUALLY)) {
            continue;
          }
          foreach ($definition['import_pools'] as $pool_id => $behavior) {
            if (Pool::POOL_USAGE_ALLOW != $behavior) {
              continue;
            }
            if (isset($entity_type_ids[$pool_id][$definition['entity_type_name']][$definition['bundle_name']])) {
              continue;
            }
            if (EntityHandlerPluginManager::isEntityTypeFieldable($definition['entity_type_name'])) {

              /**
               * @var \Drupal\Core\Field\FieldDefinitionInterface[] $fields
               */
              $fields = $entityFieldManager
                ->getFieldDefinitions($definition['entity_type_name'], $definition['bundle_name']);
              foreach ($fields as $key => $field) {
                $field_config = $flow
                  ->getFieldHandlerConfig($definition['entity_type_name'], $definition['bundle_name'], $key);
                if (empty($field_config)) {
                  continue;
                }
                if (empty($field_config['handler_settings']['subscribe_only_to'])) {
                  continue;
                }
                $allowed = [];
                foreach ($field_config['handler_settings']['subscribe_only_to'] as $ref) {
                  $allowed[] = $ref['uuid'];
                }
                $sync_core_settings
                  ->ifTaggedWith($pool_id, $definition['entity_type_name'], $definition['bundle_name'], $key, $allowed);
              }
            }
            $entity_type_ids[$pool_id][$definition['entity_type_name']][$definition['bundle_name']] = true;
          }
        }
      }
    }
    $config = array_merge($config, $sync_core_settings
      ->getConfig());
    if (empty($config['entity_types'])) {
      \Drupal::messenger()
        ->addMessage(t('There are no entity types to be pulled manually.'));
    }
    return [
      '#theme' => 'cms_content_sync_content_dashboard',
      '#configuration' => $config,
      '#attached' => [
        'library' => [
          'cms_content_sync/pull',
        ],
      ],
    ];
  }

}

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::$entityManager protected property The entity manager.
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 40
ControllerBase::currentUser protected function Returns the current user. 1
ControllerBase::entityFormBuilder protected function Retrieves the entity form builder.
ControllerBase::entityManager Deprecated protected function Retrieves the entity manager service.
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. Overrides UrlGeneratorTrait::redirect
ControllerBase::state protected function Returns the state storage service.
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.
ManualPull::access public function Ensure that the pull tab is just show if a flow exists which contains and entity type that has its pull set to "manual".
ManualPull::content public function Render the content synchronization Angular frontend.
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.