eventbrite_one_way_sync-1.0.0/src/Database/DatabaseInterface.php

<?php

namespace Drupal\eventbrite_one_way_sync\Database;

use Drupal\eventbrite_one_way_sync\EventbriteEvent\EventbriteEventInterface;

/**
 * Represents this module's database.
 */
interface DatabaseInterface {

  /**
   * Create or update a record in the queue for a remote event.
   *
   * @param string $remote_id
   *   A remote ID such as default:series:123 or default:event:123.
   * @param string $occurrence_id
   *   An occurrence ID such as default:event:123.
   * @param array $struct
   *   The struct.
   */
  public function update(string $remote_id, string $occurrence_id, array $struct);

  /**
   * Get All information for a remote ID.
   *
   * @param string $remote_id
   *   A remote ID such as default:series:123.
   *
   * @return array
   *   All information for a remote id.
   */
  public function getRemoteId(string $remote_id) : array;

  /**
   * Remove a record in the queue for a remote event.
   *
   * @param string $remote_id
   *   A remote ID such as default:series:123 or default:event:123.
   */
  public function remove(string $remote_id);

  /**
   * Get the next event in the queue to process.
   *
   * @return \Drupal\eventbrite_one_way_sync\EventbriteEvent\EventbriteEventInterface
   *   An event to process.
   */
  public function nextEvent() : EventbriteEventInterface;

  /**
   * Count the items in the queue.
   *
   * @return int
   *   The items in the queue.
   */
  public function countQueue() : int;

}