You are here

Home » API reference » Brightcove Video Connect 3.x » BrightcovePlayer.php

class BrightcovePlayer in Brightcove Video Connect 3.x

Same name and namespace in other branches
  1. 8.2 src/Entity/BrightcovePlayer.php \Drupal\brightcove\Entity\BrightcovePlayer
  2. 8 src/Entity/BrightcovePlayer.php \Drupal\brightcove\Entity\BrightcovePlayer

Defines the Brightcove Player.

Plugin annotation


@ContentEntityType(
  id = "brightcove_player",
  label = @Translation("Brightcove Player"),
  base_table = "brightcove_player",
  entity_keys = {
    "id" = "bcpid",
    "label" = "name",
    "uuid" = "uuid",
    "uid" = "uid",
    "langcode" = "langcode",
    "status" = "status",
  }
)

Hierarchy

Expanded class hierarchy of BrightcovePlayer

9 files declare their use of BrightcovePlayer
brightcove.install in ./brightcove.install
Brightcove install file.
brightcove.module in ./brightcove.module
Brightcove module.
BrightcoveAPIClientForm.php in src/Form/BrightcoveAPIClientForm.php
BrightcoveAPIClientListBuilder.php in src/BrightcoveAPIClientListBuilder.php
BrightcoveClientQueueWorker.php in src/Plugin/QueueWorker/BrightcoveClientQueueWorker.php

... See full list

File

src/Entity/BrightcovePlayer.php, line 30

Namespace

Drupal\brightcove\Entity
View source 
class BrightcovePlayer extends BrightcoveCmsEntity implements BrightcovePlayerInterface {

  /**
   * {@inheritdoc}
   */
  public function getPlayerId() {
    return $this
      ->get('player_id')->value;
  }

  /**
   * {@inheritdoc}
   */
  public function setPlayerId($player_id) {
    $this
      ->set('player_id', $player_id);
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function isAdjusted() {
    return $this
      ->get('adjusted')->value;
  }

  /**
   * {@inheritdoc}
   */
  public function setAdjusted($adjusted) {
    return $this
      ->set('adjusted', $adjusted);
  }

  /**
   * {@inheritdoc}
   */
  public function getHeight() {
    return $this
      ->get('height')->value;
  }

  /**
   * {@inheritdoc}
   */
  public function setHeight($height) {
    return $this
      ->set('height', $height);
  }

  /**
   * {@inheritdoc}
   */
  public function getWidth() {
    return $this
      ->get('width')->value;
  }

  /**
   * {@inheritdoc}
   */
  public function setWidth($width) {
    return $this
      ->set('width', $width);
  }

  /**
   * {@inheritdoc}
   */
  public function getUnits() {
    return $this
      ->get('units')->value;
  }

  /**
   * {@inheritdoc}
   */
  public function setUnits($units) {
    return $this
      ->set('units', $units);
  }

  /**
   * {@inheritdoc}
   */
  public function isResponsive() {
    return $this
      ->get('responsive')->value;
  }

  /**
   * {@inheritdoc}
   */
  public function setResponsive($is_responsive) {
    return $this
      ->set('responsive', $is_responsive);
  }

  /**
   * {@inheritdoc}
   */
  public function isPlaylist() {
    return $this
      ->get('playlist')->value;
  }

  /**
   * {@inheritdoc}
   */
  public function setPlaylist($playlist) {
    return $this
      ->set('playlist', $playlist);
  }

  /**
   * {@inheritdoc}
   */
  public function getVersion() {
    return $this
      ->get('version')->value;
  }

  /**
   * Sets the version of the player.
   *
   * @param string $version
   *   The version of the player.
   *
   * @return \Drupal\brightcove\BrightcovePlayerInterface
   *   The called Brightcove Player.
   */
  protected function setVersion($version) {
    return $this
      ->set('version', $version);
  }

  /**
   * {@inheritdoc}
   */
  public static function baseFieldDefinitions(EntityTypeInterface $entity_type) {
    $fields['bcpid'] = BaseFieldDefinition::create('integer')
      ->setLabel(t('ID'))
      ->setDescription(t('The Drupal entity ID of the Brightcove Player.'))
      ->setReadOnly(TRUE);
    $fields['uuid'] = BaseFieldDefinition::create('uuid')
      ->setLabel(t('UUID'))
      ->setDescription(t('The Brightcove Player UUID.'))
      ->setReadOnly(TRUE);
    $fields['name'] = BaseFieldDefinition::create('string')
      ->setLabel(t('Player name'))
      ->setDescription(t('The name of the Brightcove Player.'));
    $fields['langcode'] = BaseFieldDefinition::create('language')
      ->setLabel(t('Language code'))
      ->setDescription(t('The language code for the Brightcove Player.'));
    $fields['api_client'] = BaseFieldDefinition::create('entity_reference')
      ->setLabel(t('API Client'))
      ->setDescription(t('API Client to use for the Player.'))
      ->setRequired(TRUE)
      ->setSetting('target_type', 'brightcove_api_client');
    $fields['uid'] = BaseFieldDefinition::create('entity_reference')
      ->setLabel(t('Authored by'))
      ->setDescription(t('The username of the Brightcove Playlist author.'))
      ->setSetting('target_type', 'user')
      ->setDefaultValueCallback('Drupal\\brightcove\\Entity\\BrightcovePlayer::getCurrentUserId')
      ->setTranslatable(TRUE);
    $fields['created'] = BaseFieldDefinition::create('created')
      ->setLabel(t('Created'))
      ->setDescription(t('The time that the Brightcove Player was created.'))
      ->setTranslatable(TRUE);
    $fields['changed'] = BaseFieldDefinition::create('changed')
      ->setLabel(t('Changed'))
      ->setDescription(t('The time that the Brightcove Player was last edited.'))
      ->setTranslatable(TRUE);
    $fields['player_id'] = BaseFieldDefinition::create('string')
      ->setLabel(t('Player ID'))
      ->setDescription(t('Unique Player ID assigned by Brightcove.'))
      ->setReadOnly(TRUE);
    $fields['adjusted'] = BaseFieldDefinition::create('boolean')
      ->setLabel(t('Adjusted'))
      ->setDescription(t('Indicates if player dimensions should be adjusted for playlist.'));
    $fields['height'] = BaseFieldDefinition::create('float')
      ->setLabel(t('Adjusted'))
      ->setDescription(t('The height of the player.'));
    $fields['width'] = BaseFieldDefinition::create('float')
      ->setLabel(t('Adjusted'))
      ->setDescription(t('The width of the player.'));
    $fields['units'] = BaseFieldDefinition::create('string')
      ->setLabel(t('Units'))
      ->setDescription(t('The units for the height and width.'))
      ->setDefaultValue('px');
    $fields['responsive'] = BaseFieldDefinition::create('boolean')
      ->setLabel(t('Responsive'))
      ->setDescription(t('Whether the player is responsive or not.'))
      ->setDefaultValue(FALSE);
    $fields['playlist'] = BaseFieldDefinition::create('boolean')
      ->setLabel(t('Playlist'))
      ->setDescription(t('Indicates if it is a single video player or playlist player.'))
      ->setDefaultValue(FALSE);
    $fields['version'] = BaseFieldDefinition::create('string')
      ->setLabel(t('Version'))
      ->setDescription(t('The version of the player.'));
    return $fields;
  }

  /**
   * Create or update an existing player from a Brightcove Player object.
   *
   * @param \Brightcove\Item\Player\Player $player
   *   Brightcove Player object.
   * @param \Drupal\Core\Entity\EntityStorageInterface $storage
   *   Player Entity storage.
   * @param int|null $api_client_id
   *   The ID of the BrightcoveAPIClient entity.
   *
   * @throws \Exception
   *   If BrightcoveAPIClient ID is missing when a new entity is being created.
   */
  public static function createOrUpdate(Player $player, EntityStorageInterface $storage, $api_client_id = NULL) {

    // Try to get an existing player.
    $existing_player = $storage
      ->getQuery()
      ->condition('player_id', $player
      ->getId())
      ->execute();
    $needs_save = FALSE;
    $branches = $player
      ->getBranches();
    $master = $branches
      ->getMaster();
    $configuration = $master
      ->getConfiguration();
    $studio_configuration = $configuration
      ->getStudioConfiguration();

    // Update existing player.
    if (!empty($existing_player)) {

      // Load Brightcove Player.

      /** @var BrightcovePlayer $player_entity */
      $player_entity = self::load(reset($existing_player));

      // Update player if it is changed on Brightcove.
      if ($player_entity
        ->getChangedTime() < strtotime($master
        ->getUpdatedAt())) {
        $needs_save = TRUE;

        // Save or update playlist if needed.
        $is_playlist = $configuration
          ->isPlaylist();
        if ($player_entity
          ->isPlaylist() != $is_playlist) {
          $player_entity
            ->setPlaylist($is_playlist);
        }

        // Save or update version if needed.
        $version = $configuration
          ->getPlayer()
          ->getTemplate()
          ->getVersion();
        if ($player_entity
          ->getVersion() != $version) {
          $player_entity
            ->setVersion($version);
        }

        // Set player studio configs if they are set.
        if (!empty($studio_configuration)) {
          $player_config = $studio_configuration
            ->getPlayer();

          // Save or update adjusted if needed.
          $adjusted = $player_config
            ->isAdjusted();
          if ($player_entity
            ->isAdjusted() != $adjusted) {
            $player_entity
              ->setAdjusted($adjusted);
          }

          // Save or update height if needed.
          $height = $player_config
            ->getHeight();
          if ($player_entity
            ->getHeight() != $height) {
            $player_entity
              ->setHeight($height);
          }

          // Save or update width if needed.
          $width = $player_config
            ->getWidth();
          if ($player_entity
            ->getWidth() != $width) {
            $player_entity
              ->setWidth($width);
          }

          // Save or update units if needed.
          $units = $player_config
            ->getUnits();
          if ($player_entity
            ->getUnits() != $units) {
            $player_entity
              ->setUnits($units);
          }

          // Save or update responsive if needed.
          $responsive = $player_config
            ->isResponsive();
          if ($player_entity
            ->isResponsive() != $responsive) {
            $player_entity
              ->setResponsive($responsive);
          }
        }
        else {

          // Remove studio configs if there is none.
          $player_entity
            ->setAdjusted(NULL);
          $player_entity
            ->setHeight(NULL);
          $player_entity
            ->setWidth(NULL);
          $player_entity
            ->setUnits(NULL);
          $player_entity
            ->setResponsive(NULL);
        }
      }
    }
    else {

      // Make sure we got an api client id when a new player is being created.
      if (is_null($api_client_id)) {
        throw new \Exception(t('To create a new BrightcovePlayer entity, the api_client_id must be given.'));
      }

      // Create new Brightcove player entity.
      $values = [
        'player_id' => $player
          ->getId(),
        'api_client' => [
          'target_id' => $api_client_id,
        ],
        'created' => strtotime($player
          ->getCreatedAt()),
        'playlist' => $configuration
          ->isPlaylist(),
        'version' => $configuration
          ->getPlayer()
          ->getTemplate()
          ->getVersion(),
      ];

      // Set player settings.
      if (!empty($studio_configuration)) {
        $player_config = $studio_configuration
          ->getPlayer();
        if ($player_config) {
          $values['adjusted'] = $player_config
            ->isAdjusted();
          $values['height'] = $player_config
            ->getHeight();
          $values['width'] = $player_config
            ->getWidth();
          $values['units'] = $player_config
            ->getUnits();
          $values['responsive'] = $player_config
            ->isResponsive();
        }
      }
      $player_entity = self::create($values);
      $needs_save = TRUE;
    }

    // Save entity only if it is being created or updated.
    if ($needs_save) {

      // Save or update changed time.
      $player_entity
        ->setChangedTime(strtotime($master
        ->getUpdatedAt()));

      // Save or update Name field if needed.
      if ($player_entity
        ->getName() != ($name = $player
        ->getName())) {
        $player_entity
          ->setName($name);
      }
      $player_entity
        ->save();
    }
  }

  /**
   * Helper function to load entity by the Brightcove player ID.
   *
   * @param string $player_id
   *   The Brightcove ID of the player.
   *
   * @return \Drupal\brightcove\Entity\BrightcovePlayer
   *   The loaded BrightcovePlayer.
   */
  public static function loadByPlayerId($player_id) {
    $eq = \Drupal::entityQuery('brightcove_player');
    $player = $eq
      ->condition('player_id', $player_id)
      ->execute();
    return self::load(reset($player));
  }

  /**
   * Returns a list of players.
   *
   * @param null|array $api_client
   *   The API Client for which the players should be returned. If it's NULL,
   *   then only the default player will be returned.
   * @param bool $use_entity_id
   *   Whether to use the Entity's ID or Brightcove's ID for the player's key.
   *
   * @return array
   *   A list of player names keyed by their Brightcove ID or by the Entity ID
   *   if $use_entity_id is set.
   */
  public static function getList($api_client, $use_entity_id = FALSE) {

    // If use entity IDs set to true then don't add the default player
    // to the list, because it could be a non-existing Entity.
    if ($use_entity_id) {
      $players = [];
    }
    else {
      $players = [
        BrightcoveAPIClient::DEFAULT_PLAYER => t('Brightcove Default Player'),
      ];
    }
    if (!$api_client) {
      return $players;
    }

    // Collect players referencing a given api client.
    $eq = \Drupal::entityQuery('brightcove_player');
    $eq
      ->condition('api_client', $api_client);
    $player_ids = $eq
      ->execute();

    /** @var \Drupal\brightcove\Entity\BrightcovePlayer $player */
    foreach (self::loadMultiple($player_ids) as $player) {
      $players[$use_entity_id ? $player
        ->id() : $player
        ->getPlayerId()] = $player
        ->getName();
    }
    return $players;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
BrightcoveCmsEntity::getApiClient public function Returns the Brightcove Client API target ID. Overrides BrightcoveCMSEntityInterface::getApiClient
BrightcoveCmsEntity::getCreatedTime public function Gets the Brightcove CMS entity creation timestamp. Overrides BrightcoveCMSEntityInterface::getCreatedTime
BrightcoveCmsEntity::getCurrentUserId public static function Default value callback for 'uid' base field definition.
BrightcoveCmsEntity::getDescription public function Returns the description. Overrides BrightcoveCMSEntityInterface::getDescription
BrightcoveCmsEntity::getName public function Gets the Brightcove CMS entity name. Overrides BrightcoveCMSEntityInterface::getName
BrightcoveCmsEntity::getOwner public function Returns the entity owner's user entity. Overrides EntityOwnerInterface::getOwner
BrightcoveCmsEntity::getOwnerId public function Returns the entity owner's user ID. Overrides EntityOwnerInterface::getOwnerId
BrightcoveCmsEntity::loadMultipleByApiClient public static function Load multiple CMS Entity for the given api client.
BrightcoveCmsEntity::preCreate public static function Changes the values of an entity before it is created. Overrides EntityBase::preCreate
BrightcoveCmsEntity::preSave public function Acts on an entity before the presave hook is invoked. Overrides ContentEntityBase::preSave
BrightcoveCmsEntity::setApiClient public function Sets the Brightcove Client API target ID. Overrides BrightcoveCMSEntityInterface::setApiClient
BrightcoveCmsEntity::setCreatedTime public function Sets the Brightcove CMS entity creation timestamp. Overrides BrightcoveCMSEntityInterface::setCreatedTime
BrightcoveCmsEntity::setDescription public function Sets the CMS entity's description. Overrides BrightcoveCMSEntityInterface::setDescription
BrightcoveCmsEntity::setName public function Sets the Brightcove CMS entity name. Overrides BrightcoveCMSEntityInterface::setName
BrightcoveCmsEntity::setOwner public function Sets the entity owner's user entity. Overrides EntityOwnerInterface::setOwner
BrightcoveCmsEntity::setOwnerId public function Sets the entity owner's user ID. Overrides EntityOwnerInterface::setOwnerId
BrightcovePlayer::baseFieldDefinitions public static function Provides base field definitions for an entity type. Overrides ContentEntityBase::baseFieldDefinitions
BrightcovePlayer::createOrUpdate public static function Create or update an existing player from a Brightcove Player object.
BrightcovePlayer::getHeight public function Returns the height of the player. Overrides BrightcovePlayerInterface::getHeight
BrightcovePlayer::getList public static function Returns a list of players.
BrightcovePlayer::getPlayerId public function Returns the Brightcove Player ID. Overrides BrightcovePlayerInterface::getPlayerId
BrightcovePlayer::getUnits public function Returns the units for the height and width. Overrides BrightcovePlayerInterface::getUnits
BrightcovePlayer::getVersion public function Gets the version of the player. Overrides BrightcovePlayerInterface::getVersion
BrightcovePlayer::getWidth public function Returns the width of the player. Overrides BrightcovePlayerInterface::getWidth
BrightcovePlayer::isAdjusted public function Returns whether the player is adjusted for the playlist or not. Overrides BrightcovePlayerInterface::isAdjusted
BrightcovePlayer::isPlaylist public function Returns whether the player is a playlist player or a single video player. Overrides BrightcovePlayerInterface::isPlaylist
BrightcovePlayer::isResponsive public function Returns whether if the player is responsive or not. Overrides BrightcovePlayerInterface::isResponsive
BrightcovePlayer::loadByPlayerId public static function Helper function to load entity by the Brightcove player ID.
BrightcovePlayer::setAdjusted public function Sets the Player as adjusted. Overrides BrightcovePlayerInterface::setAdjusted
BrightcovePlayer::setHeight public function Sets the height of the player. Overrides BrightcovePlayerInterface::setHeight
BrightcovePlayer::setPlayerId public function Sets The Brightcove Player ID. Overrides BrightcovePlayerInterface::setPlayerId
BrightcovePlayer::setPlaylist public function Sets if the player is a playlist player or single video player. Overrides BrightcovePlayerInterface::setPlaylist
BrightcovePlayer::setResponsive public function Sets the responsive indicator. Overrides BrightcovePlayerInterface::setResponsive
BrightcovePlayer::setUnits public function Sets the units for the height and width. Overrides BrightcovePlayerInterface::setUnits
BrightcovePlayer::setVersion protected function Sets the version of the player.
BrightcovePlayer::setWidth public function Sets the width of the player. Overrides BrightcovePlayerInterface::setWidth
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.
ContentEntityBase::$activeLangcode protected property Language code identifying the entity active language.
ContentEntityBase::$defaultLangcode protected property Local cache for the default language code.
ContentEntityBase::$defaultLangcodeKey protected property The default langcode entity key.
ContentEntityBase::$enforceRevisionTranslationAffected protected property Whether the revision translation affected flag has been enforced.
ContentEntityBase::$entityKeys protected property Holds untranslatable entity keys such as the ID, bundle, and revision ID.
ContentEntityBase::$fieldDefinitions protected property Local cache for field definitions.
ContentEntityBase::$fields protected property The array of fields, each being an instance of FieldItemListInterface.
ContentEntityBase::$fieldsToSkipFromTranslationChangesCheck protected static property Local cache for fields to skip from the checking for translation changes.
ContentEntityBase::$isDefaultRevision protected property Indicates whether this is the default revision.
ContentEntityBase::$langcodeKey protected property The language entity key.
ContentEntityBase::$languages protected property Local cache for the available language objects.
ContentEntityBase::$loadedRevisionId protected property The loaded revision ID before the new revision was set.
ContentEntityBase::$newRevision protected property Boolean indicating whether a new revision should be created on save.
ContentEntityBase::$revisionTranslationAffectedKey protected property The revision translation affected entity key.
ContentEntityBase::$translatableEntityKeys protected property Holds translatable entity keys such as the label.
ContentEntityBase::$translationInitialize protected property A flag indicating whether a translation object is being initialized.
ContentEntityBase::$translations protected property An array of entity translation metadata.
ContentEntityBase::$validated protected property Whether entity validation was performed.
ContentEntityBase::$validationRequired protected property Whether entity validation is required before saving the entity.
ContentEntityBase::$values protected property The plain data values of the contained fields.
ContentEntityBase::access public function Checks data value access. Overrides EntityBase::access 1
ContentEntityBase::addTranslation public function Adds a new translation to the translatable object. Overrides TranslatableInterface::addTranslation
ContentEntityBase::bundle public function Gets the bundle of the entity. Overrides EntityBase::bundle
ContentEntityBase::bundleFieldDefinitions public static function Provides field definitions for a specific bundle. Overrides FieldableEntityInterface::bundleFieldDefinitions 4
ContentEntityBase::clearTranslationCache protected function Clear entity translation object cache to remove stale references.
ContentEntityBase::createDuplicate public function Creates a duplicate of the entity. Overrides EntityBase::createDuplicate 1
ContentEntityBase::get public function Gets a field item list. Overrides FieldableEntityInterface::get
ContentEntityBase::getEntityKey protected function Gets the value of the given entity key, if defined. 1
ContentEntityBase::getFieldDefinition public function Gets the definition of a contained field. Overrides FieldableEntityInterface::getFieldDefinition
ContentEntityBase::getFieldDefinitions public function Gets an array of field definitions of all contained fields. Overrides FieldableEntityInterface::getFieldDefinitions
ContentEntityBase::getFields public function Gets an array of all field item lists. Overrides FieldableEntityInterface::getFields
ContentEntityBase::getFieldsToSkipFromTranslationChangesCheck protected function Returns an array of field names to skip in ::hasTranslationChanges. 1
ContentEntityBase::getIterator public function
ContentEntityBase::getLanguages protected function
ContentEntityBase::getLoadedRevisionId public function Gets the loaded Revision ID of the entity. Overrides RevisionableInterface::getLoadedRevisionId
ContentEntityBase::getRevisionId public function Gets the revision identifier of the entity. Overrides RevisionableInterface::getRevisionId
ContentEntityBase::getTranslatableFields public function Gets an array of field item lists for translatable fields. Overrides FieldableEntityInterface::getTranslatableFields
ContentEntityBase::getTranslatedField protected function Gets a translated field.
ContentEntityBase::getTranslation public function Gets a translation of the data. Overrides TranslatableInterface::getTranslation
ContentEntityBase::getTranslationLanguages public function Returns the languages the data is translated to. Overrides TranslatableInterface::getTranslationLanguages
ContentEntityBase::getTranslationStatus public function Returns the translation status. Overrides TranslationStatusInterface::getTranslationStatus
ContentEntityBase::getUntranslated public function Returns the translatable object referring to the original language. Overrides TranslatableInterface::getUntranslated
ContentEntityBase::hasField public function Determines whether the entity has a field with the given name. Overrides FieldableEntityInterface::hasField
ContentEntityBase::hasTranslation public function Checks there is a translation for the given language code. Overrides TranslatableInterface::hasTranslation
ContentEntityBase::hasTranslationChanges public function Determines if the current translation of the entity has unsaved changes. Overrides TranslatableInterface::hasTranslationChanges
ContentEntityBase::id public function Gets the identifier. Overrides EntityBase::id
ContentEntityBase::initializeTranslation protected function Instantiates a translation object for an existing translation.
ContentEntityBase::isDefaultRevision public function Checks if this entity is the default revision. Overrides RevisionableInterface::isDefaultRevision
ContentEntityBase::isDefaultTranslation public function Checks whether the translation is the default one. Overrides TranslatableInterface::isDefaultTranslation
ContentEntityBase::isDefaultTranslationAffectedOnly public function Checks if untranslatable fields should affect only the default translation. Overrides TranslatableRevisionableInterface::isDefaultTranslationAffectedOnly
ContentEntityBase::isLatestRevision public function Checks if this entity is the latest revision. Overrides RevisionableInterface::isLatestRevision
ContentEntityBase::isLatestTranslationAffectedRevision public function Checks whether this is the latest revision affecting this translation. Overrides TranslatableRevisionableInterface::isLatestTranslationAffectedRevision
ContentEntityBase::isNewRevision public function Determines whether a new revision should be created on save. Overrides RevisionableInterface::isNewRevision
ContentEntityBase::isNewTranslation public function Checks whether the translation is new. Overrides TranslatableInterface::isNewTranslation
ContentEntityBase::isRevisionTranslationAffected public function Checks whether the current translation is affected by the current revision. Overrides TranslatableRevisionableInterface::isRevisionTranslationAffected
ContentEntityBase::isRevisionTranslationAffectedEnforced public function Checks if the revision translation affected flag value has been enforced. Overrides TranslatableRevisionableInterface::isRevisionTranslationAffectedEnforced
ContentEntityBase::isTranslatable public function Returns the translation support status. Overrides TranslatableInterface::isTranslatable
ContentEntityBase::isValidationRequired public function Checks whether entity validation is required before saving the entity. Overrides FieldableEntityInterface::isValidationRequired
ContentEntityBase::label public function Gets the label of the entity. Overrides EntityBase::label 6
ContentEntityBase::language public function Gets the language of the entity. Overrides EntityBase::language
ContentEntityBase::onChange public function Reacts to changes to a field. Overrides FieldableEntityInterface::onChange
ContentEntityBase::postCreate public function Acts on a created entity before hooks are invoked. Overrides EntityBase::postCreate
ContentEntityBase::postSave public function Acts on a saved entity before the insert or update hook is invoked. Overrides EntityBase::postSave 9
ContentEntityBase::preSaveRevision public function Acts on a revision before it gets saved. Overrides RevisionableInterface::preSaveRevision 3
ContentEntityBase::referencedEntities public function Gets a list of entities referenced by this entity. Overrides EntityBase::referencedEntities 1
ContentEntityBase::removeTranslation public function Removes the translation identified by the given language code. Overrides TranslatableInterface::removeTranslation
ContentEntityBase::set public function Sets a field value. Overrides FieldableEntityInterface::set
ContentEntityBase::setDefaultLangcode protected function Populates the local cache for the default language code.
ContentEntityBase::setNewRevision public function Enforces an entity to be saved as a new revision. Overrides RevisionableInterface::setNewRevision
ContentEntityBase::setRevisionTranslationAffected public function Marks the current revision translation as affected. Overrides TranslatableRevisionableInterface::setRevisionTranslationAffected
ContentEntityBase::setRevisionTranslationAffectedEnforced public function Enforces the revision translation affected flag value. Overrides TranslatableRevisionableInterface::setRevisionTranslationAffectedEnforced
ContentEntityBase::setValidationRequired public function Sets whether entity validation is required before saving the entity. Overrides FieldableEntityInterface::setValidationRequired
ContentEntityBase::toArray public function Gets an array of all property values. Overrides EntityBase::toArray
ContentEntityBase::updateFieldLangcodes protected function Updates language for already instantiated fields.
ContentEntityBase::updateLoadedRevisionId public function Updates the loaded Revision ID with the revision ID. Overrides RevisionableInterface::updateLoadedRevisionId
ContentEntityBase::updateOriginalValues public function Updates the original values with the interim changes.
ContentEntityBase::uuid public function Gets the entity UUID (Universally Unique Identifier). Overrides EntityBase::uuid
ContentEntityBase::validate public function Validates the currently set values. Overrides FieldableEntityInterface::validate 1
ContentEntityBase::wasDefaultRevision public function Checks whether the entity object was a default revision when it was saved. Overrides RevisionableInterface::wasDefaultRevision
ContentEntityBase::__clone public function Magic method: Implements a deep clone.
ContentEntityBase::__construct public function Constructs an Entity object. Overrides EntityBase::__construct
ContentEntityBase::__get public function Implements the magic method for getting object properties.
ContentEntityBase::__isset public function Implements the magic method for isset().
ContentEntityBase::__set public function Implements the magic method for setting object properties.
ContentEntityBase::__sleep public function Overrides EntityBase::__sleep
ContentEntityBase::__unset public function Implements the magic method for unset().
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function Aliased as: traitSleep 2
DependencySerializationTrait::__wakeup public function 2
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::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::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::getCacheTagsToInvalidate public function Returns the cache tags that should be used to invalidate caches. Overrides EntityInterface::getCacheTagsToInvalidate 4
EntityBase::getConfigDependencyKey public function Gets the key that is used to store configuration dependencies. Overrides EntityInterface::getConfigDependencyKey
EntityBase::getConfigDependencyName public function Gets the configuration dependency name. Overrides EntityInterface::getConfigDependencyName 1
EntityBase::getConfigTarget public function Gets the configuration target identifier for the entity. Overrides EntityInterface::getConfigTarget 1
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::getOriginalId public function Gets the original ID. Overrides EntityInterface::getOriginalId 1
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::invalidateTagsOnDelete protected static function Invalidates an entity's cache tags upon delete. 1
EntityBase::invalidateTagsOnSave protected function Invalidates an entity's cache tags upon save. 1
EntityBase::isNew public function Determines whether the entity is new. Overrides EntityInterface::isNew 2
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::postDelete public static function Acts on deleted entities before the delete hook is invoked. Overrides EntityInterface::postDelete 18
EntityBase::postLoad public static function Acts on loaded entities. Overrides EntityInterface::postLoad 2
EntityBase::preDelete public static function Acts on entities before they are deleted and before hooks are invoked. Overrides EntityInterface::preDelete 6
EntityBase::save public function Saves an entity permanently. Overrides EntityInterface::save 3
EntityBase::setOriginalId public function Sets the original ID. Overrides EntityInterface::setOriginalId 1
EntityBase::toLink public function Generates the HTML for a link to this entity. Overrides EntityInterface::toLink
EntityBase::toUrl public function Gets the URL object for the entity. Overrides EntityInterface::toUrl 2
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::uuidGenerator protected function Gets the UUID generator.
EntityChangedFieldsTrait::$changedFields protected property Changed fields.
EntityChangedFieldsTrait::$hasChangedField protected property Has changed field or not.
EntityChangedFieldsTrait::checkUpdatedFields public function Check for updated fields.
EntityChangedFieldsTrait::getGetterName public function Get getter method from the name of the field.
EntityChangedFieldsTrait::hasChangedField public function Checked if the Entity has a changed field or not.
EntityChangedFieldsTrait::isFieldChanged public function Returns whether the field is changed or not.
EntityChangedTrait::getChangedTime public function Gets the timestamp of the last entity change for the current translation.
EntityChangedTrait::getChangedTimeAcrossTranslations public function Returns the timestamp of the last entity change across all translations.
EntityChangedTrait::setChangedTime public function Sets the timestamp of the last entity change for the current translation.
EntityChangesDetectionTrait::getFieldsToSkipFromTranslationChangesCheck protected function Returns an array of field names to skip when checking for changes. Aliased as: traitGetFieldsToSkipFromTranslationChangesCheck
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
TranslationStatusInterface::TRANSLATION_CREATED constant Status code identifying a newly created translation.
TranslationStatusInterface::TRANSLATION_EXISTING constant Status code identifying an existing translation.
TranslationStatusInterface::TRANSLATION_REMOVED constant Status code identifying a removed translation.