You are here

Home » API reference » Mailing List 8 » MailingList.php

class MailingList in Mailing List 8

Defines the mailing list configuration entity.

Plugin annotation


@ConfigEntityType(
  id = "mailing_list",
  label = @Translation("Mailing list"),
  label_singular = @Translation("Mailing list"),
  label_plural = @Translation("Mailing lists"),
  handlers = {
    "list_builder" = "Drupal\mailing_list\MailingListListBuilder",
    "access" = "Drupal\mailing_list\MailingListAccessControlHandler",
    "form" = {
      "add" = "Drupal\mailing_list\Form\MailingListForm",
      "edit" = "Drupal\mailing_list\Form\MailingListForm",
      "delete" = "Drupal\mailing_list\Form\MailingListDeleteConfirmForm",
    },
  },
  admin_permission = "administer mailing lists",
  config_prefix = "mailing_list",
  bundle_of = "mailing_list_subscription",
  entity_keys = {
    "id" = "id",
    "label" = "label",
    "uuid" = "uuid",
  },
  links = {
    "add-form" = "/admin/structure/mailing_lists/add",
    "edit-form" = "/admin/structure/mailing_lists/{mailing_list}/edit",
    "delete-form" = "/admin/structure/emailing_lists/{mailing_list}/delete",
    "collection" = "/admin/structure/mailing_lists",
    "auto-label" = "/admin/structure/mailing_lists/{mailing_list}/auto-label",
    "export" = "/admin/structure/mailing_lists/{mailing_list}/export",
    "import" = "/admin/structure/mailing_lists/{mailing_list}/import",
  },
  config_export = {
    "id",
    "label",
    "description",
    "help",
    "max_per_user",
    "max_per_email",
    "inactive_subscriptions_liftime",
    "subscription_message",
    "cancellation_message",
    "cross_access",
    "form_destination",
  },
)

Hierarchy

Expanded class hierarchy of MailingList

2 files declare their use of MailingList
MailingListConfirmPermissions.php in mailing_list_confirm/src/MailingListConfirmPermissions.php
MailingListPermissions.php in src/MailingListPermissions.php

File

src/Entity/MailingList.php, line 58

Namespace

Drupal\mailing_list\Entity
View source 
class MailingList extends ConfigEntityBundleBase implements MailingListInterface {

  /**
   * A brief description of this mailing list.
   *
   * @var string
   */
  protected $description;

  /**
   * Help information when creating a new subscription on this list.
   *
   * @var string
   */
  protected $help;

  /**
   * Subscription limit per user.
   *
   * @var int
   */
  protected $max_per_user;

  /**
   * Subscription limit per email address.
   *
   * @var int
   */
  protected $max_per_email;

  /**
   * Inactive subscription lifetime.
   *
   * @var int
   */
  protected $inactive_subscriptions_liftime;

  /**
   * After subscription message.
   *
   * @var string
   */
  protected $subscription_message;

  /**
   * On subscription cancellation message.
   *
   * @var string
   */
  protected $cancellation_message;

  /**
   * Subscription form destination.
   *
   * @var string
   */
  protected $form_destination;

  /**
   * Subscription cross access allowance.
   *
   * @var unknown
   */
  protected $cross_access;

  /**
   * {@inheritdoc}
   */
  public function getHelp() {
    return $this->help;
  }

  /**
   * {@inheritdoc}
   */
  public function getDescription() {
    return $this->description;
  }

  /**
   * {@inheritdoc}
   */
  public function getLimitByUser() {
    return $this->max_per_user;
  }

  /**
   * {@inheritdoc}
   */
  public function setLimitByUser($limit) {
    $this->max_per_user = $limit;
  }

  /**
   * {@inheritdoc}
   */
  public function getLimitByEmail() {
    return $this->max_per_email;
  }

  /**
   * {@inheritdoc}
   */
  public function setLimitByEmail($limit) {
    $this->max_per_email = $limit;
  }

  /**
   * {@inheritdoc}
   */
  public function getInactiveLifetime() {
    return $this->inactive_subscriptions_liftime;
  }

  /**
   * {@inheritdoc}
   */
  public function setInactiveLifetime($time) {
    $this->inactive_subscriptions_liftime = $time;
  }

  /**
   * {@inheritdoc}
   */
  public function getOnSubscriptionMessage() {
    return $this->subscription_message;
  }

  /**
   * {@inheritdoc}
   */
  public function setOnSubscriptionMessage($message) {
    $this->subscription_message = $message;
  }

  /**
   * {@inheritdoc}
   */
  public function getOnCancellationMessage() {
    return $this->cancellation_message;
  }

  /**
   * {@inheritdoc}
   */
  public function setOnCancellationMessage($message) {
    $this->cancellation_message = $message;
  }

  /**
   * {@inheritdoc}
   */
  public function getFormDestination() {
    return $this->form_destination;
  }

  /**
   * {@inheritdoc}
   */
  public function setFormDestination($destination) {
    $this->form_destination = $destination;
  }

  /**
   * {@inheritdoc}
   */
  public function isCrossAccessAllowed() {
    return $this->cross_access;
  }

  /**
   * {@inheritdoc}
   */
  public function postSave(EntityStorageInterface $storage, $update = TRUE) {
    parent::postSave($storage, $update);
    if ($update) {

      // Update subscriptions mailing list.
      if ($this
        ->getOriginalId() != $this
        ->id()) {
        $update_count = $this
          ->entityTypeManager()
          ->getStorage('subscription')
          ->updateType($this
          ->getOriginalId(), $this
          ->id());
        if ($update_count) {
          drupal_set_message(\Drupal::translation()
            ->formatPlural($update_count, 'Changed the mailing list of 1 subscription from %old-type to %type.', 'Changed the mailing list of @count subscriptions from %old-type to %type.', [
            '%old-type' => $this
              ->getOriginalId(),
            '%type' => $this
              ->id(),
          ]));
        }
      }
    }
    else {

      // Create block form display mode.

      /** @var \Drupal\Core\Entity\Display\EntityFormDisplayInterface $block_display_mode */
      $block_display_mode = $this
        ->entityTypeManager()
        ->getStorage('entity_form_display')
        ->create([
        'id' => 'mailing_list_subscription.' . $this
          ->id() . '.block',
        'targetEntityType' => 'mailing_list_subscription',
        'bundle' => $this
          ->id(),
        'mode' => 'block',
        'status' => TRUE,
      ]);

      // Disable admin components.
      $block_display_mode
        ->removeComponent('uid')
        ->removeComponent('created')
        ->removeComponent('status')
        ->removeComponent('langcode')
        ->save();
    }
  }

  /**
   * {@inheritdoc}
   */
  public static function postDelete(EntityStorageInterface $storage, array $entities) {
    parent::postDelete($storage, $entities);

    // Remove permissions of the mailing list.
    $roles = \Drupal::entityTypeManager()
      ->getStorage('user_role')
      ->loadMultiple();
    foreach ($entities as $entity) {
      $list_id = $entity
        ->id();
      foreach ($roles as $role) {
        $save_role = FALSE;

        /* @var \Drupal\user\RoleInterface $role */
        foreach ([
          "subscribe to {$list_id} mailing list",
          "access inactive {$list_id} mailing list subscriptions",
          "view any {$list_id} mailing list subscriptions",
          "update any {$list_id} mailing list subscriptions",
          "delete any {$list_id} mailing list subscriptions",
        ] as $permission) {
          if ($role
            ->hasPermission($permission)) {
            $save_role = TRUE;
            $role
              ->revokePermission($permission);
          }
        }
        if ($save_role) {
          $role
            ->save();
        }
      }

      // Remove subscription blocks.
      foreach (\Drupal::entityTypeManager()
        ->getStorage('block')
        ->loadMultiple(\Drupal::entityQuery('block')
        ->condition('plugin', 'mailing_list_subscription_block')
        ->condition('settings.list', $entity
        ->id())
        ->execute()) as $block) {
        $block
          ->delete();
      }
    }

    // Clear the cache to reflect the removal.
    $storage
      ->resetCache(array_keys($entities));
  }

}

Members

Namesort descending Modifiers Type Description Overrides
CacheableDependencyTrait::$cacheContexts protected property Cache contexts.
CacheableDependencyTrait::$cacheMaxAge protected property Cache max-age.
CacheableDependencyTrait::$cacheTags protected property Cache tags.
CacheableDependencyTrait::setCacheability protected function Sets cacheability; useful for value object constructors.
ConfigEntityBase::$isUninstalling private property Whether the config is being deleted by the uninstall process.
ConfigEntityBase::$langcode protected property The language code of the entity's default language.
ConfigEntityBase::$originalId protected property The original ID of the configuration entity.
ConfigEntityBase::$status protected property The enabled/disabled status of the configuration entity. 4
ConfigEntityBase::$third_party_settings protected property Third party entity settings.
ConfigEntityBase::$trustedData protected property Trust supplied data and not use configuration schema on save.
ConfigEntityBase::$uuid protected property The UUID for this entity.
ConfigEntityBase::$_core protected property Information maintained by Drupal core about configuration.
ConfigEntityBase::addDependency protected function Overrides \Drupal\Core\Entity\DependencyTrait:addDependency().
ConfigEntityBase::calculateDependencies public function Calculates dependencies and stores them in the dependency property. Overrides ConfigEntityInterface::calculateDependencies 13
ConfigEntityBase::createDuplicate public function Creates a duplicate of the entity. Overrides EntityBase::createDuplicate 1
ConfigEntityBase::disable public function Disables the configuration entity. Overrides ConfigEntityInterface::disable 1
ConfigEntityBase::enable public function Enables the configuration entity. Overrides ConfigEntityInterface::enable
ConfigEntityBase::get public function Returns the value of a property. Overrides ConfigEntityInterface::get
ConfigEntityBase::getCacheTagsToInvalidate public function Returns the cache tags that should be used to invalidate caches. Overrides EntityBase::getCacheTagsToInvalidate 1
ConfigEntityBase::getConfigDependencyName public function Gets the configuration dependency name. Overrides EntityBase::getConfigDependencyName
ConfigEntityBase::getConfigManager protected static function Gets the configuration manager.
ConfigEntityBase::getConfigTarget public function Gets the configuration target identifier for the entity. Overrides EntityBase::getConfigTarget
ConfigEntityBase::getDependencies public function Gets the configuration dependencies. Overrides ConfigEntityInterface::getDependencies
ConfigEntityBase::getOriginalId public function Gets the original ID. Overrides EntityBase::getOriginalId
ConfigEntityBase::getThirdPartyProviders public function Gets the list of third parties that store information. Overrides ThirdPartySettingsInterface::getThirdPartyProviders
ConfigEntityBase::getThirdPartySetting public function Gets the value of a third-party setting. Overrides ThirdPartySettingsInterface::getThirdPartySetting
ConfigEntityBase::getThirdPartySettings public function Gets all third-party settings of a given module. Overrides ThirdPartySettingsInterface::getThirdPartySettings
ConfigEntityBase::getTypedConfig protected function Gets the typed config manager.
ConfigEntityBase::hasTrustedData public function Gets whether on not the data is trusted. Overrides ConfigEntityInterface::hasTrustedData
ConfigEntityBase::invalidateTagsOnDelete protected static function Override to never invalidate the individual entities' cache tags; the config system already invalidates them. Overrides EntityBase::invalidateTagsOnDelete
ConfigEntityBase::invalidateTagsOnSave protected function Override to never invalidate the entity's cache tag; the config system already invalidates it. Overrides EntityBase::invalidateTagsOnSave
ConfigEntityBase::isInstallable public function Checks whether this entity is installable. Overrides ConfigEntityInterface::isInstallable 2
ConfigEntityBase::isNew public function Overrides Entity::isNew(). Overrides EntityBase::isNew
ConfigEntityBase::isUninstalling public function Returns whether this entity is being changed during the uninstall process. Overrides ConfigEntityInterface::isUninstalling
ConfigEntityBase::link public function Deprecated way of generating a link to the entity. See toLink(). Overrides EntityBase::link
ConfigEntityBase::onDependencyRemoval public function Informs the entity that entities it depends on will be deleted. Overrides ConfigEntityInterface::onDependencyRemoval 7
ConfigEntityBase::preDelete public static function Acts on entities before they are deleted and before hooks are invoked. Overrides EntityBase::preDelete 8
ConfigEntityBase::save public function Saves an entity permanently. Overrides EntityBase::save 1
ConfigEntityBase::set public function Sets the value of a property. Overrides ConfigEntityInterface::set
ConfigEntityBase::setOriginalId public function Sets the original ID. Overrides EntityBase::setOriginalId
ConfigEntityBase::setStatus public function Sets the status of the configuration entity. Overrides ConfigEntityInterface::setStatus
ConfigEntityBase::setThirdPartySetting public function Sets the value of a third-party setting. Overrides ThirdPartySettingsInterface::setThirdPartySetting
ConfigEntityBase::setUninstalling public function
ConfigEntityBase::sort public static function Helper callback for uasort() to sort configuration entities by weight and label. 6
ConfigEntityBase::status public function Returns whether the configuration entity is enabled. Overrides ConfigEntityInterface::status 4
ConfigEntityBase::toArray public function Gets an array of all property values. Overrides EntityBase::toArray 2
ConfigEntityBase::toUrl public function Gets the URL object for the entity. Overrides EntityBase::toUrl
ConfigEntityBase::trustData public function Sets that the data should be trusted. Overrides ConfigEntityInterface::trustData
ConfigEntityBase::unsetThirdPartySetting public function Unsets a third-party setting. Overrides ThirdPartySettingsInterface::unsetThirdPartySetting
ConfigEntityBase::url public function Gets the public URL for this entity. Overrides EntityBase::url
ConfigEntityBase::urlInfo public function Gets the URL object for the entity. Overrides EntityBase::urlInfo
ConfigEntityBase::__construct public function Constructs an Entity object. Overrides EntityBase::__construct 10
ConfigEntityBase::__sleep public function Overrides EntityBase::__sleep 4
ConfigEntityBundleBase::deleteDisplays protected function Deletes display if a bundle is deleted.
ConfigEntityBundleBase::loadDisplays protected function Returns view or form displays for this bundle.
ConfigEntityBundleBase::preSave public function Acts on an entity before the presave hook is invoked. Overrides ConfigEntityBase::preSave
DependencySerializationTrait::$_entityStorages protected property An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function Aliased as: traitSleep 1
DependencySerializationTrait::__wakeup public function 2
DependencyTrait::$dependencies protected property The object's dependencies.
DependencyTrait::addDependencies protected function Adds multiple dependencies.
DependencyTrait::addDependency protected function Adds a dependency. Aliased as: addDependencyTrait
EntityBase::$enforceIsNew protected property Boolean indicating whether the entity should be forced to be new.
EntityBase::$entityTypeId protected property The entity type.
EntityBase::$typedData protected property A typed data object wrapping this entity.
EntityBase::access public function Checks data value access. Overrides AccessibleInterface::access 1
EntityBase::bundle public function Gets the bundle of the entity. Overrides EntityInterface::bundle 1
EntityBase::create public static function Constructs a new entity object, without permanently saving it. Overrides EntityInterface::create
EntityBase::delete public function Deletes an entity permanently. Overrides EntityInterface::delete 2
EntityBase::enforceIsNew public function Enforces an entity to be new. Overrides EntityInterface::enforceIsNew
EntityBase::entityManager Deprecated protected function Gets the entity manager.
EntityBase::entityTypeBundleInfo protected function Gets the entity type bundle info service.
EntityBase::entityTypeManager protected function Gets the entity type manager.
EntityBase::getCacheContexts public function The cache contexts associated with this object. Overrides CacheableDependencyTrait::getCacheContexts
EntityBase::getCacheMaxAge public function The maximum age for which this object may be cached. Overrides CacheableDependencyTrait::getCacheMaxAge
EntityBase::getCacheTags public function The cache tags associated with this object. Overrides CacheableDependencyTrait::getCacheTags
EntityBase::getConfigDependencyKey public function Gets the key that is used to store configuration dependencies. Overrides EntityInterface::getConfigDependencyKey
EntityBase::getEntityType public function Gets the entity type definition. Overrides EntityInterface::getEntityType
EntityBase::getEntityTypeId public function Gets the ID of the type of the entity. Overrides EntityInterface::getEntityTypeId
EntityBase::getListCacheTagsToInvalidate protected function The list cache tags to invalidate for this entity.
EntityBase::getTypedData public function Gets a typed data object for this entity object. Overrides EntityInterface::getTypedData
EntityBase::hasLinkTemplate public function Indicates if a link template exists for a given key. Overrides EntityInterface::hasLinkTemplate
EntityBase::id public function Gets the identifier. Overrides EntityInterface::id 11
EntityBase::label public function Gets the label of the entity. Overrides EntityInterface::label 6
EntityBase::language public function Gets the language of the entity. Overrides EntityInterface::language 1
EntityBase::languageManager protected function Gets the language manager.
EntityBase::linkTemplates protected function Gets an array link templates. 1
EntityBase::load public static function Loads an entity. Overrides EntityInterface::load
EntityBase::loadMultiple public static function Loads one or more entities. Overrides EntityInterface::loadMultiple
EntityBase::postCreate public function Acts on a created entity before hooks are invoked. Overrides EntityInterface::postCreate 4
EntityBase::postLoad public static function Acts on loaded entities. Overrides EntityInterface::postLoad 2
EntityBase::preCreate public static function Changes the values of an entity before it is created. Overrides EntityInterface::preCreate 5
EntityBase::referencedEntities public function Gets a list of entities referenced by this entity. Overrides EntityInterface::referencedEntities 1
EntityBase::toLink public function Generates the HTML for a link to this entity. Overrides EntityInterface::toLink
EntityBase::uriRelationships public function Gets a list of URI relationships supported by this entity. Overrides EntityInterface::uriRelationships
EntityBase::urlRouteParameters protected function Gets an array of placeholders for this entity. 2
EntityBase::uuid public function Gets the entity UUID (Universally Unique Identifier). Overrides EntityInterface::uuid 1
EntityBase::uuidGenerator protected function Gets the UUID generator.
MailingList::$cancellation_message protected property On subscription cancellation message.
MailingList::$cross_access protected property Subscription cross access allowance.
MailingList::$description protected property A brief description of this mailing list.
MailingList::$form_destination protected property Subscription form destination.
MailingList::$help protected property Help information when creating a new subscription on this list.
MailingList::$inactive_subscriptions_liftime protected property Inactive subscription lifetime.
MailingList::$max_per_email protected property Subscription limit per email address.
MailingList::$max_per_user protected property Subscription limit per user.
MailingList::$subscription_message protected property After subscription message.
MailingList::getDescription public function Gets the description. Overrides MailingListInterface::getDescription
MailingList::getFormDestination public function Gets the subscription form destination config option. Overrides MailingListInterface::getFormDestination
MailingList::getHelp public function Gets the help information. Overrides MailingListInterface::getHelp
MailingList::getInactiveLifetime public function Gets the inactive subscriptions lifetime for this mailing list. Overrides MailingListInterface::getInactiveLifetime
MailingList::getLimitByEmail public function Gets the maximum number of subscriptions per email address. Overrides MailingListInterface::getLimitByEmail
MailingList::getLimitByUser public function Gets the maximum number of subscriptions per user. Overrides MailingListInterface::getLimitByUser
MailingList::getOnCancellationMessage public function Gets the cancellation message. Overrides MailingListInterface::getOnCancellationMessage
MailingList::getOnSubscriptionMessage public function Gets the subscription confirmation message. Overrides MailingListInterface::getOnSubscriptionMessage
MailingList::isCrossAccessAllowed public function Check if subscription cross access is allowed for this mailing list. Overrides MailingListInterface::isCrossAccessAllowed
MailingList::postDelete public static function Acts on deleted entities before the delete hook is invoked. Overrides ConfigEntityBundleBase::postDelete
MailingList::postSave public function Acts on a saved entity before the insert or update hook is invoked. Overrides ConfigEntityBundleBase::postSave
MailingList::setFormDestination public function Sets the subscription form destination config option. Overrides MailingListInterface::setFormDestination
MailingList::setInactiveLifetime public function Sets the inactive subscriptions lifetime for this mailing list. Overrides MailingListInterface::setInactiveLifetime
MailingList::setLimitByEmail public function Sets the maximum number of subscriptions per email address. Overrides MailingListInterface::setLimitByEmail
MailingList::setLimitByUser public function Sets the maximum number of subscriptions per user. Overrides MailingListInterface::setLimitByUser
MailingList::setOnCancellationMessage public function Sets the subscription cancellation message. Overrides MailingListInterface::setOnCancellationMessage
MailingList::setOnSubscriptionMessage public function Sets the subscription confirmation message. Overrides MailingListInterface::setOnSubscriptionMessage
PluginDependencyTrait::calculatePluginDependencies protected function Calculates and adds dependencies of a specific plugin instance. 1
PluginDependencyTrait::getPluginDependencies protected function Calculates and returns dependencies of a specific plugin instance.
PluginDependencyTrait::moduleHandler protected function Wraps the module handler. 1
PluginDependencyTrait::themeHandler protected function Wraps the theme handler. 1
RefinableCacheableDependencyTrait::addCacheableDependency public function 1
RefinableCacheableDependencyTrait::addCacheContexts public function
RefinableCacheableDependencyTrait::addCacheTags public function
RefinableCacheableDependencyTrait::mergeCacheMaxAge public function
SynchronizableEntityTrait::$isSyncing protected property Whether this entity is being created, updated or deleted through a synchronization process.
SynchronizableEntityTrait::isSyncing public function
SynchronizableEntityTrait::setSyncing public function