You are here

interface SiteAlertStorageInterface in Site Alert 8

Interface for SiteAlert entity storage handlers.

Hierarchy

Expanded class hierarchy of SiteAlertStorageInterface

All classes that implement SiteAlertStorageInterface

File

src/SiteAlertStorageInterface.php, line 8

Namespace

Drupal\site_alert
View source
interface SiteAlertStorageInterface {

  /**
   * Defines the value of the 'active' column for active alerts.
   */
  public const ACTIVE = 1;

  /**
   * Defines the value of the 'active' column for inactive alerts.
   */
  public const INACTIVE = 0;

  /**
   * Returns the max age for elements that display site alerts.
   *
   * @return int
   *   The time in seconds until the next alert is scheduled to appear or
   *   disappear, or -1 if there are no scheduled alerts.
   */
  public function getCacheMaxAge();

}

Members

Namesort descending Modifiers Type Description Overrides
SiteAlertStorageInterface::ACTIVE public constant Defines the value of the 'active' column for active alerts.
SiteAlertStorageInterface::getCacheMaxAge public function Returns the max age for elements that display site alerts. 1
SiteAlertStorageInterface::INACTIVE public constant Defines the value of the 'active' column for inactive alerts.