class Course in Course 8.3
Same name and namespace in other branches
- 8.2 src/Entity/Course.php \Drupal\course\Entity\Course
- 3.x src/Entity/Course.php \Drupal\course\Entity\Course
Defines the Course entity class.
Plugin annotation
@ContentEntityType(
id = "course",
label = @Translation("Course"),
label_collection = @Translation("Course"),
label_singular = @Translation("course"),
label_plural = @Translation("courses"),
label_count = @PluralTranslation(
singular = "@count course",
plural = "@count courses",
),
bundle_label = @Translation("Course type"),
bundle_entity_type = "course_type",
admin_permission = "administer course",
permission_granularity = "bundle",
base_table = "course",
fieldable = TRUE,
field_ui_base_route = "entity.course_type.edit_form",
show_revision_ui = FALSE,
entity_keys = {
"id" = "cid",
"bundle" = "outline",
"label" = "title",
},
handlers = {
"view_builder" = "Drupal\course\View\CourseViewBuilder",
"list_builder" = "Drupal\course\Config\Entity\CourseListBuilder",
"access" = "Drupal\course\Access\CourseAccessControlHandler",
"permission_provider" = "Drupal\entity\UncacheableEntityPermissionProvider",
"route_provider" = {
"html" = "Drupal\Core\Entity\Routing\AdminHtmlRouteProvider",
},
"form" = {
"default" = "Drupal\course\Form\CourseEntityForm",
"delete" = "Drupal\Core\Entity\EntityDeleteForm",
},
"views_data" = "Drupal\views\EntityViewsData",
},
links = {
"canonical" = "/course/{course}",
"add-page" = "/course/add",
"add-form" = "/course/add/{course_type}",
"delete-form" = "/course/{course}/delete",
"edit-form" = "/course/{course}/edit",
"collection" = "/admin/course/courses",
}
)
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\Course
- class \Drupal\Core\Entity\ContentEntityBase implements \Drupal\Core\Entity\IteratorAggregate, ContentEntityInterface, TranslationStatusInterface uses EntityChangesDetectionTrait, SynchronizableEntityTrait
Expanded class hierarchy of Course
12 files declare their use of Course
- CertificateTabController.php in modules/
course_certificate/ src/ Controller/ CertificateTabController.php - course.api.php in ./
course.api.php - Hooks provided by Course module.
- course.module in ./
course.module - course.module Core functionality for Courses.
- CourseAccessControlHandler.php in src/
Access/ CourseAccessControlHandler.php - CourseController.php in src/
Controller/ CourseController.php
22 string references to 'Course'
- course.course_report.view.inc in views/
default/ course.course_report.view.inc - course.enrollment.type.course_enrollment.yml in config/
install/ course.enrollment.type.course_enrollment.yml - config/install/course.enrollment.type.course_enrollment.yml
- course.info.yml in ./
course.info.yml - course.info.yml
- course.links.menu.yml in ./
course.links.menu.yml - course.links.menu.yml
- course.routing.yml in ./
course.routing.yml - course.routing.yml
File
- src/
Entity/ Course.php, line 65
Namespace
Drupal\course\EntityView source
class Course extends ContentEntityBase {
// Ordered list of course objects.
private $courseObjects = array();
// Course report tracker
private $tracker;
// The active course object.
private $active = NULL;
// The next course object.
private $next;
// The previous course object.
private $prev;
/**
* Get the course tracker for this course/user.
*
* @return CourseEnrollment
*/
public function getTracker(AccountInterface $account) {
$entities = \Drupal::entityTypeManager()
->getStorage('course_enrollment')
->loadByProperties([
'cid' => $this
->id(),
'uid' => $account
->id(),
]);
if ($entities) {
return reset($entities);
}
return FALSE;
}
/**
* The Drupal path to take this course.
*
* @return Url
*/
public function getUrl() {
return Url::fromRoute('course.take', [
'course' => $this
->id(),
]);
}
/**
* Set the active CourseObject in this Course.
*
* @param int $id
* A numeric course object ID.
*/
public function setActive($id = NULL) {
if (!$id && isset($_SESSION['course'][$this
->id()]['taking']['active'])) {
$id = $_SESSION['course'][$this
->id()]['taking']['active'];
}
$old = NULL;
$storeNext = FALSE;
foreach ($this
->getObjects() as $courseObject) {
if (!$courseObject
->getOption('enabled')) {
// Skip disabled objects.
continue;
}
if ($id == $courseObject
->id()) {
// Active - save old, store next.
if ($old) {
$this->prev = $old;
}
$storeNext = TRUE;
$this->active = $courseObject;
}
elseif ($storeNext) {
$this->next = clone $courseObject;
$storeNext = FALSE;
}
$old = clone $courseObject;
}
}
/**
* Get the active CourseObject.
*
* @return CourseObject
*/
public function getActive() {
if (!$this->active) {
$this
->setActive();
}
return $this->active;
}
/**
* Get the next course object, from the active course object.
*
* @return CourseObject
*/
public function getNext() {
if (!$this->active) {
$this
->setActive();
}
return $this->next;
}
/**
* Get the previous course object, from the active course object.
*
* @return CourseObject
*/
public function getPrev() {
if (!$this->active) {
$this
->setActive();
}
return $this->prev;
}
/**
* Generate navigation links.
*/
public function getNavigation(AccountInterface $account) {
// Initialize the active Course.
$this
->setActive();
$prev = $this
->getPrev();
$next = $this
->getNext();
$links = array();
if ($prev && $prev
->access('take')) {
$links['prev'] = \Drupal\Core\Link::fromTextAndUrl(t('Previous'), $prev
->getUrl());
}
$links['back'] = \Drupal\Core\Link::createFromRoute(t('Back to course'), 'entity.course.canonical', [
'course' => $this
->id(),
]);
if ($next && $next
->access('take')) {
$links['next'] = \Drupal\Core\Link::fromTextAndUrl(t('Next'), $next
->getUrl());
}
elseif (!$next && $this
->getTracker($account)
->isComplete()) {
$links['next'] = \Drupal\Core\Link::createFromRoute(t('Next'), 'course.complete', [
'course' => $this
->id(),
]);
}
// Ask course objects if they want to override the navigation.
if ($active = $this
->getActive()) {
foreach ($active
->overrideNavigation() as $key => $link) {
$links[$key] = $link;
}
}
return $links;
}
/**
* Get the course objects in this course.
*
* @return CourseObject[]
* An array of course objects.
*/
public function getObjects() {
if (empty($this->courseObjects)) {
$efq = \Drupal::entityQuery('course_object');
$result = $efq
->condition('cid', $this
->id())
->sort('weight')
->execute();
if (!empty($result)) {
$this->courseObjects = \Drupal::entityTypeManager()
->getStorage('course_object')
->loadMultiple($result);
}
}
return $this->courseObjects;
}
function resetCache() {
// Reset this course's cache.
$this->courseObjects = array();
return $this;
}
public function getNode() {
return \Drupal\node\Entity\Node::load($this->nid);
}
public static function baseFieldDefinitions(EntityTypeInterface $entity_type) {
$fields = parent::baseFieldDefinitions($entity_type);
$fields['title'] = BaseFieldDefinition::create('string')
->setLabel(t('Title'))
->setRequired(TRUE)
->setTranslatable(TRUE)
->setRevisionable(TRUE)
->setSetting('max_length', 255)
->setDisplayOptions('view', [
'label' => 'hidden',
'type' => 'string',
'weight' => -5,
])
->setDisplayOptions('form', [
'type' => 'string_textfield',
'weight' => -5,
])
->setDisplayConfigurable('form', TRUE);
$config = Drupal::config('course.settings.enrollment');
// Get course outline plugins.
/* @var $pluginManager CourseOutlinePluginManager */
$pluginManager = Drupal::service('plugin.manager.course.outline');
$outlines = array_column($pluginManager
->getDefinitions(), 'label', 'id');
// Get enrollment bundles.
$ebundles = array_column(CourseEnrollmentType::loadMultiple(), 'label', 'id');
$fields['outline'] = BaseFieldDefinition::create('list_string')
->setLabel(t('Outline display'))
->setDescription(t('This controls the presentation of the course objects.'))
->setRequired(TRUE)
->setDisplayOptions('form', [
'type' => 'options_select',
])
->setDisplayConfigurable('form', TRUE)
->setSetting('allowed_values', $outlines);
$fields['enrollment_type'] = BaseFieldDefinition::create('list_string')
->setLabel(t('Enrollment type'))
->setDescription(t("The enrollment type's fields, if required for enrollment, will be presented to the user before starting the course."))
->setRequired(TRUE)
->setDisplayOptions('form', [
'type' => 'options_select',
])
->setDefaultValue($config
->get('default_enrollment_type'))
->setDisplayConfigurable('form', TRUE)
->setSetting('allowed_values', $ebundles);
$fields['credits'] = BaseFieldDefinition::create('float')
->setLabel(t('Credits'))
->setDescription(t('For more advanced crediting, use the <a href=":link">Course credit</a> module.', array(
':link' => Url::fromUri('https://drupal.org/project/course_credit')
->toString(),
)))
->setDisplayOptions('form', [
'type' => 'number',
])
->setDisplayConfigurable('form', TRUE);
// This is a simple credit hours field. If course_credit is enabled it used
// for storing the maximum credit of any credit instance.
if (!Drupal::moduleHandler()
->moduleExists('course_credit')) {
$fields['credits']
->setDisplayConfigurable('form', FALSE);
}
$fields['duration'] = BaseFieldDefinition::create('integer')
->setLabel(t('Duration'))
->setDescription(t('Length of time in seconds that a user can remain in the course. Leave blank for unlimited.<br/>For a better experience, install the <a href=":link">Time period</a> module.', array(
':link' => Url::fromUri('https://drupal.org/project/timeperiod')
->toString(),
)))
->setDisplayOptions('form', [
'type' => 'number',
])
->setDisplayConfigurable('form', TRUE);
if (Drupal::moduleHandler()
->moduleExists('timeperiod')) {
$form['course']['duration']['#type'] = 'timeperiod_select';
$form['course']['duration']['#units'] = array(
'86400' => array(
'max' => 30,
'step size' => 1,
),
'3600' => array(
'max' => 24,
'step size' => 1,
),
'60' => array(
'max' => 60,
'step size' => 1,
),
);
$form['course']['duration']['#description'] = t('Length of time that a user can remain in the course.');
}
$fields['external_id'] = BaseFieldDefinition::create('string')
->setLabel(t('External learning application course ID'))
->setDescription('If using an external learning application, the ID of the external course.')
->setDisplayOptions('form', [
'type' => 'string_textfield',
])
->setDisplayConfigurable('form', TRUE);
if (FALSE && arg(2) == 'clone') {
// @todo not even going to try and make this work right now
$form['course']['clone_type'] = array(
'#title' => t('Course object cloning'),
'#description' => t('"New" will create new instances of all course objects.<br/>"Reference" will link supported content in the old course to the new course.<br/>"Clone" will copy supported course objects, otherwise create new ones.'),
'#type' => 'radios',
'#options' => array(
'clone' => 'Clone',
'reference' => 'Reference',
'new' => 'New',
),
'#default_value' => 'clone',
);
}
$fields['created'] = BaseFieldDefinition::create('created')
->setRevisionable(TRUE)
->setLabel('Created');
$fields['changed'] = BaseFieldDefinition::create('changed')
->setRevisionable(TRUE)
->setLabel('Changed');
$fields['course_date'] = BaseFieldDefinition::create('daterange')
->setDisplayConfigurable('form', TRUE)
->setRevisionable(TRUE)
->setDisplayOptions('form', [
'type' => 'daterange_default',
])
->setLabel('Course date');
return $fields;
}
/**
* Check if a user is enrolled.
*
* @param AccountInterface $account
* Account to check.
*
* @return bool
* If the user is enrolled.
*/
function isEnrolled(AccountInterface $account) {
return (bool) $this
->getTracker($account);
}
/**
* Enroll a user in this course.
*
* @param AccountInterface $account
* The user to enroll.
* @param array $values
* Any other entity values as they would be passed to
* CourseEnrollment::create().
*
* @return CourseEnrollment
*/
function enroll(AccountInterface $account, $values = []) {
if (!($enrollment = $this
->getEnrollment($account))) {
// User is not enrolled yet.
$enrollment = CourseEnrollment::create([
'cid' => $this
->id(),
'uid' => $account
->id(),
] + $values);
$enrollment
->save();
}
return $enrollment;
}
/**
* Remove a user from this course.
*
* @param AccountInterface $account
*/
function unEnroll(AccountInterface $account) {
return $this
->getTracker($account)
->delete();
}
function delete() {
// Clean up course specific settings and enrollments when a course is
// deleted.
\Drupal::database()
->delete('course_enrollment')
->condition('cid', $this
->id())
->execute();
$query = \Drupal::database()
->select('course_object', 'co');
$query
->join('course_object_fulfillment', 'cof', 'co.coid = cof.coid');
$result = $query
->fields('co')
->condition('co.nid', $this
->id())
->execute();
while ($row = $result
->fetch()) {
\Drupal::database()
->delete('course_object_fulfillment')
->condition('coid', $row->coid)
->execute();
}
\Drupal::database()
->delete('course_object')
->condition('cid', $node
->id())
->execute();
parent::delete();
}
/**
* Load an enrollment.
*
* @todo maybe move to CourseStorage
*
* @param AccountInterface $account
*
* @return \Drupal\course\Entity\CourseEnrollment
*/
function getEnrollment(AccountInterface $account) {
$entities = Drupal::entityTypeManager()
->getStorage('course_enrollment')
->loadByProperties([
'cid' => $this
->id(),
'uid' => $account
->id(),
]);
if ($entities) {
return reset($entities);
}
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
CacheableDependencyTrait:: |
protected | property | Cache contexts. | |
CacheableDependencyTrait:: |
protected | property | Cache max-age. | |
CacheableDependencyTrait:: |
protected | property | Cache tags. | |
CacheableDependencyTrait:: |
protected | function | Sets cacheability; useful for value object constructors. | |
ContentEntityBase:: |
protected | property | Language code identifying the entity active language. | |
ContentEntityBase:: |
protected | property | Local cache for the default language code. | |
ContentEntityBase:: |
protected | property | The default langcode entity key. | |
ContentEntityBase:: |
protected | property | Whether the revision translation affected flag has been enforced. | |
ContentEntityBase:: |
protected | property | Holds untranslatable entity keys such as the ID, bundle, and revision ID. | |
ContentEntityBase:: |
protected | property | Local cache for field definitions. | |
ContentEntityBase:: |
protected | property | The array of fields, each being an instance of FieldItemListInterface. | |
ContentEntityBase:: |
protected static | property | Local cache for fields to skip from the checking for translation changes. | |
ContentEntityBase:: |
protected | property | Indicates whether this is the default revision. | |
ContentEntityBase:: |
protected | property | The language entity key. | |
ContentEntityBase:: |
protected | property | Local cache for the available language objects. | |
ContentEntityBase:: |
protected | property | The loaded revision ID before the new revision was set. | |
ContentEntityBase:: |
protected | property | Boolean indicating whether a new revision should be created on save. | |
ContentEntityBase:: |
protected | property | The revision translation affected entity key. | |
ContentEntityBase:: |
protected | property | Holds translatable entity keys such as the label. | |
ContentEntityBase:: |
protected | property | A flag indicating whether a translation object is being initialized. | |
ContentEntityBase:: |
protected | property | An array of entity translation metadata. | |
ContentEntityBase:: |
protected | property | Whether entity validation was performed. | |
ContentEntityBase:: |
protected | property | Whether entity validation is required before saving the entity. | |
ContentEntityBase:: |
protected | property | The plain data values of the contained fields. | |
ContentEntityBase:: |
public | function |
Checks data value access. Overrides EntityBase:: |
1 |
ContentEntityBase:: |
public | function |
Adds a new translation to the translatable object. Overrides TranslatableInterface:: |
|
ContentEntityBase:: |
public | function |
Gets the bundle of the entity. Overrides EntityBase:: |
|
ContentEntityBase:: |
public static | function |
Provides field definitions for a specific bundle. Overrides FieldableEntityInterface:: |
4 |
ContentEntityBase:: |
protected | function | Clear entity translation object cache to remove stale references. | |
ContentEntityBase:: |
public | function |
Creates a duplicate of the entity. Overrides EntityBase:: |
1 |
ContentEntityBase:: |
public | function |
Gets a field item list. Overrides FieldableEntityInterface:: |
|
ContentEntityBase:: |
protected | function | Gets the value of the given entity key, if defined. | 1 |
ContentEntityBase:: |
public | function |
Gets the definition of a contained field. Overrides FieldableEntityInterface:: |
|
ContentEntityBase:: |
public | function |
Gets an array of field definitions of all contained fields. Overrides FieldableEntityInterface:: |
|
ContentEntityBase:: |
public | function |
Gets an array of all field item lists. Overrides FieldableEntityInterface:: |
|
ContentEntityBase:: |
protected | function | Returns an array of field names to skip in ::hasTranslationChanges. | 1 |
ContentEntityBase:: |
public | function | ||
ContentEntityBase:: |
protected | function | ||
ContentEntityBase:: |
public | function |
Gets the loaded Revision ID of the entity. Overrides RevisionableInterface:: |
|
ContentEntityBase:: |
public | function |
Gets the revision identifier of the entity. Overrides RevisionableInterface:: |
|
ContentEntityBase:: |
public | function |
Gets an array of field item lists for translatable fields. Overrides FieldableEntityInterface:: |
|
ContentEntityBase:: |
protected | function | Gets a translated field. | |
ContentEntityBase:: |
public | function |
Gets a translation of the data. Overrides TranslatableInterface:: |
|
ContentEntityBase:: |
public | function |
Returns the languages the data is translated to. Overrides TranslatableInterface:: |
|
ContentEntityBase:: |
public | function |
Returns the translation status. Overrides TranslationStatusInterface:: |
|
ContentEntityBase:: |
public | function |
Returns the translatable object referring to the original language. Overrides TranslatableInterface:: |
|
ContentEntityBase:: |
public | function |
Determines whether the entity has a field with the given name. Overrides FieldableEntityInterface:: |
|
ContentEntityBase:: |
public | function |
Checks there is a translation for the given language code. Overrides TranslatableInterface:: |
|
ContentEntityBase:: |
public | function |
Determines if the current translation of the entity has unsaved changes. Overrides TranslatableInterface:: |
|
ContentEntityBase:: |
public | function |
Gets the identifier. Overrides EntityBase:: |
|
ContentEntityBase:: |
protected | function | Instantiates a translation object for an existing translation. | |
ContentEntityBase:: |
public | function |
Checks if this entity is the default revision. Overrides RevisionableInterface:: |
|
ContentEntityBase:: |
public | function |
Checks whether the translation is the default one. Overrides TranslatableInterface:: |
|
ContentEntityBase:: |
public | function |
Checks if untranslatable fields should affect only the default translation. Overrides TranslatableRevisionableInterface:: |
|
ContentEntityBase:: |
public | function |
Checks if this entity is the latest revision. Overrides RevisionableInterface:: |
|
ContentEntityBase:: |
public | function |
Checks whether this is the latest revision affecting this translation. Overrides TranslatableRevisionableInterface:: |
|
ContentEntityBase:: |
public | function |
Determines whether a new revision should be created on save. Overrides RevisionableInterface:: |
|
ContentEntityBase:: |
public | function |
Checks whether the translation is new. Overrides TranslatableInterface:: |
|
ContentEntityBase:: |
public | function |
Checks whether the current translation is affected by the current revision. Overrides TranslatableRevisionableInterface:: |
|
ContentEntityBase:: |
public | function |
Checks if the revision translation affected flag value has been enforced. Overrides TranslatableRevisionableInterface:: |
|
ContentEntityBase:: |
public | function |
Returns the translation support status. Overrides TranslatableInterface:: |
|
ContentEntityBase:: |
public | function |
Checks whether entity validation is required before saving the entity. Overrides FieldableEntityInterface:: |
|
ContentEntityBase:: |
public | function |
Gets the label of the entity. Overrides EntityBase:: |
2 |
ContentEntityBase:: |
public | function |
Gets the language of the entity. Overrides EntityBase:: |
|
ContentEntityBase:: |
public | function |
Reacts to changes to a field. Overrides FieldableEntityInterface:: |
|
ContentEntityBase:: |
public | function |
Acts on a created entity before hooks are invoked. Overrides EntityBase:: |
|
ContentEntityBase:: |
public | function |
Acts on a saved entity before the insert or update hook is invoked. Overrides EntityBase:: |
5 |
ContentEntityBase:: |
public | function |
Acts on an entity before the presave hook is invoked. Overrides EntityBase:: |
5 |
ContentEntityBase:: |
public | function |
Acts on a revision before it gets saved. Overrides RevisionableInterface:: |
2 |
ContentEntityBase:: |
public | function |
Gets a list of entities referenced by this entity. Overrides EntityBase:: |
1 |
ContentEntityBase:: |
public | function |
Removes the translation identified by the given language code. Overrides TranslatableInterface:: |
|
ContentEntityBase:: |
public | function |
Sets a field value. Overrides FieldableEntityInterface:: |
|
ContentEntityBase:: |
protected | function | Populates the local cache for the default language code. | |
ContentEntityBase:: |
public | function |
Enforces an entity to be saved as a new revision. Overrides RevisionableInterface:: |
|
ContentEntityBase:: |
public | function |
Marks the current revision translation as affected. Overrides TranslatableRevisionableInterface:: |
|
ContentEntityBase:: |
public | function |
Enforces the revision translation affected flag value. Overrides TranslatableRevisionableInterface:: |
|
ContentEntityBase:: |
public | function |
Sets whether entity validation is required before saving the entity. Overrides FieldableEntityInterface:: |
|
ContentEntityBase:: |
public | function |
Gets an array of all property values. Overrides EntityBase:: |
|
ContentEntityBase:: |
protected | function | Updates language for already instantiated fields. | |
ContentEntityBase:: |
public | function |
Updates the loaded Revision ID with the revision ID. Overrides RevisionableInterface:: |
|
ContentEntityBase:: |
public | function | Updates the original values with the interim changes. | |
ContentEntityBase:: |
public | function |
Gets the entity UUID (Universally Unique Identifier). Overrides EntityBase:: |
|
ContentEntityBase:: |
public | function |
Validates the currently set values. Overrides FieldableEntityInterface:: |
|
ContentEntityBase:: |
public | function |
Checks whether the entity object was a default revision when it was saved. Overrides RevisionableInterface:: |
|
ContentEntityBase:: |
public | function | Magic method: Implements a deep clone. | |
ContentEntityBase:: |
public | function |
Constructs an Entity object. Overrides EntityBase:: |
|
ContentEntityBase:: |
public | function | Implements the magic method for getting object properties. | |
ContentEntityBase:: |
public | function | Implements the magic method for isset(). | |
ContentEntityBase:: |
public | function | Implements the magic method for setting object properties. | |
ContentEntityBase:: |
public | function |
Overrides EntityBase:: |
|
ContentEntityBase:: |
public | function | Implements the magic method for unset(). | |
Course:: |
private | property | ||
Course:: |
private | property | ||
Course:: |
private | property | ||
Course:: |
private | property | ||
Course:: |
private | property | ||
Course:: |
public static | function |
Provides base field definitions for an entity type. Overrides ContentEntityBase:: |
|
Course:: |
function |
Deletes an entity permanently. Overrides EntityBase:: |
||
Course:: |
function | Enroll a user in this course. | ||
Course:: |
public | function | Get the active CourseObject. | |
Course:: |
function | Load an enrollment. | ||
Course:: |
public | function | Generate navigation links. | |
Course:: |
public | function | Get the next course object, from the active course object. | |
Course:: |
public | function | ||
Course:: |
public | function | Get the course objects in this course. | |
Course:: |
public | function | Get the previous course object, from the active course object. | |
Course:: |
public | function | Get the course tracker for this course/user. | |
Course:: |
public | function | The Drupal path to take this course. | |
Course:: |
function | Check if a user is enrolled. | ||
Course:: |
function | |||
Course:: |
public | function | Set the active CourseObject in this Course. | |
Course:: |
function | Remove a user from this course. | ||
DependencySerializationTrait:: |
protected | property | An array of entity type IDs keyed by the property name of their storages. | |
DependencySerializationTrait:: |
protected | property | An array of service IDs keyed by property name used for serialization. | |
DependencySerializationTrait:: |
public | function | Aliased as: traitSleep | 1 |
DependencySerializationTrait:: |
public | function | 2 | |
EntityBase:: |
protected | property | Boolean indicating whether the entity should be forced to be new. | |
EntityBase:: |
protected | property | The entity type. | |
EntityBase:: |
protected | property | A typed data object wrapping this entity. | |
EntityBase:: |
public static | function |
Constructs a new entity object, without permanently saving it. Overrides EntityInterface:: |
|
EntityBase:: |
public | function |
Enforces an entity to be new. Overrides EntityInterface:: |
|
EntityBase:: |
protected | function | Gets the entity manager. | |
EntityBase:: |
protected | function | Gets the entity type bundle info service. | |
EntityBase:: |
protected | function | Gets the entity type manager. | |
EntityBase:: |
public | function |
The cache contexts associated with this object. Overrides CacheableDependencyTrait:: |
|
EntityBase:: |
public | function |
The maximum age for which this object may be cached. Overrides CacheableDependencyTrait:: |
|
EntityBase:: |
public | function |
The cache tags associated with this object. Overrides CacheableDependencyTrait:: |
|
EntityBase:: |
public | function |
Returns the cache tags that should be used to invalidate caches. Overrides EntityInterface:: |
2 |
EntityBase:: |
public | function |
Gets the key that is used to store configuration dependencies. Overrides EntityInterface:: |
|
EntityBase:: |
public | function |
Gets the configuration dependency name. Overrides EntityInterface:: |
1 |
EntityBase:: |
public | function |
Gets the configuration target identifier for the entity. Overrides EntityInterface:: |
1 |
EntityBase:: |
public | function |
Gets the entity type definition. Overrides EntityInterface:: |
|
EntityBase:: |
public | function |
Gets the ID of the type of the entity. Overrides EntityInterface:: |
|
EntityBase:: |
protected | function | The list cache tags to invalidate for this entity. | |
EntityBase:: |
public | function |
Gets the original ID. Overrides EntityInterface:: |
1 |
EntityBase:: |
public | function |
Gets a typed data object for this entity object. Overrides EntityInterface:: |
|
EntityBase:: |
public | function |
Indicates if a link template exists for a given key. Overrides EntityInterface:: |
|
EntityBase:: |
protected static | function | Invalidates an entity's cache tags upon delete. | 1 |
EntityBase:: |
protected | function | Invalidates an entity's cache tags upon save. | 1 |
EntityBase:: |
public | function |
Determines whether the entity is new. Overrides EntityInterface:: |
2 |
EntityBase:: |
protected | function | Gets the language manager. | |
EntityBase:: |
public | function |
Deprecated way of generating a link to the entity. See toLink(). Overrides EntityInterface:: |
1 |
EntityBase:: |
protected | function | Gets an array link templates. | 1 |
EntityBase:: |
public static | function |
Loads an entity. Overrides EntityInterface:: |
|
EntityBase:: |
public static | function |
Loads one or more entities. Overrides EntityInterface:: |
|
EntityBase:: |
public static | function |
Acts on deleted entities before the delete hook is invoked. Overrides EntityInterface:: |
16 |
EntityBase:: |
public static | function |
Acts on loaded entities. Overrides EntityInterface:: |
2 |
EntityBase:: |
public static | function |
Changes the values of an entity before it is created. Overrides EntityInterface:: |
5 |
EntityBase:: |
public static | function |
Acts on entities before they are deleted and before hooks are invoked. Overrides EntityInterface:: |
4 |
EntityBase:: |
public | function |
Saves an entity permanently. Overrides EntityInterface:: |
3 |
EntityBase:: |
public | function |
Sets the original ID. Overrides EntityInterface:: |
1 |
EntityBase:: |
public | function |
Generates the HTML for a link to this entity. Overrides EntityInterface:: |
|
EntityBase:: |
public | function |
Gets the URL object for the entity. Overrides EntityInterface:: |
2 |
EntityBase:: |
public | function |
Gets a list of URI relationships supported by this entity. Overrides EntityInterface:: |
|
EntityBase:: |
public | function |
Gets the public URL for this entity. Overrides EntityInterface:: |
2 |
EntityBase:: |
public | function |
Gets the URL object for the entity. Overrides EntityInterface:: |
1 |
EntityBase:: |
protected | function | Gets an array of placeholders for this entity. | 2 |
EntityBase:: |
protected | function | Gets the UUID generator. | |
EntityChangesDetectionTrait:: |
protected | function | Returns an array of field names to skip when checking for changes. Aliased as: traitGetFieldsToSkipFromTranslationChangesCheck | |
RefinableCacheableDependencyTrait:: |
public | function | 1 | |
RefinableCacheableDependencyTrait:: |
public | function | ||
RefinableCacheableDependencyTrait:: |
public | function | ||
RefinableCacheableDependencyTrait:: |
public | function | ||
SynchronizableEntityTrait:: |
protected | property | Whether this entity is being created, updated or deleted through a synchronization process. | |
SynchronizableEntityTrait:: |
public | function | ||
SynchronizableEntityTrait:: |
public | function | ||
TranslationStatusInterface:: |
constant | Status code identifying a newly created translation. | ||
TranslationStatusInterface:: |
constant | Status code identifying an existing translation. | ||
TranslationStatusInterface:: |
constant | Status code identifying a removed translation. |