You are here

interface BynderServiceInterface in Bynder 8.2

Same name and namespace in other branches
  1. 8.3 src/BynderServiceInterface.php \Drupal\bynder\BynderServiceInterface
  2. 4.0.x src/BynderServiceInterface.php \Drupal\bynder\BynderServiceInterface

Provides methods to manage the Bynder module.

Hierarchy

Expanded class hierarchy of BynderServiceInterface

All classes that implement BynderServiceInterface

File

src/BynderServiceInterface.php, line 8

Namespace

Drupal\bynder
View source
interface BynderServiceInterface {

  /**
   * Updates the cron metadata information of the local media entities.
   *
   * Limits the number of processed items to BynderService::MAX_ITEMS.
   */
  public function updateLocalMetadataCron();

  /**
   * Returns the Bynder media types.
   *
   * @return \Drupal\media\MediaTypeInterface[]
   *   A list of Bynder media types.
   */
  public function getBynderMediaTypes();

  /**
   * Returns the total number of Bynder media entities.
   *
   * @return int
   *   A total number of Bynder media entities.
   */
  public function getTotalCountOfMediaEntities();

  /**
   * Updates metadata of the next N media entities starting at the minimum ID.
   *
   * @param string|null $minimum_id
   *   (optional) The minimum media entity ID to query items for.
   * @param int $limit
   *   (optional) The number of items to update per run.
   *
   * @return array
   *   Empty array if updates are not possible. Otherwise, array with the keys:
   *     - updated (a list of updated media entities keyed by the media ID)
   *     - skipped (a list of skipped media entities keyed by the media ID)
   *     - total (the total count of processed media entities)
   *     - max_id (the maximum media entity ID that was last processed)
   */
  public function updateMetadataLastMediaEntities($minimum_id = NULL, $limit = BynderService::MAX_ITEMS);

}

Members

Namesort descending Modifiers Type Description Overrides
BynderServiceInterface::getBynderMediaTypes public function Returns the Bynder media types. 1
BynderServiceInterface::getTotalCountOfMediaEntities public function Returns the total number of Bynder media entities. 1
BynderServiceInterface::updateLocalMetadataCron public function Updates the cron metadata information of the local media entities. 1
BynderServiceInterface::updateMetadataLastMediaEntities public function Updates metadata of the next N media entities starting at the minimum ID. 1