interface MailingListInterface in Mailing List 8

Provides an interface defining a mailing list entity.

Hierarchy

interface \Drupal\Core\Entity\EntityInterface; interface \Drupal\Core\Config\Entity\ThirdPartySettingsInterface; interface \Drupal\Core\Entity\SynchronizableInterface
- interface \Drupal\Core\Config\Entity\ConfigEntityInterface
  - interface \Drupal\mailing_list\MailingListInterface

Expanded class hierarchy of MailingListInterface

All classes that implement MailingListInterface

5 files declare their use of MailingListInterface

MailingList.php in src/Entity/MailingList.php
MailingListController.php in src/Controller/MailingListController.php
MailingListExportForm.php in src/Form/MailingListExportForm.php
MailingListImportForm.php in src/Form/MailingListImportForm.php
SubscriptionAddAccessCheck.php in src/Access/SubscriptionAddAccessCheck.php

File

src/MailingListInterface.php, line 10

Namespace

Drupal\mailing_list

View source

interface MailingListInterface extends ConfigEntityInterface {

  /**
   * Gets the help information.
   *
   * @return string
   *   The help information of this mailing list.
   */
  public function getHelp();

  /**
   * Gets the description.
   *
   * @return string
   *   The description of this mailing list.
   */
  public function getDescription();

  /**
   * Gets the maximum number of subscriptions per user.
   *
   * @return int
   *   The limit value.
   */
  public function getLimitByUser();

  /**
   * Sets the maximum number of subscriptions per user.
   *
   * @param int $limit
   *   The limit value.
   */
  public function setLimitByUser($limit);

  /**
   * Gets the inactive subscriptions lifetime for this mailing list.
   *
   * @return int
   *   Max inactive subscriptions lifetime in seconds.
   */
  public function getInactiveLifetime();

  /**
   * Sets the inactive subscriptions lifetime for this mailing list.
   *
   * @param int $time
   *   Max inactive subscriptions lifetime in seconds.
   */
  public function setInactiveLifetime($time);

  /**
   * Gets the maximum number of subscriptions per email address.
   *
   * @return int
   *   The limit value.
   */
  public function getLimitByEmail();

  /**
   * Sets the maximum number of subscriptions per email address.
   *
   * @param int $limit
   *   The limit value.
   */
  public function setLimitByEmail($limit);

  /**
   * Check if subscription cross access is allowed for this mailing list.
   *
   * @return bool
   *   TRUE when user cross access is allowd, FALSE otherwise.
   */
  public function isCrossAccessAllowed();

  /**
   * Gets the subscription confirmation message.
   *
   * @return string
   *   The confirmation message.
   */
  public function getOnSubscriptionMessage();

  /**
   * Sets the subscription confirmation message.
   *
   * @param string $message
   *   The new confirmation message.
   */
  public function setOnSubscriptionMessage($message);

  /**
   * Gets the cancellation message.
   *
   * @return string
   *   The cancellation message.
   */
  public function getOnCancellationMessage();

  /**
   * Sets the subscription cancellation message.
   *
   * @param string $message
   *   The new cancellation message.
   */
  public function setOnCancellationMessage($message);

  /**
   * Gets the subscription form destination config option.
   *
   * @return string
   *   The form destination.
   */
  public function getFormDestination();

  /**
   * Sets the subscription form destination config option.
   *
   * @param string $destination
   *   The form destination.
   */
  public function setFormDestination($destination);

}

Members

Name	Modifiers	Type	Description	Overrides
AccessibleInterface::access	public	function	Checks data value access.	9
CacheableDependencyInterface::getCacheContexts	public	function	The cache contexts associated with this object.	34
CacheableDependencyInterface::getCacheMaxAge	public	function	The maximum age for which this object may be cached.	34
CacheableDependencyInterface::getCacheTags	public	function	The cache tags associated with this object.	27
ConfigEntityInterface::calculateDependencies	public	function	Calculates dependencies and stores them in the dependency property.	2
ConfigEntityInterface::disable	public	function	Disables the configuration entity.	2
ConfigEntityInterface::enable	public	function	Enables the configuration entity.	2
ConfigEntityInterface::get	public	function	Returns the value of a property.	2
ConfigEntityInterface::getDependencies	public	function	Gets the configuration dependencies.	2
ConfigEntityInterface::hasTrustedData	public	function	Gets whether on not the data is trusted.	2
ConfigEntityInterface::isInstallable	public	function	Checks whether this entity is installable.	2
ConfigEntityInterface::isUninstalling	public	function	Returns whether this entity is being changed during the uninstall process.	2
ConfigEntityInterface::onDependencyRemoval	public	function	Informs the entity that entities it depends on will be deleted.	2
ConfigEntityInterface::set	public	function	Sets the value of a property.	2
ConfigEntityInterface::setStatus	public	function	Sets the status of the configuration entity.	2
ConfigEntityInterface::status	public	function	Returns whether the configuration entity is enabled.	2
ConfigEntityInterface::trustData	public	function	Sets that the data should be trusted.	2
EntityInterface::bundle	public	function	Gets the bundle of the entity.	2
EntityInterface::create	public static	function	Constructs a new entity object, without permanently saving it.	2
EntityInterface::createDuplicate	public	function	Creates a duplicate of the entity.	2
EntityInterface::delete	public	function	Deletes an entity permanently.	2
EntityInterface::enforceIsNew	public	function	Enforces an entity to be new.	2
EntityInterface::getCacheTagsToInvalidate	public	function	Returns the cache tags that should be used to invalidate caches.	2
EntityInterface::getConfigDependencyKey	public	function	Gets the key that is used to store configuration dependencies.	2
EntityInterface::getConfigDependencyName	public	function	Gets the configuration dependency name.	2
EntityInterface::getConfigTarget	public	function	Gets the configuration target identifier for the entity.	2
EntityInterface::getEntityType	public	function	Gets the entity type definition.	2
EntityInterface::getEntityTypeId	public	function	Gets the ID of the type of the entity.	2
EntityInterface::getOriginalId	public	function	Gets the original ID.	2
EntityInterface::getTypedData	public	function	Gets a typed data object for this entity object.	2
EntityInterface::hasLinkTemplate	public	function	Indicates if a link template exists for a given key.	2
EntityInterface::id	public	function	Gets the identifier.	2
EntityInterface::isNew	public	function	Determines whether the entity is new.	2
EntityInterface::label	public	function	Gets the label of the entity.	2
EntityInterface::language	public	function	Gets the language of the entity.	2
EntityInterface::link Deprecated	public	function	Deprecated way of generating a link to the entity. See toLink().	2
EntityInterface::load	public static	function	Loads an entity.	2
EntityInterface::loadMultiple	public static	function	Loads one or more entities.	2
EntityInterface::postCreate	public	function	Acts on a created entity before hooks are invoked.	2
EntityInterface::postDelete	public static	function	Acts on deleted entities before the delete hook is invoked.	2
EntityInterface::postLoad	public static	function	Acts on loaded entities.	3
EntityInterface::postSave	public	function	Acts on a saved entity before the insert or update hook is invoked.	2
EntityInterface::preCreate	public static	function	Changes the values of an entity before it is created.	2
EntityInterface::preDelete	public static	function	Acts on entities before they are deleted and before hooks are invoked.	2
EntityInterface::preSave	public	function	Acts on an entity before the presave hook is invoked.	2
EntityInterface::referencedEntities	public	function	Gets a list of entities referenced by this entity.	2
EntityInterface::save	public	function	Saves an entity permanently.	2
EntityInterface::setOriginalId	public	function	Sets the original ID.	2
EntityInterface::toArray	public	function	Gets an array of all property values.	3
EntityInterface::toLink	public	function	Generates the HTML for a link to this entity.	2
EntityInterface::toUrl	public	function	Gets the URL object for the entity.	2
EntityInterface::uriRelationships	public	function	Gets a list of URI relationships supported by this entity.	2
EntityInterface::url Deprecated	public	function	Gets the public URL for this entity.	2
EntityInterface::urlInfo Deprecated	public	function	Gets the URL object for the entity.	2
EntityInterface::uuid	public	function	Gets the entity UUID (Universally Unique Identifier).	2
MailingListInterface::getDescription	public	function	Gets the description.	1
MailingListInterface::getFormDestination	public	function	Gets the subscription form destination config option.	1
MailingListInterface::getHelp	public	function	Gets the help information.	1
MailingListInterface::getInactiveLifetime	public	function	Gets the inactive subscriptions lifetime for this mailing list.	1
MailingListInterface::getLimitByEmail	public	function	Gets the maximum number of subscriptions per email address.	1
MailingListInterface::getLimitByUser	public	function	Gets the maximum number of subscriptions per user.	1
MailingListInterface::getOnCancellationMessage	public	function	Gets the cancellation message.	1
MailingListInterface::getOnSubscriptionMessage	public	function	Gets the subscription confirmation message.	1
MailingListInterface::isCrossAccessAllowed	public	function	Check if subscription cross access is allowed for this mailing list.	1
MailingListInterface::setFormDestination	public	function	Sets the subscription form destination config option.	1
MailingListInterface::setInactiveLifetime	public	function	Sets the inactive subscriptions lifetime for this mailing list.	1
MailingListInterface::setLimitByEmail	public	function	Sets the maximum number of subscriptions per email address.	1
MailingListInterface::setLimitByUser	public	function	Sets the maximum number of subscriptions per user.	1
MailingListInterface::setOnCancellationMessage	public	function	Sets the subscription cancellation message.	1
MailingListInterface::setOnSubscriptionMessage	public	function	Sets the subscription confirmation message.	1
RefinableCacheableDependencyInterface::addCacheableDependency	public	function	Adds a dependency on an object: merges its cacheability metadata.	1
RefinableCacheableDependencyInterface::addCacheContexts	public	function	Adds cache contexts.	1
RefinableCacheableDependencyInterface::addCacheTags	public	function	Adds cache tags.	1
RefinableCacheableDependencyInterface::mergeCacheMaxAge	public	function	Merges the maximum age (in seconds) with the existing maximum age.	1
SynchronizableInterface::isSyncing	public	function	Returns whether this entity is being changed as part of a synchronization.	1
SynchronizableInterface::setSyncing	public	function	Sets the status of the synchronization flag.	1
ThirdPartySettingsInterface::getThirdPartyProviders	public	function	Gets the list of third parties that store information.	5
ThirdPartySettingsInterface::getThirdPartySetting	public	function	Gets the value of a third-party setting.	5
ThirdPartySettingsInterface::getThirdPartySettings	public	function	Gets all third-party settings of a given module.	5
ThirdPartySettingsInterface::setThirdPartySetting	public	function	Sets the value of a third-party setting.	5
ThirdPartySettingsInterface::unsetThirdPartySetting	public	function	Unsets a third-party setting.	5

You are here

interface MailingListInterface in Mailing List 8

Hierarchy

File

Namespace

Members

API Navigation