You are here

GetAlertsInterface.php in Site Alert 8

Namespace

Drupal\site_alert

File

src/GetAlertsInterface.php
View source
<?php

namespace Drupal\site_alert;


/**
 * Interface for services that retrieve site alerts.
 */
interface GetAlertsInterface {

  /**
   * Returns the entity IDs of the currently active site alerts.
   *
   * @return array
   *   Array of currently active site alert entity IDs.
   */
  public function getActiveAlertIds();

  /**
   * Returns the currently active site alerts.
   *
   * @return \Drupal\site_alert\Entity\SiteAlert[]
   *   Array of currently active site alert entities.
   */
  public function getActiveAlerts();

}

Interfaces

Namesort descending Description
GetAlertsInterface Interface for services that retrieve site alerts.