alert_types-8.x-1.x-dev/src/Entity/AlertInterface.php

<?php

namespace Drupal\alert_types\Entity;

use Drupal\Core\Entity\ContentEntityInterface;
use Drupal\Core\Entity\RevisionLogInterface;
use Drupal\Core\Entity\EntityChangedInterface;
use Drupal\user\EntityOwnerInterface;

/**
 * Provides an interface for defining Alert entities.
 *
 * @ingroup alert_types
 */
interface AlertInterface extends ContentEntityInterface, RevisionLogInterface, EntityChangedInterface, EntityOwnerInterface {

  /**
   * Gets the Alert name.
   *
   * @return string
   *   Name of the Alert.
   */
  public function getName();

  /**
   * Sets the Alert name.
   *
   * @param string $name
   *   The Alert name.
   *
   * @return \Drupal\alert_types\Entity\AlertInterface
   *   The called Alert entity.
   */
  public function setName($name);

  /**
   * Gets the Alert creation timestamp.
   *
   * @return int
   *   Creation timestamp of the Alert.
   */
  public function getCreatedTime();

  /**
   * Sets the Alert creation timestamp.
   *
   * @param int $timestamp
   *   The Alert creation timestamp.
   *
   * @return \Drupal\alert_types\Entity\AlertInterface
   *   The called Alert entity.
   */
  public function setCreatedTime($timestamp);

  /**
   * Returns the Alert active status indicator.
   *
   * Inactive Alerts are only visible to restricted users.
   *
   * @return bool
   *   TRUE if the Alert is active.
   */
  public function isActive();

  /**
   * Sets the active status of an Alert.
   *
   * @param bool $status
   *   TRUE to set this Alert to active, FALSE to set it to inactive.
   *
   * @return \Drupal\alert_types\Entity\AlertInterface
   *   The called Alert entity.
   */
  public function setActive($status);

  /**
   * Gets the weight of this alert.
   *
   * @return int
   *   The weight of the alert.
   */
  public function getWeight();

  /**
   * Gets the weight of this alert.
   *
   * @param int $weight
   *   The alert's weight.
   *
   * @return $this
   */
  public function setWeight($weight);

  /**
   * Gets the dismiss timer (in seconds).
   *
   * @return int
   *   The dismiss timer of the alert.
   */
  public function getDismissTimer();

  /**
   * Gets the dismiss timer.
   *
   * @param int $seconds
   *   The amount of time before the alert is dismissed.
   *
   * @return $this
   */
  public function setDismissTimer($seconds);

  /**
   * Gets the Alert revision creation timestamp.
   *
   * @return int
   *   The UNIX timestamp of when this revision was created.
   */
  public function getRevisionCreationTime();

  /**
   * Sets the Alert revision creation timestamp.
   *
   * @param int $timestamp
   *   The UNIX timestamp of when this revision was created.
   *
   * @return \Drupal\alert_types\Entity\AlertInterface
   *   The called Alert entity.
   */
  public function setRevisionCreationTime($timestamp);

  /**
   * Gets the Alert revision author.
   *
   * @return \Drupal\user\UserInterface
   *   The user entity for the revision author.
   */
  public function getRevisionUser();

  /**
   * Sets the Alert revision author.
   *
   * @param int $uid
   *   The user ID of the revision author.
   *
   * @return \Drupal\alert_types\Entity\AlertInterface
   *   The called Alert entity.
   */
  public function setRevisionUserId($uid);

}