interface GetAlertsInterface in Site Alert 8

Interface for services that retrieve site alerts.

Hierarchy

• interface \Drupal\site_alert\GetAlertsInterface

3 files declare their use of GetAlertsInterface

ActiveSiteAlertsCacheContext.php in src/Cache/Context/ActiveSiteAlertsCacheContext.php

SiteAlertBlock.php in src/Plugin/Block/SiteAlertBlock.php

SiteAlertController.php in src/Controller/SiteAlertController.php

File

src/GetAlertsInterface.php, line 8

Namespace

Drupal\site_alert

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();

}

Members

Name	Modifiers	Type	Description	Overrides
GetAlertsInterface::getActiveAlertIds	public	function	Returns the entity IDs of the currently active site alerts.	1
GetAlertsInterface::getActiveAlerts	public	function	Returns the currently active site alerts.	1