You are here

class InstagramAccount in Instagram Feeds 8

Defines the instagram_account entity class.

Plugin annotation


@ContentEntityType(
  id = "instagram_account",
  label = @Translation("Instagram Account"),
  label_collection = @Translation("Instagram Accounts"),
  label_singular = @Translation("Instagram account"),
  label_plural = @Translation("Instagram accounts"),
  label_count = @PluralTranslation(
    singular = "@count Instagram account",
    plural = "@count Instagram accounts"
  ),
  bundle_label = @Translation("Instagram Account"),
  handlers = {
    "form" = {
      "default" = "Drupal\instagram_feeds\Form\InstagramAccountForm",
      "delete" = "Drupal\instagram_feeds\Form\InstagramAccountDeleteForm",
      "edit" = "Drupal\instagram_feeds\Form\InstagramAccountForm"
    },
    "view_builder" = "Drupal\Core\Entity\EntityViewBuilder",
    "views_data" = "Drupal\views\EntityViewsData",
    "list_builder" = "Drupal\instagram_feeds\InstagramAccountListBuilder"
  },
  admin_permission = "administer instagram_feeds",
  base_table = "instagram_account",
  fieldable = TRUE,
  field_ui_base_route = "entity.instagram_account.collection",
  entity_keys = {
    "id" = "iid",
    "label" = "account",
    "uuid" = "uuid",
    "published" = "status",
    "status" = "status",
    "uid" = "uid",
    "cron_import_limit" = "cron_import_limit",
    "media_bundle" = "media_bundle",
    "token" = "token",
    "token_expiration" = "token_expiration"
  },
  links = {
    "add-form" = "/admin/config/media/instagram_feeds/add",
    "canonical" = "/admin/config/media/instagram_feeds/manage/{instagram_account}",
    "collection" = "/admin/config/media/instagram_feed",
    "delete-form" = "/admin/config/media/instagram_feeds/manage/{instagram_account}/delete",
    "edit-form" = "/admin/config/media/instagram_feeds/manage/{instagram_account}/edit"
  }
)

Hierarchy

Expanded class hierarchy of InstagramAccount

File

src/Entity/InstagramAccount.php, line 64

Namespace

Drupal\instagram_feeds\Entity
View source
class InstagramAccount extends ContentEntityBase implements InstagramAccountInterface {
  use EntityPublishedTrait;

  /**
   * {@inheritdoc}
   */
  public static function baseFieldDefinitions(EntityTypeInterface $entity_type) {
    $fields = [];
    $fields['iid'] = BaseFieldDefinition::create('string')
      ->setLabel(new TranslatableMarkup('Instagram Account ID'))
      ->setSetting('max_length', 32)
      ->addConstraint('UniqueField');
    $fields['uuid'] = BaseFieldDefinition::create('uuid')
      ->setLabel(new TranslatableMarkup('UUID'))
      ->setReadOnly(TRUE);
    $fields['status'] = BaseFieldDefinition::create('boolean')
      ->setLabel(new TranslatableMarkup('Published'))
      ->setDefaultValue(TRUE);
    $fields['account'] = BaseFieldDefinition::create('string')
      ->setLabel(new TranslatableMarkup('Instagram Username'))
      ->setDescription(t('The Instagram Account unique username.'))
      ->setSetting('max_length', 30)
      ->addConstraint('UniqueField');
    $fields['cron_import_limit'] = BaseFieldDefinition::create('integer')
      ->setLabel(new TranslatableMarkup('Cron Import Limit'))
      ->setDefaultValue(10)
      ->setSetting('min', 1)
      ->setSetting('max', 25);
    $allowed_media_types = static::getInstagramMediaTypes();
    $fields['media_bundle'] = BaseFieldDefinition::create('list_string')
      ->setLabel(new TranslatableMarkup('Media Bundle'))
      ->setSetting('max_length', 32)
      ->setSetting('allowed_values', $allowed_media_types)
      ->setDefaultValue(array_shift($allowed_media_types));
    $fields['token'] = BaseFieldDefinition::create('string')
      ->setLabel(new TranslatableMarkup('Instagram API Token'))
      ->setSetting('max_length', 255);
    $fields['token_expiration'] = BaseFieldDefinition::create('timestamp')
      ->setLabel(new TranslatableMarkup('Instagram Token Expiration Date'))
      ->setReadOnly(TRUE);
    $fields['last_import'] = BaseFieldDefinition::create('timestamp')
      ->setLabel(new TranslatableMarkup('Last Import Date'))
      ->setReadOnly(TRUE);
    $fields['uid'] = BaseFieldDefinition::create('entity_reference')
      ->setLabel(new TranslatableMarkup('Authored by'))
      ->setDescription(new TranslatableMarkup('The username of the author.'))
      ->setSetting('target_type', 'user')
      ->setDefaultValueCallback(self::class . '::getCurrentUserId');
    $weight = -1 - count($fields) * 5;

    /** @var \Drupal\Core\Field\BaseFieldDefinition $field */
    foreach ($fields as $id => $field) {
      $view_settings = $form_settings = [
        'weight' => $weight,
      ];
      if ($id == 'uid') {
        $view_settings['type'] = 'author';
        $form_settings += [
          'type' => 'entity_reference_autocomplete',
          'settings' => [
            'match_operator' => 'CONTAINS',
            'size' => '60',
            'placeholder' => '',
          ],
        ];
      }
      $field
        ->setDisplayOptions('view', $view_settings);
      if ($id != 'last_import') {
        $field
          ->setDisplayOptions('form', $form_settings);
        $field
          ->setDisplayConfigurable('form', TRUE);
      }
      $weight += 5;
      if ($id != 'token') {
        $field
          ->setDisplayConfigurable('view', TRUE);
      }
      if ($id != 'status') {
        $field
          ->setRequired(TRUE);
      }
    }
    return $fields;
  }

  /**
   * Default value callback for 'uid' base field definition.
   *
   * @see ::baseFieldDefinitions()
   *
   * @return array
   *   An array of default values.
   */
  public static function getCurrentUserId() {
    return [
      \Drupal::currentUser()
        ->id(),
    ];
  }

  /**
   * Gets Media types with Instagram source.
   *
   * @return array
   *   Media Types options for Select form element.
   */
  protected static function getInstagramMediaTypes() : array {
    $options = [];
    $media_types = \Drupal::entityTypeManager()
      ->getStorage('media_type')
      ->loadMultiple();
    foreach ($media_types as $media_type) {

      /** @var \Drupal\media\MediaTypeInterface $media_type */
      if (in_array($media_type
        ->getSource()
        ->getPluginId(), [
        'instagram',
        'image',
      ])) {
        $options[$media_type
          ->id()] = $media_type
          ->label();
      }
    }
    return $options;
  }

  /**
   * {@inheritdoc}
   */
  public function tokenIsValid() : bool {
    $expires_in = $this
      ->get('token_expiration')
      ->isEmpty() ? [
      0,
    ] : $this
      ->get('token_expiration')
      ->first()
      ->getValue();
    return !$this
      ->get('token')
      ->isEmpty() && \Drupal::time()
      ->getRequestTime() < (int) reset($expires_in);
  }

  /**
   * {@inheritdoc}
   */
  public function getToken($client_id = '', $client_secret = '', $code = '', $save = FALSE) : string {

    // Refresh token in any case if $code exists.
    if (!empty($code) && !empty($client_id) && !empty($client_secret)) {
      try {
        $this
          ->setNewToken($client_id, $client_secret, $code, $save);
      } catch (\Exception $e) {
        \Drupal::messenger()
          ->addError($e
          ->getMessage());
      }
    }
    return $this
      ->tokenIsValid() ? $this
      ->get('token')
      ->first()
      ->getString() : '';
  }
  public function getTokenExpirationTime() : int {
    return (int) ($this
      ->get('token_expiration')
      ->isEmpty() ? 0 : $this
      ->get('token_expiration')
      ->getString());
  }

  /**
   * Obtains short-lived token and exchanges it to long-lived one.
   *
   * @param string $client_id
   *   Instagram Client (App) ID.
   * @param string $client_secret
   *   Instagram Client (App) Secret.
   * @param string $code
   *   Instagram Auth code.
   * @param bool $save
   *   Save entity or not after token has been refreshed successfully.
   *
   * @return bool
   *   TRUE if success, FALSE otherwise.
   */
  protected function setNewToken($client_id, $client_secret, $code, $save = FALSE) : bool {
    $httpClient = \Drupal::httpClient();

    // Obtain short-live token (valid 24 hours).
    $response = $httpClient
      ->post(self::INSTAGRAM_API_ENDPOINT . '/oauth/access_token', [
      'form_params' => [
        'client_id' => $client_id,
        'client_secret' => $client_secret,
        'grant_type' => 'authorization_code',
        'redirect_uri' => Url::fromRoute('entity.instagram_account.add_form')
          ->setAbsolute()
          ->toString(),
        'code' => $code,
      ],
    ]);
    $body = $this
      ->extractInstagramData($response);
    $this
      ->set('iid', $body['user_id']);

    // Exchange short-term token to long-lived one (valid for 60 days).
    $response = $httpClient
      ->get(self::INSTAGRAM_GRAPH_ENDPOINT . '/access_token?' . http_build_query([
      'grant_type' => 'ig_exchange_token',
      'client_secret' => $client_secret,
      'access_token' => $body['access_token'],
    ]));
    $body = $this
      ->extractInstagramData($response);
    $this
      ->set('token_expiration', $body['expires_in'] + \Drupal::time()
      ->getRequestTime());
    $this
      ->set('token', $body['access_token']);
    if (!$this
      ->isNew() && $save) {
      $this
        ->save();
    }
    return TRUE;
  }

  /**
   * Extracts Instagram data from Guzzle response.
   *
   * @param \GuzzleHttp\Psr7\Response $response
   *   Guzzle response.
   *
   * @return array
   *   Extracted Instagram data.
   *
   * @throws \Exception
   */
  protected function extractInstagramData($response) {
    $body = Json::decode($response
      ->getBody()
      ->getContents());
    if ($response
      ->getStatusCode() !== 200) {
      throw new \Exception($body['error_message'], $response
        ->getStatusCode());
    }
    return $body;
  }

  /**
   * {@inheritdoc}
   */
  public function refreshToken(Client $http_client, $save = FALSE) : bool {
    $time = \Drupal::time();

    // Token can be refreshed only once per day. It lives 60 days. Expired
    // token cannot be refreshed anymore. 60 days - 1 day = 59 days.
    if (!$this
      ->tokenIsValid() || (int) $this
      ->get('token_expiration')
      ->first()
      ->getString() - 5097600 >= $time
      ->getCurrentTime()) {
      return FALSE;
    }
    try {
      $response = $http_client
        ->get(self::INSTAGRAM_GRAPH_ENDPOINT . '/refresh_access_token?' . http_build_query([
        'grant_type' => 'ig_refresh_token',
        'access_token' => $this
          ->getToken(),
      ]));
      $body = $this
        ->extractInstagramData($response);
      $this
        ->set('token', $body['access_token']);
      $this
        ->set('token_expiration', $body['expires_in'] + $time
        ->getCurrentTime());
    } catch (\Exception $e) {
      \Drupal::logger('instagram_feeds')
        ->error('An error Occurred when refreshing Instagram token for account @name: <br />@error', [
        '@name' => $this
          ->label(),
        '@error' => $e
          ->getMessage(),
      ]);
    }
    if (!$this
      ->isNew() && $save) {
      return (bool) $this
        ->save();
    }
    return TRUE;
  }

  /**
   * {@inheritdoc}
   */
  public function getOauthUrl($client_id) : Url {
    $url = self::INSTAGRAM_API_ENDPOINT . '/oauth/authorize?' . http_build_query([
      'client_id' => $client_id,
      'redirect_uri' => Url::fromRoute('entity.instagram_account.add_form')
        ->setAbsolute()
        ->toString(),
      'scope' => 'user_profile,user_media',
      'response_type' => 'code',
    ]);
    return Url::fromUri($url);
  }

  /**
   * {@inheritdoc}
   */
  public function getAccountName($save = FALSE) : string {
    if ($this
      ->get('account')
      ->isEmpty()) {
      $token = $this
        ->getToken();
      if (!$token) {
        return '';
      }
      $response = \Drupal::httpClient()
        ->get(self::INSTAGRAM_GRAPH_ENDPOINT . '/me?' . http_build_query([
        'fields' => 'username',
        'access_token' => $token,
      ]));
      $body = $this
        ->extractInstagramData($response);
      $this
        ->set('account', $body['username']);
      if (!$this
        ->isNew() && $save) {
        $this
          ->save();
      }
    }
    return $this
      ->get('account')
      ->first()
      ->getString();
  }

  /**
   * {@inheritdoc}
   */
  public function getLastImportTimestamp() : int {
    return (int) ($this
      ->get('last_import')
      ->getString() ?? 0);
  }

  /**
   * {@inheritdoc}
   */
  public function setLastImportTimestamp(int $timestamp = 0) {
    return $this
      ->set('last_import', $timestamp, FALSE);
  }

  /**
   * {@inheritdoc}
   */
  public function getOwner() {
    return $this
      ->get('uid')
      ->first()->entity;
  }

  /**
   * {@inheritdoc}
   */
  public function getOwnerId() {
    return $this
      ->getEntityKey('uid');
  }

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

  /**
   * {@inheritdoc}
   */
  public function setOwner(UserInterface $account) {
    $this
      ->set('uid', $account
      ->id());
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function getCronLimit() : int {
    return (int) $this
      ->getEntityKey('cron_import_limit');
  }

  /**
   * {@inheritdoc}
   */
  public function getMediaType() : string {
    return $this
      ->getEntityKey('media_bundle');
  }

}

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.
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 2
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 5
ContentEntityBase::preSave public function Acts on an entity before the presave hook is invoked. Overrides EntityBase::preSave 5
ContentEntityBase::preSaveRevision public function Acts on a revision before it gets saved. Overrides RevisionableInterface::preSaveRevision 2
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
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 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
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::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::getCacheTagsToInvalidate public function Returns the cache tags that should be used to invalidate caches. Overrides EntityInterface::getCacheTagsToInvalidate 2
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::link public function Deprecated way of generating a link to the entity. See toLink(). Overrides EntityInterface::link 1
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 16
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::preDelete public static function Acts on entities before they are deleted and before hooks are invoked. Overrides EntityInterface::preDelete 4
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::url public function Gets the public URL for this entity. Overrides EntityInterface::url 2
EntityBase::urlInfo public function Gets the URL object for the entity. Overrides EntityInterface::urlInfo 1
EntityBase::urlRouteParameters protected function Gets an array of placeholders for this entity. 2
EntityBase::uuidGenerator protected function Gets the UUID generator.
EntityChangesDetectionTrait::getFieldsToSkipFromTranslationChangesCheck protected function Returns an array of field names to skip when checking for changes. Aliased as: traitGetFieldsToSkipFromTranslationChangesCheck
EntityPublishedTrait::isPublished public function
EntityPublishedTrait::publishedBaseFieldDefinitions public static function Returns an array of base field definitions for publishing status.
EntityPublishedTrait::setPublished public function
EntityPublishedTrait::setUnpublished public function
InstagramAccount::baseFieldDefinitions public static function Provides base field definitions for an entity type. Overrides ContentEntityBase::baseFieldDefinitions
InstagramAccount::extractInstagramData protected function Extracts Instagram data from Guzzle response.
InstagramAccount::getAccountName public function Gets Instagram account username. Overrides InstagramAccountInterface::getAccountName
InstagramAccount::getCronLimit public function Gets Cron limit value. Overrides InstagramAccountInterface::getCronLimit
InstagramAccount::getCurrentUserId public static function Default value callback for 'uid' base field definition.
InstagramAccount::getInstagramMediaTypes protected static function Gets Media types with Instagram source.
InstagramAccount::getLastImportTimestamp public function Gets the last successfully imported Instagram post timestamp. Overrides InstagramAccountInterface::getLastImportTimestamp
InstagramAccount::getMediaType public function Gets type of media entity to create Instagram posts. Overrides InstagramAccountInterface::getMediaType
InstagramAccount::getOauthUrl public function Gets URL to Instagram Auth form. Overrides InstagramAccountInterface::getOauthUrl
InstagramAccount::getOwner public function Returns the entity owner's user entity. Overrides EntityOwnerInterface::getOwner
InstagramAccount::getOwnerId public function Returns the entity owner's user ID. Overrides EntityOwnerInterface::getOwnerId
InstagramAccount::getToken public function Gets the Instagram long-lived token. Overrides InstagramAccountInterface::getToken
InstagramAccount::getTokenExpirationTime public function Gets the Instagram long-lived token expiration time. Overrides InstagramAccountInterface::getTokenExpirationTime
InstagramAccount::refreshToken public function Tries to refresh long-lived Instagram access token. Overrides InstagramAccountInterface::refreshToken
InstagramAccount::setLastImportTimestamp public function Sets the last successfully imported Instagram post timestamp. Overrides InstagramAccountInterface::setLastImportTimestamp
InstagramAccount::setNewToken protected function Obtains short-lived token and exchanges it to long-lived one.
InstagramAccount::setOwner public function Sets the entity owner's user entity. Overrides EntityOwnerInterface::setOwner
InstagramAccount::setOwnerId public function Sets the entity owner's user ID. Overrides EntityOwnerInterface::setOwnerId
InstagramAccount::tokenIsValid public function Checks if Instagram access token exists and hasn't expired. Overrides InstagramAccountInterface::tokenIsValid
InstagramAccountInterface::INSTAGRAM_API_ENDPOINT constant
InstagramAccountInterface::INSTAGRAM_GRAPH_ENDPOINT constant
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.