You are here

Home » API reference » Google Auth 8 » Gauth.php

class Gauth in Google Auth 8

Defines the Gauth entity.

This is the main definition of the entity type. From it, an entityType is derived. The most important properties in this example are listed below.

id: The unique identifier of this entityType. It follows the pattern 'moduleName_xyz' to avoid naming conflicts.

label: Human readable name of the entity type.

handlers: Handler classes are used for different tasks. You can use standard handlers provided by D8 or build your own, most probably derived from the standard class. In detail:

  • view_builder: we use the standard controller to view an instance. It is called when a route lists an '_entity_view' default for the entityType (see routing.yml for details. The view can be manipulated by using the standard drupal tools in the settings.
  • list_builder: We derive our own list builder class from the entityListBuilder to control the presentation. If there is a view available for this entity from the views module, it overrides the list builder. @todo: any view? naming convention?
  • form: We derive our own forms to add functionality like additional fields, redirects etc. These forms are called when the routing list an '_entity_form' default for the entityType. Depending on the suffix (.add/.edit/.delete) in the route, the correct form is called.
  • access: Our own accessController where we determine access rights based on permissions.

More properties:

  • base_table: Define the name of the table used to store the data. Make sure it is unique. The schema is automatically determined from the BaseFieldDefinitions below. The table is automatically created during installation.
  • fieldable: Can additional fields be added to the entity via the GUI? Analog to content types.
  • entity_keys: How to access the fields. Analog to 'nid' or 'uid'.
  • links: Provide links to do standard tasks. The 'edit-form' and 'delete-form' links are added to the list built by the entityListController. They will show up as action buttons in an additional column.

There are many more properties to be used in an entity type definition. For a complete overview, please refer to the '\Drupal\Core\Entity\EntityType' class definition.

The following construct is the actual definition of the entity type which is read and cached. Don't forget to clear cache after changes.

@ContentEntityType( id = "gauth", label = @Translation("Gauth entity"), handlers = { "view_builder" = "Drupal\Core\Entity\EntityViewBuilder", "list_builder" = "Drupal\gauth\Entity\Controller\GauthListBuilder", "views_data" = "Drupal\views\EntityViewsData", "form" = { "add" = "Drupal\gauth\Form\GauthForm", "edit" = "Drupal\gauth\Form\GauthForm", "delete" = "Drupal\gauth\Form\GauthDeleteForm", "revoke" = "Drupal\gauth\Form\GauthRevokeForm", }, }, base_table = "gauth", admin_permission = "administer site configuration", fieldable = TRUE, entity_keys = { "id" = "id", "label" = "name", "uuid" = "uid" }, links = { "canonical" = "/gauth/{gauth}", "edit-form" = "/admin/config/services/gauth/{gauth}/edit", "delete-form" = "/admin/config/services/gauth/{gauth}/delete", "revoke-form" = "/admin/config/services/gauth/revoke", "collection" = "/gauth/list" }, field_ui_base_route = "gauth.gauth_settings", )

The 'links' above are defined by their path. For core to find the corresponding route, the route name must follow the correct pattern:

entity.<entity-name>.<link-name> (replace dashes with underscores) Example: 'entity.gauth.canonical'

See routing file above for the corresponding implementation

The 'Gauth' class defines methods and fields for the snapshot entity.

Being derived from the ContentEntityBase class, we can override the methods we want. In our case we want to provide access to the standard fields about creation and changed time stamps.

Our interface (see GauthInterface) also exposes the EntityOwnerInterface. This allows us to provide methods for setting and providing ownership information.

The most important part is the definitions of the field properties for this entity type. These are of the same type as fields added through the GUI, but they can by changed in code. In the definition we can define if the user with the rights privileges can influence the presentation (view, edit) of each field.

Hierarchy

Expanded class hierarchy of Gauth

2 files declare their use of Gauth
GauthResponseHandler.php in src/Entity/Controller/GauthResponseHandler.php
GauthRevokeForm.php in src/Form/GauthRevokeForm.php

File

src/Entity/Gauth.php, line 128

Namespace

Drupal\gauth\Entity
View source 
class Gauth extends ContentEntityBase implements GauthInterface {

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

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

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

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

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

  /**
   * {@inheritdoc}
   */
  public function getServices() {
    $services = $this
      ->get('services')
      ->getValue();
    $return = [];
    foreach ($services as $key => $service) {
      $return[$key] = $service['value'];
    }
    return $return;
  }

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

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

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

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

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

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

  /**
   * {@inheritdoc}
   */
  public function setDeveloperKey($key) {
    return $this
      ->set('developer_key', $key);
  }

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

  /**
   * {@inheritdoc}
   */
  public function setClientSecret($secret) {
    return $this
      ->set('client_secret', $secret);
  }

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

  /**
   * {@inheritdoc}
   */
  public function setAccessToken($token) {
    return $this
      ->set('access_token', $token);
  }

  /**
   * {@inheritdoc}
   */
  public function setAuthenticated($authentication) {
    return $this
      ->set('is_authenticated', $authentication);
  }

  /**
   * {@inheritdoc}
   */
  public function setAccessType($type) {
    return $this
      ->set('access_type', $type);
  }

  /**
   * {@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}
   *
   * Define the field properties here.
   *
   * Field name, type and size determine the table structure.
   *
   * In addition, we can define how the field and its content can be manipulated
   * in the GUI. The behaviour of the widgets used can be determined here.
   */
  public static function baseFieldDefinitions(EntityTypeInterface $entity_type) {

    // Standard field, used as unique if primary index.
    $fields['id'] = BaseFieldDefinition::create('integer')
      ->setLabel(t('Gauth ID'))
      ->setDescription(t('The ID of the Snapshot entity.'))
      ->setReadOnly(TRUE)
      ->setDisplayOptions('view', [
      'label' => 'inline',
      'type' => 'string',
      'weight' => -1,
    ])
      ->setDisplayConfigurable('view', TRUE);
    $fields['name'] = BaseFieldDefinition::create('string')
      ->setLabel(t('Name'))
      ->setDescription(t('The name of the Gauth entity.'))
      ->setSettings([
      'default_value' => '',
      'max_length' => 255,
      'text_processing' => 0,
    ])
      ->setDisplayOptions('form', [
      'type' => 'string_textfield',
      'weight' => 0,
    ])
      ->setDisplayOptions('view', [
      'label' => 'inline',
      'type' => 'string',
      'weight' => 1,
    ])
      ->setRequired(TRUE)
      ->setDisplayConfigurable('form', TRUE)
      ->setDisplayConfigurable('view', TRUE);
    $fields['developer_key'] = BaseFieldDefinition::create('string')
      ->setLabel(t('Developer Key'))
      ->setDescription(t('The developer key of the Gauth entity.'))
      ->setRequired(TRUE)
      ->setSettings([
      'default_value' => '',
      'max_length' => 255,
      'text_processing' => 0,
    ])
      ->setDisplayOptions('form', [
      'type' => 'string_textfield',
      'weight' => 1,
    ])
      ->setDisplayOptions('view', [
      'label' => 'inline',
      'type' => 'string',
      'weight' => 2,
    ])
      ->setDisplayConfigurable('form', TRUE)
      ->setDisplayConfigurable('view', TRUE);
    $fields['client_id'] = BaseFieldDefinition::create('string')
      ->setLabel(t('Client Id'))
      ->setDescription(t('The client id of the Gauth entity.'))
      ->setRequired(TRUE)
      ->setSettings([
      'default_value' => '',
      'max_length' => 255,
      'text_processing' => 0,
    ])
      ->setDisplayOptions('form', [
      'type' => 'string_textfield',
      'weight' => 2,
    ])
      ->setDisplayOptions('view', [
      'label' => 'inline',
      'type' => 'string',
      'weight' => 3,
    ])
      ->setDisplayConfigurable('form', TRUE)
      ->setDisplayConfigurable('view', TRUE);
    $fields['client_secret'] = BaseFieldDefinition::create('string')
      ->setLabel(t('Client Secret'))
      ->setDescription(t('The client secret of the Gauth entity.'))
      ->setRequired(TRUE)
      ->setSettings([
      'default_value' => '',
      'max_length' => 255,
      'text_processing' => 0,
    ])
      ->setDisplayOptions('form', [
      'type' => 'string_textfield',
      'weight' => 3,
    ])
      ->setDisplayOptions('view', [
      'label' => 'inline',
      'type' => 'string',
      'weight' => 4,
    ])
      ->setDisplayConfigurable('form', TRUE)
      ->setDisplayConfigurable('view', TRUE);
    $fields['services'] = BaseFieldDefinition::create('list_string')
      ->setLabel(t('Services'))
      ->setDescription(t('services of the Gauth entity.'))
      ->setRequired(TRUE)
      ->setDisplayOptions('form', [
      'type' => 'options_select',
      'weight' => 4,
      'multiple' => TRUE,
    ])
      ->setSetting('allowed_values_function', 'gauth_google_services_names')
      ->setCardinality(BaseFieldDefinition::CARDINALITY_UNLIMITED)
      ->setDisplayOptions('view', [
      'label' => 'inline',
      'type' => 'string',
      'weight' => 5,
    ])
      ->setDisplayConfigurable('form', TRUE)
      ->setDisplayConfigurable('view', TRUE);
    $fields['access_token'] = BaseFieldDefinition::create('string_long')
      ->setLabel(t('Access Token'))
      ->setDescription(t('Access token from google'))
      ->setReadOnly(TRUE)
      ->setDisplayOptions('view', [
      'label' => 'inline',
      'type' => 'string',
      'weight' => 6,
    ])
      ->setDisplayConfigurable('form', FALSE)
      ->setDisplayConfigurable('view', TRUE);
    $fields['is_authenticated'] = BaseFieldDefinition::create('boolean')
      ->setLabel(t('Is Authenticated'))
      ->setDescription(t('Is gauth account authenticated'))
      ->setDefaultValue(FALSE)
      ->setReadOnly(TRUE)
      ->setDisplayOptions('view', [
      'label' => 'inline',
      'type' => 'string',
      'weight' => 7,
    ])
      ->setDisplayConfigurable('form', FALSE)
      ->setDisplayConfigurable('view', TRUE);

    // Owner field of the gauth.
    // Entity reference field, holds the reference to the user object.
    // The view shows the user name field of the user.
    // The form presents a auto complete field for the user name.
    $fields['uid'] = BaseFieldDefinition::create('entity_reference')
      ->setLabel(t('User Name'))
      ->setDescription(t('The Name of the associated user.'))
      ->setSetting('target_type', 'user')
      ->setSetting('handler', 'default')
      ->setDisplayOptions('view', [
      'label' => 'inline',
      'type' => 'string',
      'weight' => 8,
    ])
      ->setDisplayConfigurable('form', FALSE)
      ->setDisplayConfigurable('view', TRUE);
    $fields['access_type'] = BaseFieldDefinition::create('boolean')
      ->setLabel(t('Is Access Type Offline'))
      ->setDescription(t('Access type of the Gauth entity.'))
      ->setDisplayOptions('form', [
      'type' => 'boolean_checkbox',
      'settings' => [
        'display_label' => TRUE,
      ],
      'weight' => 8,
    ])
      ->setDefaultValue(TRUE)
      ->setDisplayOptions('view', [
      'label' => 'inline',
      'type' => 'string',
      'weight' => 9,
    ])
      ->setDisplayConfigurable('form', TRUE)
      ->setDisplayConfigurable('view', TRUE);
    return $fields;
  }

  /**
   * {@inheritdoc}
   *
   * When a new entity instance is added, set the uid entity reference to
   * the current user as the creator of the instance.
   */
  public static function preCreate(EntityStorageInterface $storage_controller, array &$values) {
    parent::preCreate($storage_controller, $values);
    if (!isset($values['uid']) || $values['uid'] == NULL) {
      $values += [
        'uid' => \Drupal::currentUser()
          ->id(),
      ];
    }
    $values['is_authenticated'] = FALSE;
  }

  /**
   * Function to retrieve the google client for different operations.
   *
   * Developers can pass the gauth object and get the api client ready
   * for operations.
   *
   * @param Gauth|null $gauth
   *   Gauth account class object.
   *
   * @return \Google_Client
   *   Google_Client object with all params from the account.
   *
   * @throws \Drupal\Core\Entity\EntityStorageException
   */
  public static function getGauthClient(Gauth $gauth = NULL) {
    gauth_load_library();
    $client = new Google_Client();
    $client
      ->setRedirectUri(gauth_callback_url());
    if ($gauth == NULL) {
      return $client;
    }
    $client
      ->setClientId($gauth
      ->getClientId());
    if ($gauth
      ->getAuthenticated()) {
      $client
        ->setAccessToken($gauth
        ->getAccessToken());
    }
    if ($gauth
      ->getAccessType()) {
      $client
        ->setAccessType('offline');
    }
    $client
      ->setClientSecret($gauth
      ->getClientSecret());
    $client
      ->setDeveloperKey($gauth
      ->getDeveloperKey());
    $client
      ->setRedirectUri(gauth_callback_url());
    if ($gauth
      ->getAccessType()) {
      $client
        ->setApprovalPrompt('force');
    }
    $client
      ->setApplicationName("Google OAuth2");
    $scopes = gauth_google_services_scopes($gauth
      ->getServices());

    // Let other modules change scopes.
    $gauth_id = $gauth
      ->getId();
    \Drupal::moduleHandler()
      ->alter('gauth_account_scopes', $scopes, $gauth_id);
    $client
      ->addScope($scopes);
    if ($client
      ->getAccessToken() && $client
      ->isAccessTokenExpired()) {
      if ($client
        ->getRefreshToken() != '') {

        // Access Type is Offline.
        $client
          ->refreshToken($client
          ->getRefreshToken());
        $token = $client
          ->getAccessToken();
        $gauth
          ->setAccessToken($token);
        $gauth
          ->save();
      }
      else {
        $client
          ->revokeToken();
        $gauth
          ->setAuthenticated(FALSE);
        $gauth
          ->setAccessToken('');
        $gauth
          ->save();
        \Drupal::messenger()
          ->addMessage(t('Access token is expired. If you are admin then you need to authenticate again. Consider configuring access type to offline.'));
      }
    }
    return $client;
  }

  /**
   * This function is designed to return objects of services classes.
   *
   * So if the account is authenticated for say Google calendar then
   * this function will return Google_Service_Calendar class object.
   *
   * @param array $services
   *   Array of services so that objects can be contructed.
   *
   * @return array
   *   Array of Google_Service classes with servicename as index.
   *
   * @throws \Drupal\Core\Entity\EntityStorageException
   */
  public function getServiceObjects(array $services = []) {
    if (empty($services)) {
      $services = $this
        ->getServices();
    }
    if (!is_array($services)) {
      $services = [
        $services,
      ];
    }
    $classes = \Drupal::config('gauth.google_api_classes')
      ->get('gauth_google_api_classes');
    $return = [];
    $client = self::getGauthClient($this);
    foreach ($services as $service) {
      $return[$service] = new $classes[$service]($client);
    }
    return $return;
  }

  /**
   * {@inheritdoc}
   *
   * @return int
   *   Id for the Gauth being saved.
   *
   * @throws \Drupal\Component\Plugin\Exception\InvalidPluginDefinitionException
   * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
   * @throws \Drupal\Core\Entity\EntityStorageException
   */
  public function save() {
    $original = $this->original ? $this->original : NULL;
    if (!$original) {

      // Usually this should exist in save but still keeping it safe.
      $id = $this
        ->getOriginalId() !== NULL ? $this
        ->getOriginalId() : $this
        ->id();
      $original = $this
        ->entityTypeManager()
        ->getStorage($this
        ->getEntityTypeId())
        ->loadUnchanged($id);
    }
    if ($original && ($original
      ->getServices() != $this
      ->getServices() || $original
      ->getClientId() != $this
      ->getClientId() || $original
      ->getClientSecret() != $this
      ->getClientSecret() || $original
      ->getDeveloperKey() != $this
      ->getDeveloperKey())) {

      // If the gauth isi modified it needs to be re-authenticated.
      $this
        ->setAccessToken('{}');
      $this
        ->setAuthenticated(FALSE);
    }
    return parent::save();
  }

}

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::preDelete public static function Acts on entities before they are deleted and before hooks are invoked. Overrides EntityInterface::preDelete 4
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
Gauth::baseFieldDefinitions public static function Define the field properties here. Overrides ContentEntityBase::baseFieldDefinitions
Gauth::getAccessToken public function
Gauth::getAccessType public function
Gauth::getAuthenticated public function
Gauth::getClientId public function
Gauth::getClientSecret public function
Gauth::getDeveloperKey public function
Gauth::getGauthClient public static function Function to retrieve the google client for different operations.
Gauth::getId public function
Gauth::getName public function
Gauth::getOwner public function Returns the entity owner's user entity. Overrides EntityOwnerInterface::getOwner
Gauth::getOwnerId public function Returns the entity owner's user ID. Overrides EntityOwnerInterface::getOwnerId
Gauth::getServiceObjects public function This function is designed to return objects of services classes.
Gauth::getServices public function
Gauth::preCreate public static function When a new entity instance is added, set the uid entity reference to the current user as the creator of the instance. Overrides EntityBase::preCreate
Gauth::save public function Overrides EntityBase::save
Gauth::setAccessToken public function
Gauth::setAccessType public function
Gauth::setAuthenticated public function
Gauth::setClientId public function
Gauth::setClientSecret public function
Gauth::setDeveloperKey public function
Gauth::setName public function
Gauth::setOwner public function Sets the entity owner's user entity. Overrides EntityOwnerInterface::setOwner
Gauth::setOwnerId public function Sets the entity owner's user ID. Overrides EntityOwnerInterface::setOwnerId
Gauth::setServices public function
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.