interface SubscriptionStorageInterface in Simplenews 3.x

Subscription storage.

Hierarchy

• interface \Drupal\simplenews\Subscription\SubscriptionStorageInterface

File

src/Subscription/SubscriptionStorageInterface.php, line 8

Namespace

Drupal\simplenews\Subscription

interface SubscriptionStorageInterface {

  /**
   * Deletes subscriptions.
   *
   * @param array $conditions
   *   An associative array of conditions matching the records to be delete.
   *   Example: array('newsletter_id' => 5, 'snid' => 12)
   *   Delete the subscription of subscriber 12 to newsletter newsletter_id 5.
   *
   * @ingroup subscription
   */
  public function deleteSubscriptions(array $conditions = []);

  /**
   * Returns a list of active subscriptions for a given newsletter.
   *
   * WARNING: Use with caution - this might return a huge list.
   *
   * @param string $newsletter_id
   *   The newsletter id.
   *
   * @return array
   *   An array keyed by the mail address, containing another array with the
   *   keys mail, uid, language, snid and status.
   *
   * @ingroup subscription
   */
  public function getSubscriptionsByNewsletter($newsletter_id);

}

Members

Name	Modifiers	Type	Description	Overrides
SubscriptionStorageInterface::deleteSubscriptions	public	function	Deletes subscriptions.	1
SubscriptionStorageInterface::getSubscriptionsByNewsletter	public	function	Returns a list of active subscriptions for a given newsletter.	1