class PoolExport in CMS Content Sync 8

Push changes controller.

Hierarchy

• class \Drupal\Core\Controller\ControllerBase implements ContainerInjectionInterface uses LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
  • class \Drupal\cms_content_sync\Controller\PoolExport

1 file declares its use of PoolExport

CliService.php in src/Cli/CliService.php

File

src/Controller/PoolExport.php, line 16

Namespace

Drupal\cms_content_sync\Controller

class PoolExport extends ControllerBase {

  /**
   * Export pool.
   *
   * @param string $cms_content_sync_pool
   *                                      The id of the pool
   *
   * @throws \Drupal\Component\Plugin\Exception\InvalidPluginDefinitionException
   * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
   * @throws \EdgeBox\SyncCore\Exception\SyncCoreException
   * @throws \Exception
   *
   * @return null|\Symfony\Component\HttpFoundation\RedirectResponse
   */
  public function export(string $cms_content_sync_pool, Request $request) : RedirectResponse {

    /**
     * @var \Drupal\cms_content_sync\Entity\Pool $pool
     */
    $pool = \Drupal::entityTypeManager()
      ->getStorage('cms_content_sync_pool')
      ->load($cms_content_sync_pool);
    $messenger = \Drupal::messenger();
    if (!PoolExport::validateBaseUrl($pool)) {
      return new RedirectResponse(Url::fromRoute('entity.cms_content_sync_pool.collection')
        ->toString());
    }
    $exporter = new SyncCorePoolExport($pool);
    $sites = $exporter
      ->verifySiteId();
    if ('false' === $request->query
      ->get('force', 'false') && $sites && count($sites)) {
      $url = Url::fromRoute('entity.cms_content_sync_pool.export', [
        'cms_content_sync_pool' => $pool
          ->id(),
      ], [
        'query' => [
          'force' => 'true',
        ],
      ])
        ->toString();
      $messenger
        ->addMessage($this
        ->t('This site id is not unique, site with id %id is already registered with base url %base_url. If you changed the site URL and want to force the export, <a href="@url">click here</a>.', [
        '@url' => Markup::create($url),
        '%id' => array_keys($sites)[0],
        '%base_url' => array_values($sites)[0],
      ]), $messenger::TYPE_ERROR);
      return new RedirectResponse(Url::fromRoute('entity.cms_content_sync_pool.collection')
        ->toString());
    }
    $batch = $exporter
      ->prepareBatch(false, !empty($_GET['force']) && 'true' === $_GET['force']);
    $operations = [];
    for ($i = 0; $i < $batch
      ->count(); ++$i) {
      $operations[] = [
        [
          $batch
            ->get($i),
          'execute',
        ],
        [],
      ];
    }
    $batch = [
      'title' => t('Export configuration'),
      'operations' => $operations,
      'finished' => '\\Drupal\\cms_content_sync\\Controller\\PoolExport::batchFinished',
    ];
    batch_set($batch);
    return batch_process(Url::fromRoute('entity.cms_content_sync_pool.collection'));
  }

  /**
   * Ensure that the sites base url does not contain localhost or an IP.
   *
   * @param object $pool
   *                     The pool object
   *
   * @throws \Exception
   *
   * @return bool
   *              Returns true or false
   */
  public static function validateBaseUrl($pool) : bool {
    $messenger = \Drupal::messenger();
    $settings = ContentSyncSettings::getInstance();
    $baseUrl = $settings
      ->getSiteBaseUrl(true);
    if (false !== strpos($pool->backend_url, 'cms-content-sync.io')) {
      if (false !== strpos($baseUrl, 'localhost') || !UrlHelper::isValid($baseUrl, true) || '/' === mb_substr($baseUrl, -1) || preg_match('@https?://[0-9]+\\.[0-9]+\\.[0-9]+\\.[0-9]+(/|$)@', $baseUrl)) {
        $messenger
          ->addMessage(t('The site does not have a valid base url. The base url must not contain "localhost", does not contain a trailing slash and is not allowed to be an IP address. The base url of the site can be configured <a href="@url">here.</a>', [
          '@url' => Url::fromRoute('cms_content_sync.settings_form')
            ->toString(),
        ]), $messenger::TYPE_ERROR);
        return false;
      }
    }
    return true;
  }

  /**
   * Batch export finished callback.
   *
   * @param $success
   * @param $results
   * @param $operations
   */
  public static function batchFinished($success, $results, $operations) {
    if ($success) {
      $message = t('Pool has been exported.');
    }
    else {
      $message = t('Pool export failed.');
    }
    \Drupal::messenger()
      ->addMessage($message);
  }

}

Members

Name	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.
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
PoolExport::batchFinished	public static	function	Batch export finished callback.
PoolExport::export	public	function	Export pool.
PoolExport::validateBaseUrl	public static	function	Ensure that the sites base url does not contain localhost or an IP.
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.