class SitewideAlertManager in Sitewide Alert 8

Hierarchy

• class \Drupal\sitewide_alert\SitewideAlertManager

1 file declares its use of SitewideAlertManager

SitewideAlertsController.php in src/Controller/SitewideAlertsController.php

1 string reference to 'SitewideAlertManager'

sitewide_alert.services.yml in ./sitewide_alert.services.yml

sitewide_alert.services.yml

1 service uses SitewideAlertManager

sitewide_alert.sitewide_alert_manager in ./sitewide_alert.services.yml

Drupal\sitewide_alert\SitewideAlertManager

File

src/SitewideAlertManager.php, line 11

Namespace

Drupal\sitewide_alert

class SitewideAlertManager {

  /**
   * The entity type manager.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;

  /**
   * The time service.
   *
   * @var \Drupal\Component\Datetime\TimeInterface
   */
  protected $time;

  /**
   * Time of current request.
   *
   * @var \DateTimeInterface
   */
  private $requestDateTime;

  /**
   * Constructor.
   *
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entityTypeManager
   *   The entity type manager.
   * @param \Drupal\Component\Datetime\TimeInterface $time
   *   The time service.
   */
  public function __construct(EntityTypeManagerInterface $entityTypeManager, TimeInterface $time) {
    $this->entityTypeManager = $entityTypeManager;
    $this->time = $time;
  }

  /**
   * Returns all active sitewide alerts.
   *
   * @return \Drupal\sitewide_alert\Entity\SitewideAlertInterface[]
   *   Array of active sitewide alerts indexed by their ids.
   *
   * @throws \Drupal\Component\Plugin\Exception\InvalidPluginDefinitionException
   * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
   */
  public function activeSitewideAlerts() {

    /** @var \Drupal\sitewide_alert\Entity\SitewideAlertInterface[] $sitewideAlerts */
    $sitewideAlerts = $this->entityTypeManager
      ->getStorage('sitewide_alert')
      ->loadByProperties([
      'status' => 1,
    ]);
    return $sitewideAlerts;
  }

  /**
   * Returns all active and currently visible sitewide alerts.
   *
   * @return \Drupal\sitewide_alert\Entity\SitewideAlertInterface[]
   *   Array of active sitewide alerts indexed by their ids.
   *
   * @throws \Drupal\Component\Plugin\Exception\InvalidPluginDefinitionException
   * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
   */
  public function activeVisibleSitewideAlerts() {

    /** @var \Drupal\sitewide_alert\Entity\SitewideAlertInterface[] $activeVisibleSitewideAlerts */
    $activeVisibleSitewideAlerts = $this
      ->activeSitewideAlerts();

    // Remove any sitewide alerts that are scheduled and it is not time to show them.
    foreach ($activeVisibleSitewideAlerts as $id => $sitewideAlert) {
      if ($sitewideAlert
        ->isScheduled() && !$sitewideAlert
        ->isScheduledToShowAt($this
        ->requestDateTime())) {
        unset($activeVisibleSitewideAlerts[$id]);
      }
    }
    return $activeVisibleSitewideAlerts;
  }

  /**
   * The time of the next scheduled change of alerts.
   *
   * @return \Drupal\Core\Datetime\DrupalDateTime|null
   *   Time of next scheduled change of alerts; null if nothing is scheduled to change.
   */
  public function nextScheduledChange() {
    $nextExpiring = $this
      ->soonestExpiringVisibleScheduledAlertDateTime();
    $nextShowing = $this
      ->soonestAppearingScheduledAlertDateTime();
    if ($nextExpiring && $nextShowing) {
      return $nextShowing > $nextExpiring ? $nextExpiring : $nextShowing;
    }
    if ($nextShowing) {
      return $nextShowing;
    }
    if ($nextExpiring) {
      return $nextExpiring;
    }
    return NULL;
  }

  /**
   * Determines the datetime of the soonest expiring visible scheduled alert.
   *
   * @return \Drupal\Core\Datetime\DrupalDateTime|null
   *   The datetime of the soonest expiring scheduled alert; null if none of the alerts are scheduled to expire.
   */
  private function soonestExpiringVisibleScheduledAlertDateTime() {

    /** @var DrupalDateTime|null $soonestScheduledEndDate */
    $soonestScheduledEndDate = NULL;
    foreach ($this
      ->activeVisibleSitewideAlerts() as $sitewideAlert) {
      if (!$sitewideAlert
        ->isScheduled()) {
        continue;
      }
      if (!($endDateTime = $sitewideAlert
        ->getScheduledEndDateTime())) {
        continue;
      }
      if ($soonestScheduledEndDate === NULL) {
        $soonestScheduledEndDate = $endDateTime;
        continue;
      }
      if ($soonestScheduledEndDate > $endDateTime) {
        $soonestScheduledEndDate = $endDateTime;
      }
    }
    return $soonestScheduledEndDate;
  }

  /**
   * Determines the datetime of the soonest expiring scheduled alert.
   *
   * @return \Drupal\Core\Datetime\DrupalDateTime|null
   *   The datetime of the soonest expiring scheduled alert; null if none of the alerts are scheduled to expire.
   */
  private function soonestAppearingScheduledAlertDateTime() {

    /** @var DrupalDateTime|null $soonestScheduledEndDate */
    $soonestScheduledStartDate = NULL;
    foreach ($this
      ->activeSitewideAlerts() as $sitewideAlert) {
      if (!$sitewideAlert
        ->isScheduled()) {
        continue;
      }
      if (!($startDateTime = $sitewideAlert
        ->getScheduledStartDateTime())) {
        continue;
      }
      if ($startDateTime
        ->getPhpDateTime() < $this
        ->requestDateTime()) {
        continue;
      }
      if ($soonestScheduledStartDate === NULL) {
        $soonestScheduledStartDate = $startDateTime;
        continue;
      }
      if ($soonestScheduledStartDate > $startDateTime) {
        $soonestScheduledStartDate = $startDateTime;
      }
    }
    return $soonestScheduledStartDate;
  }

  /**
   * The datetime of the current request.
   *
   * @return \DateTime
   *   The DateTime of the current request.
   */
  private function requestDateTime() {
    if (!$this->requestDateTime) {
      $this->requestDateTime = new \DateTime();
      $this->requestDateTime
        ->setTimestamp($this->time
        ->getRequestTime());
    }
    return $this->requestDateTime;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
SitewideAlertManager::$entityTypeManager	protected	property	The entity type manager.
SitewideAlertManager::$requestDateTime	private	property	Time of current request.
SitewideAlertManager::$time	protected	property	The time service.
SitewideAlertManager::activeSitewideAlerts	public	function	Returns all active sitewide alerts.
SitewideAlertManager::activeVisibleSitewideAlerts	public	function	Returns all active and currently visible sitewide alerts.
SitewideAlertManager::nextScheduledChange	public	function	The time of the next scheduled change of alerts.
SitewideAlertManager::requestDateTime	private	function	The datetime of the current request.
SitewideAlertManager::soonestAppearingScheduledAlertDateTime	private	function	Determines the datetime of the soonest expiring scheduled alert.
SitewideAlertManager::soonestExpiringVisibleScheduledAlertDateTime	private	function	Determines the datetime of the soonest expiring visible scheduled alert.
SitewideAlertManager::__construct	public	function	Constructor.