bat-8.x-1.x-dev/modules/bat_roomify/src/Store/StoreInterface.php

<?php

/**
 * @file
 * Interface StoreInterface
 */

namespace Drupal\bat_roomify\Store;

use Drupal\bat_roomify\Event\EventInterface;

/**
 * A store is a place where event data is held. The purpose of separating these
 * classes is so as to isolate (currently) Drupal-specific code and to allow for
 * other stores to be introduced.
 */
interface StoreInterface {

  /**
   * Given a data range returns events keyed by unit_id.
   *
   * @param \DateTime $start_date
   * @param \DateTime $end_date
   * @param $unit_ids
   *
   * @return array
   */
  public function getEventData(\DateTime $start_date, \DateTime $end_date, $unit_ids);

  /**
   * Given an event it will save it and return true if successful.
   *
   * @param \Drupal\bat_roomify\Event\EventInterface $event
   * @param $granularity
   *
   * @return boolean
   */
  public function storeEvent(EventInterface $event, $granularity);

}