You are here

interface EntityShareCronServiceInterface in Entity Share Cron 8

Same name and namespace in other branches
  1. 8.2 src/EntityShareCronServiceInterface.php \Drupal\entity_share_cron\EntityShareCronServiceInterface
  2. 3.0.x src/EntityShareCronServiceInterface.php \Drupal\entity_share_cron\EntityShareCronServiceInterface

Entity Share Cron service.

Hierarchy

Expanded class hierarchy of EntityShareCronServiceInterface

All classes that implement EntityShareCronServiceInterface

3 files declare their use of EntityShareCronServiceInterface
EntityShareCronServiceTest.php in tests/src/Unit/EntityShareCronServiceTest.php
entity_share_cron.install in ./entity_share_cron.install
Install, update and uninstall functions for the Entity share cron module.
HookCronTest.php in tests/src/Kernel/HookCronTest.php

File

src/EntityShareCronServiceInterface.php, line 8

Namespace

Drupal\entity_share_cron
View source
interface EntityShareCronServiceInterface {
  const PENDING_QUEUE_NAME = 'entity_share_cron_pending';

  /**
   * Enqueues a channel for later synchronization.
   *
   * @param string $remote_id
   *   The ID of the remote the channel belongs to.
   * @param string $channel_id
   *   The ID of the channel to be enqueued.
   * @param array $channel_info
   *   Channel info.
   */
  public function enqueue($remote_id, $channel_id, array $channel_info);

  /**
   * Synchronizes entities starting from provided channel URL.
   *
   * @param string $remote_id
   *   The ID of the remote the channel belongs to.
   * @param string $channel_id
   *   The ID of the channel to be synchronized.
   * @param array $channel_info
   *   Channel info.
   * @param int $page_limit
   *   The maximum number of pages to process. The remaining will be enqueued.
   */
  public function sync($remote_id, $channel_id, array $channel_info, $page_limit = 0);

}

Members

Namesort descending Modifiers Type Description Overrides
EntityShareCronServiceInterface::enqueue public function Enqueues a channel for later synchronization. 1
EntityShareCronServiceInterface::PENDING_QUEUE_NAME constant
EntityShareCronServiceInterface::sync public function Synchronizes entities starting from provided channel URL. 1