abstract class CourseObjectNode in Course 3.x
Same name and namespace in other branches
- 8.3 modules/course_content/src/Course/Object/CourseObjectNode.php \Drupal\course_content\Course\Object\CourseObjectNode
- 8.2 modules/course_content/src/Course/Object/CourseObjectNode.php \Drupal\course_content\Course\Object\CourseObjectNode
A course object that uses a node as a base.
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\Helper\CourseHandler
- class \Drupal\course\Entity\CourseObject implements RevisionLogInterface uses EntityChangedTrait, RevisionLogEntityTrait
- class \Drupal\course_content\Course\Object\CourseObjectNode
- class \Drupal\course\Entity\CourseObject implements RevisionLogInterface uses EntityChangedTrait, RevisionLogEntityTrait
- class \Drupal\course\Helper\CourseHandler
- class \Drupal\Core\Entity\ContentEntityBase implements \Drupal\Core\Entity\IteratorAggregate, ContentEntityInterface, TranslationStatusInterface uses EntityChangesDetectionTrait, SynchronizableEntityTrait
Expanded class hierarchy of CourseObjectNode
2 files declare their use of CourseObjectNode
- CourseObjectBook.php in modules/
course_book/ src/ Plugin/ course/ CourseObject/ CourseObjectBook.php - CourseObjectContent.php in modules/
course_content/ src/ Plugin/ course/ CourseObject/ CourseObjectContent.php
File
- modules/
course_content/ src/ Course/ Object/ CourseObjectNode.php, line 25
Namespace
Drupal\course_content\Course\ObjectView source
abstract class CourseObjectNode extends CourseObject {
/**
* Course context handler callback.
*/
public static function context() {
$route_match = Drupal::routeMatch();
if ($route_match
->getRouteName() == 'entity.node.canonical') {
$node = $route_match
->getParameter('node');
$type = NodeType::load($node
->bundle());
if ($type
->getThirdPartySetting('course_content', 'use')) {
if ($courseObject = course_get_course_object('content', $node
->id())) {
return array(
'object_type' => 'content',
'instance' => $node
->id(),
);
}
}
// This node might not be in a course, so let's check for related nodes.
$instances = static::getNodeInstances($node);
if (!empty($instances)) {
$node = Node::load($instances[0]);
// @todo this breaks 'content', need to figure this out
if ($courseObject = course_get_course_object($node
->bundle(), $node
->id())) {
return array(
'object_type' => $node
->bundle(),
'instance' => $node
->id(),
);
}
}
}
}
/**
* When passed a node, this method should return the "parent" nodes that are
* contained in a course outline.
*
* For example, if the passed node was a question in a quiz, all the quiz node
* IDs should be returned.
*/
public static function getNodeInstances($node) {
return array();
}
public function hasNodePrivacySupport() {
return Drupal::moduleHandler()
->moduleExists('content_access') && Drupal::moduleHandler()
->moduleExists('acl');
}
/**
* Return a list of valid node types.
*
* @return array
* An array with node type machine names.
*/
public abstract function getNodeTypes();
/**
* Simple node course object behavior is to just redirect to the node.
*/
public function getTakeType() {
return 'redirect';
}
/**
* {@inheritdoc}
*/
public function getTakeUrl() {
if ($this
->getNode()) {
return Url::fromRoute('entity.node.canonical', [
'node' => $this
->getNode()
->id(),
]);
}
}
/**
* {@inheritdoc}
*/
public function getEditUrl() {
if ($this
->getNode()) {
return Url::fromRoute('entity.node.edit_form', [
'node' => $this
->getNode()
->id(),
]);
}
}
/**
* {@inheritdoc}
*/
public function getViewUrl() {
if ($this
->getNode()) {
return Url::fromRoute('entity.node.canonical', [
'node' => $this
->getNode()
->id(),
]);
}
}
/**
* Create a node and set it as this course object's node.
*
* @param stdClass $node
* A node to be processed for creation, or none to create a generic node. If
* a node is provided, it must have at least a type.
*
* {@inheritdoc}
*/
public function createInstance($node = NULL) {
if (!$node) {
$node = Node::create([
'type' => $this
->getOption('node_type'),
]);
}
$node->title = $this
->getTitle();
$node->uid = Drupal::currentUser()
->id();
$node
->save();
$this
->setInstanceId($node
->id());
}
/**
* Destroy the node instance.
*/
public function deleteInstance() {
$node = Node::load($this
->getInstanceId());
if ($node) {
$node
->delete();
}
}
public function optionsDefinition() {
$defaults = parent::optionsDefinition();
// @todo this also needs to check if the content exists or not
$defaults['private'] = $this
->hasNodePrivacySupport();
$options = array_intersect_key(node_type_get_names(), array_combine($this
->getNodeTypes(), $this
->getNodeTypes()));
$defaults['node_type'] = key($options);
$defaults['use_node_title'] = 0;
$defaults['clone_and_reference'] = 0;
$defaults['use_existing_node'] = 0;
return $defaults;
}
public function optionsForm(&$form, FormStateInterface $form_state) {
parent::optionsForm($form, $form_state);
$form['node'] = array(
'#type' => 'details',
'#title' => t('Content'),
'#description' => 'Settings for course object content.',
'#group' => 'course_tabs',
'#weight' => 2,
);
$config = $this
->getOptions();
$types = array_combine($this
->getNodeTypes(), $this
->getNodeTypes());
$options = array_intersect_key(node_type_get_names(), $types);
$form['node']['use_existing_node'] = array(
'#type' => 'checkbox',
'#title' => t('Use existing content'),
'#default_value' => (bool) $this
->getOption('use_existing_node'),
'#weight' => 1,
'#access' => $this
->isTemporary(),
);
$form['node']['node_type'] = array(
'#title' => t('Create node'),
'#type' => 'select',
'#options' => $options,
'#description' => t('Selecting a node type will automatically create this node and link it to this course object.'),
'#default_value' => $config['node_type'],
'#states' => array(
'visible' => array(
':input[name="use_existing_node"]' => array(
'checked' => FALSE,
),
),
),
'#weight' => 2,
'#access' => $this
->isTemporary(),
);
if (count($options) > 1) {
$form['node']['node_type']['#required'] = TRUE;
}
$form['node']['instance'] = array(
'#title' => t('Existing content'),
'#type' => 'entity_autocomplete',
'#target_type' => 'node',
'#selection_settings' => [
'target_bundles' => $this
->getNodeTypes(),
],
'#description' => t('Use existing content instead of creating a new one.'),
'#default_value' => !empty($this
->getInstanceId()) ? $this
->getNode() : NULL,
'#maxlength' => 255,
'#states' => array(
'visible' => array(
':input[name="use_existing_node"]' => array(
'checked' => TRUE,
),
),
),
'#weight' => 3,
);
if (Drupal::moduleHandler()
->moduleExists('clone') && !$this
->getInstanceId()) {
$form['node']['clone_and_reference'] = array(
'#title' => t('Clone and reference'),
'#type' => 'checkbox',
'#description' => t('This will clone the selected content first.'),
'#default_value' => $config['clone_and_reference'],
'#weight' => 4,
'#states' => array(
'visible' => array(
':input[name="use_existing_node"]' => array(
'checked' => TRUE,
),
),
),
);
}
$form['node']['use_node_title'] = array(
'#type' => 'checkbox',
'#title' => t('Use existing title'),
'#description' => t("Use the referenced content's title as this course object's title."),
'#default_value' => $config['use_node_title'],
'#weight' => 5,
);
$form['node']['private'] = array(
'#title' => t('Private'),
'#description' => $this
->hasNodePrivacySupport() ? t('This content will not be available to users who are not enrolled in this course.') : t('You must enable content_access and acl in order to restrict course content to users who are enrolled in this course.'),
'#type' => 'checkbox',
'#default_value' => $config['private'],
'#disabled' => !$this
->hasNodePrivacySupport(),
'#weight' => 6,
);
$nid = $this
->getInstanceId();
if ($nid) {
$node = Node::load($nid);
$url = Url::fromRoute('entity.node.canonical', [
'node' => $node
->id(),
], array(
'attributes' => array(
'target' => '_blank',
'title' => t('Open in new window'),
),
));
$link = Link::fromTextAndUrl(t("'%title' [node id %nid]", array(
'%title' => $node
->get('title')
->getString(),
'%nid' => $node
->id(),
)), $url)
->toString();
$form['node']['instance']['#description'] = t('Currently set to @link', array(
'@link' => $link,
));
}
}
/**
* Validate the options form. Check the node type.
*/
public function optionsValidate(&$form, FormStateInterface $form_state) {
parent::optionsValidate($form, $form_state);
$nid = $form_state
->getValues()['instance'];
if (empty($nid) && isset($form_state
->getValues()['node_type']) && empty($form_state
->getValues()['node_type'])) {
$form_state
->setErrorByName('node_type', t('Please select a node type.'));
}
if (($form_state
->getValues()['use_existing_node'] || !$this
->isTemporary()) && empty($nid)) {
$form_state
->setErrorByName('instance', t('Please select a node.'));
}
}
public function optionsSubmit(&$form, FormStateInterface $form_state) {
if ($form_state
->getValue('instance')) {
$nid = $form_state
->getValue('instance');
if (!is_numeric($nid)) {
if (preg_match('/^(?:\\s*|(.*) )?\\[\\s*nid\\s*:\\s*(\\d+)\\s*\\]$/', $nid, $matches)) {
$nid = $matches[2];
}
}
if ($nid) {
$form_state
->setValue('instance', $nid);
}
else {
// Unset it, or we'll erase the relationship (since the textfield is
// actually blank).
$form_state
->unsetValue('instance');
}
}
parent::optionsSubmit($form, $form_state);
}
/**
* Clone a node before saving.
*
* {@inheritdoc}
*/
function preSave(EntityStorageInterface $storage, $update = TRUE) {
if ($this
->getOption('clone_and_reference')) {
module_load_include('inc', 'clone', 'clone.pages');
$new_nid = clone_node_save($this
->getOption('instance'));
$this
->setInstanceId($new_nid);
$this
->setOption('clone_and_reference', 0);
}
parent::preSave($storage, $update);
}
/**
* On object write, set privacy on this node.
*
* {@inheritdoc}
*/
function postSave(EntityStorageInterface $storage, $update = TRUE) {
$privacy_enabled = $this
->hasNodePrivacySupport() && $this
->getOption('private');
$external_node = $this
->getInstanceId() > 0;
if ($privacy_enabled && $external_node) {
\Drupal::entityTypeManager()
->getAccessControlHandler('node')
->resetCache();
}
parent::postSave($storage, $update);
}
/**
* Freeze data to persist over cloning/exporting.
* @return array
* An array of data to be frozen.
*/
function freeze() {
if ($this
->getInstanceId() != $this
->getCourse()
->getNode()->nid) {
// Don't freeze the course, if this course is part of the objects.
$ice = new stdClass();
$ice->node = $this
->getNode();
return $ice;
}
}
/**
* Thaw data frozen from an earlier export/clone.
*
* @param array $data
* Unfrozen data.
*
* @return int
* The new instance ID.
*/
function thaw($ice) {
$node = $ice->node;
unset($node->nid);
unset($node->vid);
// Let other modules do special fixing up.
$context = array(
'method' => 'save-edit',
);
Drupal::moduleHandler()
->alter('clone_node', $node, $context);
node_save($node);
$this
->setInstanceId($node
->id());
return $this
->getInstanceId();
}
function getCloneAbility() {
return t('%object will be cloned as a node. Results may vary.', array(
'%object' => $this
->getTitle(),
));
}
/**
* Get the object title, or return this object's node's title if the option
* is set.
*/
function getTitle() {
if ($this
->getOption('use_node_title') && $this
->getNode()) {
return $this
->getNode()->title;
}
else {
return parent::getTitle();
}
}
/**
* Get this node object's node.
*
* @return NodeInterface
*/
function getNode() {
return Node::load($this
->get('instance')
->getString());
}
/**
* Make the "Edit instance" link use a dialog.
*
* {@inheritdoc}
*/
function getOptionsSummary() {
$summary = parent::getOptionsSummary();
if (is_a($summary['instance'], GeneratedLink::class)) {
$url = $this
->getEditUrl();
$url
->setOption('query', \Drupal::service('redirect.destination')
->getAsArray());
$url
->setOption('attributes', [
'class' => 'use-ajax',
'data-dialog-type' => 'modal',
'data-dialog-options' => Json::encode([
'width' => 800,
]),
]);
$link = Link::fromTextAndUrl(t('Edit instance'), $url)
->toString();
$summary['instance'] = $link;
}
return $summary;
}
/**
* Show a warning if this object has an instance, but the node does not exist.
*/
function getWarnings() {
$warnings = parent::getWarnings();
if ($this
->getInstanceId() && !$this
->getNode()) {
$warnings[] = t('The content associated with this object has been deleted.<br/>Saving the course will create new content from the object settings.');
}
return $warnings;
}
/**
* Deny access to objects without content.
*
* @todo conflicts with core D8
*/
function Xaccess($op = 'view', $account = NULL) {
if ($op == 'take' && !$this
->getNode()) {
return FALSE;
}
return parent::access($op, $account);
}
}
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:: |
6 |
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 revision before it gets saved. Overrides RevisionableInterface:: |
3 |
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:: |
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:: |
1 |
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(). | |
CourseHandler:: |
final public | function | Merge an array of options onto the existing options. | |
CourseHandler:: |
public | function | Get an array of access messages. | |
CourseHandler:: |
public | function | Get an handler option's value. | |
CourseHandler:: |
private | function | Merge arrays with replace, not append. | |
CourseHandler:: |
public | function | Set an access message to be displayed along with the course object when it is in the outline. For example, "This activity will open on XYZ" or "Please complete Step 1 to take this activity." | |
CourseHandler:: |
public | function | Set an option for this handler. | |
CourseHandler:: |
final public | function | Set this entire handler's options. | |
CourseObject:: |
protected | property | ||
CourseObject:: |
public static | function |
Provides base field definitions for an entity type. Overrides ContentEntityBase:: |
|
CourseObject:: |
function | Get the object component for this course object. | ||
CourseObject:: |
function | Get the object component title for this course object. | ||
CourseObject:: |
function | Get the Course that contains this CourseObject. | ||
CourseObject:: |
public | function |
Map this object base to the base entity class. Overrides RevisionLogEntityTrait:: |
|
CourseObject:: |
public | function | Get a user's fulfillment for this course object. If the user has not started this course object, a new, unsaved fulfillment will be return. | |
CourseObject:: |
function | Get the instance ID. This could be the external component ID, a Node ID... | ||
CourseObject:: |
public static | function | Return the number of occurances that can be in a course at the same time. For example, the design of the Certificate module can only have 1 set of mappings per node. The same goes for Course Credit. We may also want a course object that can only be… | 2 |
CourseObject:: |
public | function |
Get options, with session options, except weight, having precedence. Overrides CourseHandler:: |
|
CourseObject:: |
public | function | ||
CourseObject:: |
public | function | Get read-only options. These options have been processed by plugins and may have changed from their definitions. | |
CourseObject:: |
function | Let the course object provide its own reports. | 3 | |
CourseObject:: |
function | Let the course object provide its own reports. | 3 | |
CourseObject:: |
public | function | Get the user's status in this course object. | 2 |
CourseObject:: |
public | function | Return the URL to the course object router. | |
CourseObject:: |
public | function | Specify whether fulfillment uses asynchronous polling. | 2 |
CourseObject:: |
public | function | ||
CourseObject:: |
public | function | Check if the course object is enabled. | |
CourseObject:: |
function | Is this object graded? | 2 | |
CourseObject:: |
public | function | Is this course object required for course completion? | |
CourseObject:: |
public | function | If this course object is required, can be it skipped? | |
CourseObject:: |
function | Checks the temporary status of a course object. | ||
CourseObject:: |
public | function | If this course object is required, can be it skipped? | |
CourseObject:: |
private | function | ||
CourseObject:: |
public | function | Override navigation links. | 1 |
CourseObject:: |
public | function | Overrides a course outline list item. | 1 |
CourseObject:: |
function | Give the course object a chance do asynchronous polling and set completion on demand. | ||
CourseObject:: |
public static | function |
Acts on deleted entities before the delete hook is invoked. Overrides EntityBase:: |
|
CourseObject:: |
public | function | Get all course object implementations of getOptionsSummary(). | |
CourseObject:: |
public | function |
Apply configuration from session and let objects create their instances
before saving the course object. Overrides EntityBase:: |
1 |
CourseObject:: |
function |
Set field in extra data if needed. Overrides ContentEntityBase:: |
||
CourseObject:: |
function | Set the object component for this course object. | ||
CourseObject:: |
public | function | Set the Course for this CourseObject. | |
CourseObject:: |
public | function | Mark this object for deletion. | |
CourseObject:: |
function | Set the internal course object ID. | ||
CourseObject:: |
function | Set this object's instance ID. | ||
CourseObject:: |
public | function | Course object entry point for taking. This method should return a value corresponding to the type set in getTakeType(). | 7 |
CourseObject:: |
final public | function | Take a course object. | |
CourseObject:: |
public | function | Generate URI from course object. | |
CourseObjectNode:: |
public static | function |
Course context handler callback. Overrides CourseObject:: |
|
CourseObjectNode:: |
public | function |
Create a node and set it as this course object's node. Overrides CourseObject:: |
1 |
CourseObjectNode:: |
public | function |
Destroy the node instance. Overrides CourseObject:: |
|
CourseObjectNode:: |
function |
Freeze data to persist over cloning/exporting. Overrides CourseObject:: |
1 | |
CourseObjectNode:: |
function |
Returns an translated error message if this object has issues with cloning. Overrides CourseObject:: |
1 | |
CourseObjectNode:: |
public | function |
Get the URL to edit this course object, if any. Overrides CourseObject:: |
|
CourseObjectNode:: |
function | Get this node object's node. | ||
CourseObjectNode:: |
public static | function | When passed a node, this method should return the "parent" nodes that are contained in a course outline. | 1 |
CourseObjectNode:: |
abstract public | function | Return a list of valid node types. | 2 |
CourseObjectNode:: |
function |
Make the "Edit instance" link use a dialog. Overrides CourseObject:: |
||
CourseObjectNode:: |
public | function |
Simple node course object behavior is to just redirect to the node. Overrides CourseObject:: |
|
CourseObjectNode:: |
public | function |
Get the URL to take this course object, if any. Overrides CourseObject:: |
|
CourseObjectNode:: |
function |
Get the object title, or return this object's node's title if the option
is set. Overrides CourseObject:: |
||
CourseObjectNode:: |
public | function |
Get the URL to view this course object, if any. Overrides CourseObject:: |
|
CourseObjectNode:: |
function |
Show a warning if this object has an instance, but the node does not exist. Overrides CourseHandler:: |
||
CourseObjectNode:: |
public | function | ||
CourseObjectNode:: |
public | function |
Define configuration elements and their defaults. Overrides CourseObject:: |
2 |
CourseObjectNode:: |
public | function |
Default options form for all course objects. Overrides CourseObject:: |
1 |
CourseObjectNode:: |
public | function |
Save object configs to cache. Overrides CourseObject:: |
|
CourseObjectNode:: |
public | function |
Validate the options form. Check the node type. Overrides CourseObject:: |
|
CourseObjectNode:: |
function |
On object write, set privacy on this node. Overrides CourseObject:: |
||
CourseObjectNode:: |
function |
Clone a node before saving. Overrides ContentEntityBase:: |
||
CourseObjectNode:: |
function |
Thaw data frozen from an earlier export/clone. Overrides CourseObject:: |
||
CourseObjectNode:: |
function | Deny access to objects without content. | ||
DependencySerializationTrait:: |
protected | property | ||
DependencySerializationTrait:: |
protected | property | ||
DependencySerializationTrait:: |
public | function | Aliased as: traitSleep | 2 |
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 |
Deletes an entity permanently. Overrides EntityInterface:: |
2 |
EntityBase:: |
public | function |
Enforces an entity to be new. Overrides EntityInterface:: |
|
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:: |
4 |
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 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:: |
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 loaded entities. Overrides EntityInterface:: |
2 |
EntityBase:: |
public static | function |
Changes the values of an entity before it is created. Overrides EntityInterface:: |
7 |
EntityBase:: |
public static | function |
Acts on entities before they are deleted and before hooks are invoked. Overrides EntityInterface:: |
6 |
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:: |
protected | function | Gets an array of placeholders for this entity. | 2 |
EntityBase:: |
protected | function | Gets the UUID generator. | |
EntityChangedTrait:: |
public | function | Gets the timestamp of the last entity change for the current translation. | |
EntityChangedTrait:: |
public | function | Returns the timestamp of the last entity change across all translations. | |
EntityChangedTrait:: |
public | function | Sets the timestamp of the last entity change for the current translation. | |
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 | ||
RevisionLogEntityTrait:: |
public | function | Implements \Drupal\Core\Entity\RevisionLogInterface::getRevisionCreationTime(). | 1 |
RevisionLogEntityTrait:: |
public | function | Implements \Drupal\Core\Entity\RevisionLogInterface::getRevisionLogMessage(). | 1 |
RevisionLogEntityTrait:: |
protected static | function | Gets the name of a revision metadata field. | |
RevisionLogEntityTrait:: |
public | function | Implements \Drupal\Core\Entity\RevisionLogInterface::getRevisionUser(). | 1 |
RevisionLogEntityTrait:: |
public | function | Implements \Drupal\Core\Entity\RevisionLogInterface::getRevisionUserId(). | 1 |
RevisionLogEntityTrait:: |
public static | function | Provides revision-related base field definitions for an entity type. | |
RevisionLogEntityTrait:: |
public | function | Implements \Drupal\Core\Entity\RevisionLogInterface::setRevisionCreationTime(). | 1 |
RevisionLogEntityTrait:: |
public | function | Implements \Drupal\Core\Entity\RevisionLogInterface::setRevisionLogMessage(). | 1 |
RevisionLogEntityTrait:: |
public | function | Implements \Drupal\Core\Entity\RevisionLogInterface::setRevisionUser(). | 1 |
RevisionLogEntityTrait:: |
public | function | Implements \Drupal\Core\Entity\RevisionLogInterface::setRevisionUserId(). | 1 |
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. |