class DeveloperSyncController in Apigee Edge 8

Controller for the developer synchronization-related pages.

Hierarchy

class \Drupal\Core\Controller\ControllerBase implements ContainerInjectionInterface uses LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
- class \Drupal\apigee_edge\Controller\DeveloperSyncController

Expanded class hierarchy of DeveloperSyncController

1 file declares its use of DeveloperSyncController

CliService.php in src/CliService.php

File

src/Controller/DeveloperSyncController.php, line 34

Namespace

Drupal\apigee_edge\Controller

View source

class DeveloperSyncController extends ControllerBase {

  /**
   * Job executor.
   *
   * @var \Drupal\apigee_edge\JobExecutor
   */
  protected $executor;

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

  /**
   * DeveloperSyncController constructor.
   *
   * @param \Drupal\apigee_edge\JobExecutorInterface $executor
   *   The job executor service.
   * @param \Drupal\Core\Messenger\MessengerInterface $messenger
   *   The messenger service.
   */
  public function __construct(JobExecutorInterface $executor, MessengerInterface $messenger) {
    $this->executor = $executor;
    $this->messenger = $messenger;
  }

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

  /**
   * Generates a job tag.
   *
   * @param string $type
   *   Tag type.
   *
   * @return string
   *   Job tag.
   */
  protected static function generateTag(string $type) : string {
    return "developer_sync_{$type}_" . user_password();
  }

  /**
   * Returns the developer sync filter.
   *
   * @return null|string
   *   Filter condition or null if not set.
   */
  protected static function getFilter() : ?string {
    return (string) \Drupal::config('apigee_edge.sync')
      ->get('filter') ?: NULL;
  }

  /**
   * Handler for 'apigee_edge.developer_sync.schedule'.
   *
   * Runs a developer sync in the background.
   *
   * @param \Symfony\Component\HttpFoundation\Request $request
   *   The HTTP request.
   *
   * @return \Symfony\Component\HttpFoundation\RedirectResponse
   *   HTTP response doing a redirect.
   */
  public function schedule(Request $request) : RedirectResponse {
    $destination = $request->query
      ->get('destination');
    $job = new DeveloperSync(static::getFilter());
    $job
      ->setTag($this
      ->generateTag('background'));
    apigee_edge_get_executor()
      ->cast($job);
    $this
      ->messenger()
      ->addStatus($this
      ->t('Developer synchronization is scheduled.'));
    return new RedirectResponse($destination);
  }

  /**
   * Handler for 'apigee_edge.developer_sync.run'.
   *
   * Starts the developer sync batch process.
   *
   * @param \Symfony\Component\HttpFoundation\Request $request
   *   The HTTP request.
   *
   * @return \Symfony\Component\HttpFoundation\RedirectResponse
   *   HTTP response doing a redirect.
   */
  public function run(Request $request) : RedirectResponse {
    $destination = $request->query
      ->get('destination');
    $batch = static::getBatch();
    batch_set($batch);
    return batch_process($destination);
  }

  /**
   * Gets the batch array.
   *
   * @return array
   *   The batch array.
   */
  public static function getBatch() : array {
    $tag = static::generateTag('batch');
    return [
      'title' => t('Synchronizing developers'),
      'operations' => [
        [
          [
            static::class,
            'batchGenerateJobs',
          ],
          [
            $tag,
          ],
        ],
        [
          [
            static::class,
            'batchExecuteJobs',
          ],
          [
            $tag,
          ],
        ],
      ],
      'finished' => [
        static::class,
        'batchFinished',
      ],
    ];
  }

  /**
   * The first batch operation.
   *
   * This generates the developer-user sync jobs for the second operation.
   *
   * @param string $tag
   *   Job tag.
   * @param array $context
   *   Batch context.
   */
  public static function batchGenerateJobs(string $tag, array &$context) {
    $job = new DeveloperSync(static::getFilter());
    $job
      ->setTag($tag);
    apigee_edge_get_executor()
      ->call($job);
    $context['message'] = (string) $job;
    $context['finished'] = 1.0;
  }

  /**
   * The second batch operation.
   *
   * @param string $tag
   *   Job tag.
   * @param array $context
   *   Batch context.
   */
  public static function batchExecuteJobs(string $tag, array &$context) {
    if (!isset($context['sandbox'])) {
      $context['sandbox'] = [];
    }
    $executor = apigee_edge_get_executor();
    $job = $executor
      ->select($tag);
    if ($job === NULL) {
      $context['finished'] = 1.0;
      return;
    }
    $executor
      ->call($job);
    $context['message'] = (string) $job;
    $context['finished'] = $executor
      ->countJobs($tag, [
      Job::FAILED,
      Job::FINISHED,
    ]) / $executor
      ->countJobs($tag);
  }

  /**
   * Batch finish callback.
   */
  public static function batchFinished() {
    \Drupal::messenger()
      ->addStatus(t('Apigee Edge developers are in sync with Drupal users.'));
  }

}

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::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.
DeveloperSyncController::$executor	protected	property	Job executor.
DeveloperSyncController::$messenger	protected	property	The messenger service. Overrides MessengerTrait::$messenger
DeveloperSyncController::batchExecuteJobs	public static	function	The second batch operation.
DeveloperSyncController::batchFinished	public static	function	Batch finish callback.
DeveloperSyncController::batchGenerateJobs	public static	function	The first batch operation.
DeveloperSyncController::create	public static	function	Instantiates a new instance of this class. Overrides ControllerBase::create
DeveloperSyncController::generateTag	protected static	function	Generates a job tag.
DeveloperSyncController::getBatch	public static	function	Gets the batch array.
DeveloperSyncController::getFilter	protected static	function	Returns the developer sync filter.
DeveloperSyncController::run	public	function	Handler for 'apigee_edge.developer_sync.run'.
DeveloperSyncController::schedule	public	function	Handler for 'apigee_edge.developer_sync.schedule'.
DeveloperSyncController::__construct	public	function	DeveloperSyncController constructor.
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.
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.

You are here

class DeveloperSyncController in Apigee Edge 8

Hierarchy

File

Namespace

Members

API Navigation