You are here

interface EntityShareCronServiceInterface in Entity Share Cron 3.0.x

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

Entity Share Cron service.

Hierarchy

Expanded class hierarchy of EntityShareCronServiceInterface

All classes that implement EntityShareCronServiceInterface

4 files declare their use of EntityShareCronServiceInterface
CronHookHandler.php in src/HookHandler/CronHookHandler.php
EntityShareCronFunctionalTest.php in tests/src/Functional/EntityShareCronFunctionalTest.php
EntityShareCronPending.php in src/Plugin/QueueWorker/EntityShareCronPending.php
entity_share_cron.install in ./entity_share_cron.install

File

src/EntityShareCronServiceInterface.php, line 10

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 null|string $url
   *   The url of the page to enqueue for import. NULL if starting from the
   *   first page.
   */
  public function enqueue($remote_id, $channel_id, $url);

  /**
   * Synchronizes entities starting from provided channel.
   *
   * @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 null|string $url
   *   The url of the page to enqueue for import. NULL if starting from the
   *   first page.
   */
  public function sync($remote_id, $channel_id, $url);

}

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. 1