You are here

Home » API reference » Heartbeat 8 » HeartbeatType.php

class HeartbeatType in Heartbeat 8

Defines the Heartbeat type entity.

Plugin annotation


@ConfigEntityType(
  id = "heartbeat_type",
  label = @Translation("Heartbeat type"),
  handlers = {
    "list_builder" = "Drupal\heartbeat\HeartbeatTypeListBuilder",
    "form" = {
      "add" = "Drupal\heartbeat\Form\HeartbeatTypeForm",
      "edit" = "Drupal\heartbeat\Form\HeartbeatTypeForm",
      "delete" = "Drupal\heartbeat\Form\HeartbeatTypeDeleteForm"
    },
    "route_provider" = {
      "html" = "Drupal\heartbeat\HeartbeatTypeHtmlRouteProvider",
    },
  },
  config_prefix = "heartbeat_type",
  admin_permission = "administer site configuration",
  bundle_of = "heartbeat",
  entity_keys = {
    "id" = "id",
    "label" = "label",
    "uuid" = "uuid"
  },
  links = {
    "canonical" = "/admin/structure/heartbeat_type/{heartbeat_type}",
    "add-form" = "/admin/structure/heartbeat_type/add",
    "edit-form" = "/admin/structure/heartbeat_type/{heartbeat_type}/edit",
    "delete-form" = "/admin/structure/heartbeat_type/{heartbeat_type}/delete",
    "collection" = "/admin/structure/heartbeat_type"
  }
)

Hierarchy

Expanded class hierarchy of HeartbeatType

3 files declare their use of HeartbeatType
heartbeat.module in ./heartbeat.module
Contains heartbeat.module.
HeartbeatStream.php in src/Entity/HeartbeatStream.php
HeartbeatStreamForm.php in src/Form/HeartbeatStreamForm.php

File

src/Entity/HeartbeatType.php, line 43

Namespace

Drupal\heartbeat\Entity
View source 
class HeartbeatType extends ConfigEntityBundleBase implements HeartbeatTypeInterface {

  /**
   * The Heartbeat Stream ID.
   *
   * @var string
   */
  protected $id;
  protected $messageId;
  protected $hid;
  protected $description;
  protected $perms;
  protected $messageConcat;
  protected $arguments;
  protected $message;
  protected $variables;
  protected $attachments;
  protected $groupType;
  protected $mainentity;
  protected $entityManager;

  /**
   * The Heartbeat Stream label.
   *
   * @var string
   */
  protected $label;
  public static function getHeartbeatTypeEntity($messageId) {
    $entity_manager = \Drupal::entityTypeManager();
  }
  public function setMessageId($messageId) {
    $this->messageId = $messageId;
  }
  public function getMessageId() {
    return $this->messageId;
  }

  /**
   * Sets the description of the stream
   *
   * @param string $description
   *  Describing streams of this type
   */
  public function setDescription($description) {
    $this->description = $description;
  }

  /**
   * Gets the description of the stream
   *
   * @return string
   *  The Stream's description
   */
  public function getDescription() {
    return $this->description;
  }

  /**
   * Sets the translatable message
   * This message creates the structure of each message
   *
   * @param string $message
   *  The template message serving as the foundation of each message structure of this stream type
   */
  public function setMessage($message) {
    $this
      ->set('message', $message);
  }

  /**
   * Gets the translatable message of the stream
   *
   * @return string
   *  The Stream's message
   */
  public function getMessage() {
    return $this
      ->get('message');
  }

  //  /**
  //   * Sets the translatable concatenated message
  //   *
  //   * @param string $messageConcat
  //   *
  //   */
  //  public function setMessageConcat($messageConcat) {
  //    $this->messageConcat = $messageConcat;
  //  }
  //
  //  /**
  //   * Gets the concatenated message of the stream
  //   *
  //   * @return string
  //   *  The Stream's concatenated message
  //   */
  //  public function getMessageConcat() {
  //    return $this->messageConcat;
  //  }

  /**
   * Sets the Permissions for this message stream
   *
   * @param int $perms
   *
   */
  public function setPerms($perms) {
    $this->perms = $perms;
  }

  /**
   * Gets the Permissions of this message stream
   *
   * @return int
   *  The stream's permissions
   */
  public function getPerms() {
    return $this->perms;
  }

  /**
   * Sets the Group Type for this message stream
   *
   * @param string $groupType
   *
   */
  public function setGroupType($groupType) {
    $this->groupType = $groupType;
  }

  /**
   * Gets the Group Type of this message stream
   *
   * @return string
   *  The stream's Group Type
   */
  public function getGroupType() {
    return $this->groupType;
  }

  /**
   * Sets the arguments for the concatenated message
   *
   * @param string $arguments
   *
   */
  public function setArguments($arguments) {
    $this
      ->set('arguments', $arguments);

    //    $this->arguments = $arguments;
  }

  /**
   * Gets the arguments for the concatenated message
   *
   * @return string
   *  The stream's arguments for the concatenated message
   */
  public function getArguments() {
    return $this
      ->get('arguments');

    //    return $this->arguments;
  }

  /**
   * Sets the variables for this message stream
   *
   * @param string $variables
   *
   */
  public function setVariables($variables) {
    $this->variables = $variables;
  }

  /**
   * Gets the variables of this message stream
   *
   * @return string
   *  The stream's variables
   */
  public function getVariables() {
    return $this->variables;
  }

  /**
   * @inheritDoc
   */
  public function __construct(array $values, $entity_type) {
    parent::__construct($values, $entity_type);
    $this->entityManager = \Drupal::entityManager();
    $this->entityTypeManager = \Drupal::entityTypeManager();
  }

  /**
   * @inheritDoc
   */
  protected function entityManager() {
    return parent::entityManager();
  }

  /**
   * @inheritDoc
   */
  protected function entityTypeManager() {
    return parent::entityTypeManager();
  }

  /**
   * {@inheritdoc}
   */
  public function isLocked() {
    $locked = \Drupal::state()
      ->get('heartbeat.type.locked');
    return isset($locked[$this
      ->id()]) ? $locked[$this
      ->id()] : FALSE;
  }

  /**
   *
   */
  public function loadHeartbeatType() {
    $this->entityTypeManager
      ->getDefinitions();
  }

  /**
   * {@inheritdoc}
   */
  public function postSave(EntityStorageInterface $storage, $update = TRUE) {
    parent::postSave($storage, $update);
    if ($update && $this
      ->getOriginalId() != $this
      ->id()) {
      $update_count = heartbeat_type_update_heartbeats($this
        ->getOriginalId(), $this
        ->id());
      if ($update_count) {
        drupal_set_message(\Drupal::translation()
          ->formatPlural($update_count, 'Changed the heartbeat type of 1 activity from %old-type to %type.', 'Changed the heartbeat type of @count activities from %old-type to %type.', [
          '%old-type' => $this
            ->getOriginalId(),
          '%type' => $this
            ->id(),
        ]));
      }
    }
    if ($update) {

      // Clear the cached field definitions as some settings affect the field
      // definitions.
      $this
        ->entityManager()
        ->clearCachedFieldDefinitions();
    }
  }

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

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

  /**
   * Sets the main Entity Type of the Heartbeat Type
   *
   * @param string $mainentity
   *  Describing entity type used in this Heartbeat Type
   */
  public function setMainEntity($mainentity) {
    $this
      ->set('mainentity', $mainentity);
  }

  /**
   * @return mixed|null
   *
   */
  public function getMainEntity() {
    return $this
      ->get('mainentity');
  }

  /**
   * Sets the bundle targeted for this Heartbeat type
   *
   * @param string $variables
   *
   */
  public function setBundle($bundle) {
    $this
      ->set('bundle', $bundle);
  }

  /**
   * Gets the bundle of this Heartbeat type
   *
   * @return string
   *  The stream's variables
   */
  public function getBundle() {
    return $this
      ->get('bundle');
  }

  /**
   * @return mixed
   */
  public function setWeight($weight) {
    $this
      ->set('weight', $weight);
  }

  /**
   * @param $weight
   * @return mixed
   */
  public function getWeight() {
    return $this
      ->get('weight');
  }

}

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::__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::entityTypeBundleInfo protected function Gets the entity type bundle info service.
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.
HeartbeatType::$arguments protected property
HeartbeatType::$attachments protected property
HeartbeatType::$description protected property
HeartbeatType::$entityManager protected property
HeartbeatType::$groupType protected property
HeartbeatType::$hid protected property
HeartbeatType::$id protected property The Heartbeat Stream ID.
HeartbeatType::$label protected property The Heartbeat Stream label.
HeartbeatType::$mainentity protected property
HeartbeatType::$message protected property
HeartbeatType::$messageConcat protected property
HeartbeatType::$messageId protected property
HeartbeatType::$perms protected property
HeartbeatType::$variables protected property
HeartbeatType::entityManager protected function @inheritDoc Overrides EntityBase::entityManager
HeartbeatType::entityTypeManager protected function @inheritDoc Overrides EntityBase::entityTypeManager
HeartbeatType::getArguments public function Gets the arguments for the concatenated message Overrides HeartbeatTypeInterface::getArguments
HeartbeatType::getBundle public function Gets the bundle of this Heartbeat type Overrides HeartbeatTypeInterface::getBundle
HeartbeatType::getDescription public function Gets the description of the stream Overrides HeartbeatTypeInterface::getDescription
HeartbeatType::getGroupType public function Gets the Group Type of this message stream Overrides HeartbeatTypeInterface::getGroupType
HeartbeatType::getHeartbeatTypeEntity public static function
HeartbeatType::getMainEntity public function Overrides HeartbeatTypeInterface::getMainEntity
HeartbeatType::getMessage public function Gets the translatable message of the stream Overrides HeartbeatTypeInterface::getMessage
HeartbeatType::getMessageId public function Overrides HeartbeatTypeInterface::getMessageId
HeartbeatType::getPerms public function Gets the Permissions of this message stream Overrides HeartbeatTypeInterface::getPerms
HeartbeatType::getVariables public function Gets the variables of this message stream Overrides HeartbeatTypeInterface::getVariables
HeartbeatType::getWeight public function Overrides HeartbeatTypeInterface::getWeight
HeartbeatType::isLocked public function
HeartbeatType::loadHeartbeatType public function
HeartbeatType::postDelete public static function Acts on deleted entities before the delete hook is invoked. Overrides ConfigEntityBundleBase::postDelete
HeartbeatType::postSave public function Acts on a saved entity before the insert or update hook is invoked. Overrides ConfigEntityBundleBase::postSave
HeartbeatType::setArguments public function Sets the arguments for the concatenated message Overrides HeartbeatTypeInterface::setArguments
HeartbeatType::setBundle public function Sets the bundle targeted for this Heartbeat type Overrides HeartbeatTypeInterface::setBundle
HeartbeatType::setDescription public function Sets the description of the stream Overrides HeartbeatTypeInterface::setDescription
HeartbeatType::setGroupType public function Sets the Group Type for this message stream Overrides HeartbeatTypeInterface::setGroupType
HeartbeatType::setMainEntity public function Sets the main Entity Type of the Heartbeat Type Overrides HeartbeatTypeInterface::setMainEntity
HeartbeatType::setMessage public function Sets the translatable message This message creates the structure of each message Overrides HeartbeatTypeInterface::setMessage
HeartbeatType::setMessageId public function Overrides HeartbeatTypeInterface::setMessageId
HeartbeatType::setPerms public function Sets the Permissions for this message stream Overrides HeartbeatTypeInterface::setPerms
HeartbeatType::setVariables public function Sets the variables for this message stream Overrides HeartbeatTypeInterface::setVariables
HeartbeatType::setWeight public function Overrides HeartbeatTypeInterface::setWeight
HeartbeatType::__construct public function @inheritDoc Overrides ConfigEntityBase::__construct
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