contacts_events-8.x-1.x-dev/src/Entity/EventInterface.php

<?php

namespace Drupal\contacts_events\Entity;

use Drupal\Core\Entity\ContentEntityInterface;
use Drupal\Core\Entity\EntityChangedInterface;

/**
 * Provides an interface for defining Event entities.
 *
 * @ingroup contacts_events
 */
interface EventInterface extends ContentEntityInterface, EntityChangedInterface {

  /**
   * Event bookings are disabled.
   */
  const STATUS_DISABLED = 'disabled';

  /**
   * Event bookings are restricted.
   */
  const STATUS_CLOSED = 'closed';

  /**
   * Event is open for bookings.
   */
  const STATUS_OPEN = 'open';

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

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

  /**
   * Returns the Event published status indicator.
   *
   * Unpublished Event are only visible to restricted users.
   *
   * @return bool
   *   TRUE if the Event is published.
   */
  public function isPublished();

  /**
   * Sets the published status of a Event.
   *
   * @param bool $published
   *   TRUE to set this Event to published, FALSE to set it to unpublished.
   *
   * @return \Drupal\contacts_events\Entity\EventInterface
   *   The called Event entity.
   */
  public function setPublished($published);

  /**
   * Check whether bookings are enabled for this event.
   *
   * @return bool
   *   Whether bookings are enabled.
   */
  public function isBookingEnabled();

  /**
   * Check whether bookings are open for this event.
   *
   * Additional permissions are required if bookings are closed.
   *
   * @return bool
   *   Whether bookings are open.
   */
  public function isBookingOpen();

  /**
   * Get an event setting.
   *
   * @param string|array $key
   *   Either a string or array indicating the key. Strings can indicate depth
   *   with '.'.
   * @param mixed $default
   *   The default value if there is no setting.
   *
   * @return mixed
   *   The setting, or the default value.
   */
  public function getSetting($key, $default = NULL);

  /**
   * Set an event setting.
   *
   * @param string|array $key
   *   Either a string or array indicating the key. Strings can indicate depth
   *   with '.'.
   * @param mixed $value
   *   The value to set.
   *
   * @return $this
   */
  public function setSetting($key, $value);

  /**
   * Unset an event setting.
   *
   * @param string|array $key
   *   Either a string or array indicating the key. Strings can indicate depth
   *   with '.'.
   *
   * @return $this
   */
  public function unsetSetting($key);

}