class CourseEnrollment in Course 3.x

Same name in this branch

3.x src/Entity/CourseEnrollment.php \Drupal\course\Entity\CourseEnrollment
3.x modules/course_migrate/src/Plugin/migrate/source/CourseEnrollment.php \Drupal\course_migrate\Plugin\migrate\source\CourseEnrollment

Same name and namespace in other branches

8.3 src/Entity/CourseEnrollment.php \Drupal\course\Entity\CourseEnrollment
8.2 src/Entity/CourseEnrollment.php \Drupal\course\Entity\CourseEnrollment

Defines the profile entity class.

Plugin annotation


@ContentEntityType(
  id = "course_enrollment",
  label = @Translation("Course enrollment"),
  label_collection = @Translation("Course enrollments"),
  label_singular = @Translation("course_enrollment"),
  label_plural = @Translation("course_enrollments"),
  label_count = @PluralTranslation(
    singular = "@count enrollment",
    plural = "@count enrollments",
  ),
  bundle_label = @Translation("Course enrollment type"),
  bundle_entity_type = "course_enrollment_type",
  admin_permission = "administer course",
  permission_granularity = "bundle",
  base_table = "course_enrollment",
  revision_table = "course_enrollment_revision",
  fieldable = TRUE,
  field_ui_base_route = "entity.course_enrollment_type.edit_form",
  show_revision_ui = TRUE,
  entity_keys = {
    "id" = "eid",
    "bundle" = "type",
    "uid" = "uid",
    "uuid" = "uuid",
    "revision" = "revision_id",
  },
  revision_metadata_keys = {
    "revision_default" = "revision_default",
    "revision_user" = "revision_user",
    "revision_created" = "revision_created",
    "revision_log_message" = "revision_log_message",
  },
  handlers = {
    "access" = "Drupal\entity\UncacheableEntityAccessControlHandler",
    "permission_provider" = "Drupal\entity\UncacheableEntityPermissionProvider",
    "storage_schema" = "Drupal\course\Schema\CourseEnrollmentStorageSchema",
    "views_data" = "Drupal\entity\EntityViewsData",
    "form" = {
      "default" = "Drupal\course\Form\CourseEnrollmentEntityForm",
     }
  }
)

Hierarchy

class \Drupal\Core\Entity\EntityBase implements EntityInterface uses RefinableCacheableDependencyTrait, DependencySerializationTrait
- class \Drupal\Core\Entity\ContentEntityBase implements \Drupal\Core\Entity\IteratorAggregate, ContentEntityInterface, TranslationStatusInterface uses EntityChangesDetectionTrait, SynchronizableEntityTrait
  - class \Drupal\course\Entity\CourseEnrollment implements EntityChangedInterface, RevisionLogInterface uses EntityChangedTrait, RevisionLogEntityTrait

Expanded class hierarchy of CourseEnrollment

5 files declare their use of CourseEnrollment

CourseController.php in src/Controller/CourseController.php
CourseDeleteTest.php in tests/src/Functional/CourseDeleteTest.php
CourseEnrollmentEditAction.php in src/Plugin/Action/CourseEnrollmentEditAction.php
CourseEnrollmentTest.php in tests/src/Functional/CourseEnrollmentTest.php
course_commerce.module in modules/course_commerce/course_commerce.module

File

src/Entity/CourseEnrollment.php, line 65

Namespace

Drupal\course\Entity

View source

class CourseEnrollment extends ContentEntityBase implements EntityChangedInterface, RevisionLogInterface {
  use RevisionLogEntityTrait;
  use EntityChangedTrait;

  /**
   * Use the Course's configured enrollment type if available.
   *
   * {@inheritdoc}
   */
  public static function preCreate(EntityStorageInterface $storage, array &$values) {
    if (isset($values['cid'])) {
      $course = Course::load($values['cid']);
      $values['type'] = $course
        ->get('enrollment_type')
        ->getString();
    }
    return parent::preCreate($storage, $values);
  }

  /**
   * {@inheritdoc}
   */
  function access($operation, AccountInterface $account = NULL, $return_as_object = FALSE) {
    if (!$account) {
      $account = \Drupal::currentUser();
    }
    $course_access = $this
      ->getCourse()
      ->access('update', $account);
    $admin_course = $account
      ->hasPermission('administer course');
    $admin_enrollments = $account
      ->hasPermission('administer course enrollments');
    return AccessResult::allowedIf($course_access || $admin_course || $admin_enrollments);
  }

  /**
   * Enrollment entity label callback.
   */
  function defaultLabel() {
    $course = Course::load($this->cid);
    $account = User::load($this->uid);
    return t("@username's enrollment in @title", array(
      '@username' => format_username($account),
      '@title' => $course->title->value,
    ));
  }

  /**
   * If a duration is set on the course, apply it to this enrollment.
   *
   * {@inheritdoc}
   */
  public function preSave(EntityStorageInterface $storage) {
    $course = $this
      ->getCourse();
    if ($this
      ->get('enroll_end')
      ->isEmpty() && !$course
      ->get('duration')
      ->isEmpty()) {

      // Set enrollment end to now + the duration of the course.
      $this
        ->set('enroll_end', \Drupal::time()
        ->getRequestTime() + $course
        ->get('duration')
        ->getString());
    }

    // After enrollment, check for completion.
    $this
      ->evaluate();

    // Always create a new revision.
    $this
      ->setNewRevision();
    parent::preSave($storage);
  }

  /**
   * @kludge Reset the static lookup cache.
   */
  public function save() {
    $watchdog_variables = array(
      '@uid' => $this
        ->getUser()
        ->id(),
      '@cid' => $this
        ->getCourse()
        ->id(),
    );
    $ret = parent::save();
    if ($this
      ->isNew()) {
      Drupal::logger('course_enroll')
        ->notice('Enrolled user @uid into @cid.', $watchdog_variables);
    }
    return $ret;
  }

  /**
   * {@inheritdoc}
   */
  public static function baseFieldDefinitions(EntityTypeInterface $entity_type) {
    $fields = parent::baseFieldDefinitions($entity_type);

    // Add the revision metadata fields.
    $fields += static::revisionLogBaseFieldDefinitions($entity_type);
    $fields['cid'] = BaseFieldDefinition::create('entity_reference')
      ->setSetting('target_type', 'course')
      ->setRequired(TRUE)
      ->setLabel(t('Course'));
    $fields['uid'] = BaseFieldDefinition::create('entity_reference')
      ->setSetting('target_type', 'user')
      ->setRequired(TRUE)
      ->setLabel(t('User'));
    $fields['enrollmenttype'] = BaseFieldDefinition::create('string')
      ->setDisplayConfigurable('form', TRUE)
      ->setDisplayOptions('form', [
      'type' => 'text_textfield',
    ])
      ->setLabel(t('Source'))
      ->setRevisionable(TRUE)
      ->setDescription(t('The creation source of the enrollment.'));
    $fields['status'] = BaseFieldDefinition::create('boolean')
      ->setDefaultValue(1)
      ->setDisplayOptions('form', [
      'type' => 'boolean_checkbox',
    ])
      ->setDisplayConfigurable('form', TRUE)
      ->setDisplayOptions('form', [
      'type' => 'datetime_default',
    ])
      ->setRevisionable(TRUE)
      ->setLabel(t('Status'));
    $fields['timestamp'] = BaseFieldDefinition::create('timestamp')
      ->setDefaultValue(NULL)
      ->setDisplayConfigurable('form', TRUE)
      ->setDisplayOptions('form', [
      'type' => 'nullable_datetime_timestamp',
    ])
      ->setRevisionable(TRUE)
      ->setLabel(t('Start'));
    $fields['enroll_end'] = BaseFieldDefinition::create('timestamp')
      ->setDefaultValue(NULL)
      ->setDisplayConfigurable('form', TRUE)
      ->setDisplayOptions('form', [
      'type' => 'nullable_datetime_timestamp',
    ])
      ->setRevisionable(TRUE)
      ->setLabel(t('End'));
    $fields['complete'] = BaseFieldDefinition::create('boolean')
      ->setDefaultValue(FALSE)
      ->setDisplayConfigurable('form', TRUE)
      ->setRevisionable(TRUE)
      ->setLabel(t('Complete'));
    $fields['date_completed'] = BaseFieldDefinition::create('timestamp')
      ->setRevisionable(TRUE)
      ->setDefaultValue(NULL)
      ->setDisplayConfigurable('form', TRUE)
      ->setDisplayOptions('form', [
      'type' => 'nullable_datetime_timestamp',
    ])
      ->setRevisionable(TRUE)
      ->setLabel(t('Date completed'));
    $fields['grade_result'] = BaseFieldDefinition::create('integer')
      ->setDisplayConfigurable('form', TRUE)
      ->setDisplayOptions('form', [
      'type' => 'boolean_checkbox',
    ])
      ->setRevisionable(TRUE)
      ->setLabel(t('Grade result'));
    $fields['section'] = BaseFieldDefinition::create('string')
      ->setRevisionable(TRUE)
      ->setLabel(t('Section'));
    $fields['section_name'] = BaseFieldDefinition::create('string')
      ->setRevisionable(TRUE)
      ->setLabel(t('Section name'));
    $fields['coid'] = BaseFieldDefinition::create('entity_reference')
      ->setSetting('target_type', 'course_object')
      ->setRevisionable(TRUE)
      ->setLabel(t('Course object ID'));
    $fields['data'] = BaseFieldDefinition::create('map')
      ->setLabel(t('Data'));
    $fields['created'] = BaseFieldDefinition::create('created')
      ->setRevisionable(TRUE)
      ->setLabel('Created');
    $fields['changed'] = BaseFieldDefinition::create('changed')
      ->setRevisionable(TRUE)
      ->setLabel('Changed');
    return $fields;
  }

  /**
   * Get the Course for this enrollment.
   *
   * @return Course
   */
  function getCourse() {
    return Course::load($this
      ->get('cid')
      ->getString());
  }

  /**
   * Get the User for this enrollment.
   *
   * @return AccountInterface
   */
  function getUser() {
    return User::load($this
      ->get('uid')
      ->getString());
  }
  public function track() {
    $this
      ->evaluate();
    $this
      ->save();
  }

  /**
   * Track the course (scan required objects, update progress, completion, etc.)
   * and mark progress/completion.
   */
  public function evaluate() {
    $required = 0;
    $required_complete = 0;
    $prev = NULL;
    $account = $this
      ->getUser();
    $grades = [];
    foreach ($this
      ->getCourse()
      ->getObjects() as $courseObject) {
      if (!$courseObject
        ->get('enabled')->value) {
        continue;
      }
      if (!$prev) {
        $this
          ->set('section_name', $courseObject
          ->getTitle());
        $this
          ->set('coid', $courseObject
          ->id());
      }

      // Count required objects.
      $required += (int) $courseObject
        ->get('required')
        ->getString();

      // Count completed required objects.
      $required_complete += $courseObject
        ->get('required')
        ->getString() && $courseObject
        ->getFulfillment($account)
        ->isComplete();

      // Log last grade.
      if ($courseObject
        ->isGraded() && $courseObject
        ->getOption('grade_include')) {
        $grades[$courseObject
          ->id()] = $courseObject
          ->getFulfillment($account)
          ->getOption('grade_result');
      }
      if (!$courseObject
        ->getFulfillment($account)
        ->isComplete() && $prev && $prev
        ->getFulfillment($account)
        ->isComplete()) {
        $this
          ->set('section_name', $courseObject
          ->getTitle());
        $this
          ->set('coid', $courseObject
          ->id());
      }
      $prev = clone $courseObject;
    }
    if (!empty($grades)) {
      $this
        ->set('grade_result', array_sum($grades) / count($grades));
    }
    if ($required_complete >= $required) {

      // Course requirements have been met.
      $this
        ->set('section', 'complete');
      $this
        ->set('section_name', 'Complete');
      $this
        ->set('complete', 1);
      if ($this
        ->get('date_completed')
        ->isEmpty()) {
        $this
          ->set('date_completed', \Drupal::time()
          ->getRequestTime());
      }
    }
  }

  /**
   * Clean up fulfillments after deleting an enrollment.
   *
   * {@inheritdoc}
   */
  public static function preDelete(EntityStorageInterface $storage, array $entities) {
    foreach ($entities as $course_enrollment) {

      // Find all course objects in this course and delete the fulfillments.
      $coids = array();
      $result = Drupal::database()
        ->query("SELECT coid FROM {course_object} WHERE cid = :cid", array(
        ':cid' => $course_enrollment
          ->getCourse()
          ->id(),
      ));
      while ($row = $result
        ->fetch()) {
        $coids[] = $row->coid;
      }
      if (count($coids)) {
        $sql = "SELECT cofid FROM {course_object_fulfillment} WHERE coid IN (:coids[]) AND uid = :uid";

        // The user is already deleted, so we have to delete by the user ID.
        $cofIds = Drupal::database()
          ->query($sql, array(
          ':coids[]' => $coids,
          ':uid' => $course_enrollment
            ->get('uid')
            ->getString(),
        ))
          ->fetchAllKeyed(0, 0);
        $cofStorage = \Drupal::entityTypeManager()
          ->getStorage('course_object_fulfillment');
        $entities = $cofStorage
          ->loadMultiple($cofIds);
        foreach ($entities as $entity) {
          $entity
            ->delete();
        }
      }
      parent::preDelete($storage, $entities);
    }
  }

  /**
   * Check if the user has completed this course.
   *
   * @return bool
   */
  function isComplete() {
    return (bool) $this
      ->get('complete')
      ->getString();
  }

  /**
   * Reset enrollment access cache.
   *
   * {@inheritdoc}
   */
  public function postSave(EntityStorageInterface $storage, $update = TRUE) {
    \Drupal::entityTypeManager()
      ->getAccessControlHandler('course')
      ->resetCache();
    \Drupal::entityTypeManager()
      ->getAccessControlHandler('course_object')
      ->resetCache();
  }

  /**
   * {@inheritdoc}
   */
  public function label() {
    return "{$this->getUser()->getDisplayName()}'s enrollment in {$this->getCourse()->getTitle()}";
  }

}

Members

Name	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::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::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::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().
CourseEnrollment::access		function	Checks data value access. Overrides ContentEntityBase::access
CourseEnrollment::baseFieldDefinitions	public static	function	Provides base field definitions for an entity type. Overrides ContentEntityBase::baseFieldDefinitions
CourseEnrollment::defaultLabel		function	Enrollment entity label callback.
CourseEnrollment::evaluate	public	function	Track the course (scan required objects, update progress, completion, etc.) and mark progress/completion.
CourseEnrollment::getCourse		function	Get the Course for this enrollment.
CourseEnrollment::getUser		function	Get the User for this enrollment.
CourseEnrollment::isComplete		function	Check if the user has completed this course.
CourseEnrollment::label	public	function	Gets the label of the entity. Overrides ContentEntityBase::label
CourseEnrollment::postSave	public	function	Reset enrollment access cache. Overrides ContentEntityBase::postSave
CourseEnrollment::preCreate	public static	function	Use the Course's configured enrollment type if available. Overrides EntityBase::preCreate
CourseEnrollment::preDelete	public static	function	Clean up fulfillments after deleting an enrollment. Overrides EntityBase::preDelete
CourseEnrollment::preSave	public	function	If a duration is set on the course, apply it to this enrollment. Overrides ContentEntityBase::preSave
CourseEnrollment::save	public	function	@kludge Reset the static lookup cache. Overrides EntityBase::save
CourseEnrollment::track	public	function
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::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::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.
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
RevisionLogEntityTrait::getEntityType	abstract public	function	Gets the entity type definition.
RevisionLogEntityTrait::getRevisionCreationTime	public	function	Implements \Drupal\Core\Entity\RevisionLogInterface::getRevisionCreationTime().	1
RevisionLogEntityTrait::getRevisionLogMessage	public	function	Implements \Drupal\Core\Entity\RevisionLogInterface::getRevisionLogMessage().	1
RevisionLogEntityTrait::getRevisionMetadataKey	protected static	function	Gets the name of a revision metadata field.
RevisionLogEntityTrait::getRevisionUser	public	function	Implements \Drupal\Core\Entity\RevisionLogInterface::getRevisionUser().	1
RevisionLogEntityTrait::getRevisionUserId	public	function	Implements \Drupal\Core\Entity\RevisionLogInterface::getRevisionUserId().	1
RevisionLogEntityTrait::revisionLogBaseFieldDefinitions	public static	function	Provides revision-related base field definitions for an entity type.
RevisionLogEntityTrait::setRevisionCreationTime	public	function	Implements \Drupal\Core\Entity\RevisionLogInterface::setRevisionCreationTime().	1
RevisionLogEntityTrait::setRevisionLogMessage	public	function	Implements \Drupal\Core\Entity\RevisionLogInterface::setRevisionLogMessage().	1
RevisionLogEntityTrait::setRevisionUser	public	function	Implements \Drupal\Core\Entity\RevisionLogInterface::setRevisionUser().	1
RevisionLogEntityTrait::setRevisionUserId	public	function	Implements \Drupal\Core\Entity\RevisionLogInterface::setRevisionUserId().	1
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.

You are here

class CourseEnrollment in Course 3.x

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation