class OpignoGroupManagedLink in Opigno group manager 8
Same name and namespace in other branches
- 3.x src/Entity/OpignoGroupManagedLink.php \Drupal\opigno_group_manager\Entity\OpignoGroupManagedLink
Defines the Opigno Group Link entity.
Plugin annotation
@ContentEntityType(
id = "opigno_group_link",
label = @Translation("Opigno Group Link"),
base_table = "opigno_group_link",
entity_keys = {
"id" = "id",
"group_id" = "group_id",
"parent_content_id" = "parent_content_id",
"child_content_id" = "child_content_id",
"required_score" = "required_score",
"required_activities" = "required_activities",
}
)
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\opigno_group_manager\Entity\OpignoGroupManagedLink
- class \Drupal\Core\Entity\ContentEntityBase implements \Drupal\Core\Entity\IteratorAggregate, ContentEntityInterface, TranslationStatusInterface uses EntityChangesDetectionTrait, SynchronizableEntityTrait
Expanded class hierarchy of OpignoGroupManagedLink
1 file declares its use of OpignoGroupManagedLink
- OpignoGroupManagerController.php in src/
Controller/ OpignoGroupManagerController.php
File
- src/
Entity/ OpignoGroupManagedLink.php, line 29
Namespace
Drupal\opigno_group_manager\EntityView source
class OpignoGroupManagedLink extends ContentEntityBase {
/**
* Helper method to create a new LPManagedLink.
*
* It's not saved on creation.
* You have to do $obj->save() to save it in DB.
*
* @param int $group_id
* The group entity ID.
* @param int $parent_content_id
* The parent content ID.
* @param int $child_content_id
* The child content ID.
* @param int $required_score
* The required score to go from the parent to the child content.
*
* @return \Drupal\Core\Entity\EntityInterface|self
* OpignoGroupManagedLink object.
*/
public static function createWithValues($group_id, $parent_content_id, $child_content_id, $required_score = 0, $required_activities = '') {
$values = [
'group_id' => $group_id,
'parent_content_id' => $parent_content_id,
'child_content_id' => $child_content_id,
'required_score' => $required_score,
'required_activities' => $required_activities,
];
return parent::create($values);
}
/**
* Returns group entity ID.
*
* @return int
* The Group entity ID.
*/
public function getGroupId() {
return $this
->get('group_id')->target_id;
}
/**
* Sets group entity ID.
*
* @param int $group_id
* The Group entity ID.
*
* @return $this
*/
public function setGroupId($group_id) {
$this
->set('group_id', $group_id);
return $this;
}
/**
* Returns group entity.
*
* @return \Drupal\group\Entity\Group
* The group entity object.
*/
public function getGroup() {
return $this
->get('group_id')->entity;
}
/**
* Sets group entity.
*
* @param \Drupal\group\Entity\Group $group
* The group entity object.
*
* @return $this
*/
public function setGroup(Group $group) {
$this
->setGroupId($group
->id());
return $this;
}
/**
* Returns parent content ID.
*
* @return int
* The parent content ID.
*/
public function getParentContentId() {
return $this
->get('parent_content_id')->target_id;
}
/**
* Sets parent content ID.
*
* @param int $parent_content_id
* The parent content ID.
*
* @return $this
*/
public function setParentContentId($parent_content_id) {
$this
->set('parent_content_id', $parent_content_id);
return $this;
}
/**
* Returns parent content.
*
* @return OpignoGroupManagedContent
* The parent learning path content object.
*/
public function getParentContent() {
return $this
->get('parent_content_id')->entity;
}
/**
* Sets parent content.
*
* @param OpignoGroupManagedContent $parent_content
* The parent learning path content object.
*
* @return $this
*/
public function setParentContent(OpignoGroupManagedContent $parent_content) {
$this
->setParentContentId($parent_content
->id());
return $this;
}
/**
* Returns child content ID.
*
* @return int
* The child content ID.
*/
public function getChildContentId() {
return $this
->get('child_content_id')->target_id;
}
/**
* Sets child content ID.
*
* @param int $child_content_id
* The child content ID.
*
* @return $this
*/
public function setChildContentId($child_content_id) {
$this
->set('child_content_id', $child_content_id);
return $this;
}
/**
* Returns child content.
*
* @return OpignoGroupManagedContent
* The child content object.
*/
public function getChildContent() {
return $this
->get('child_content_id')->entity;
}
/**
* Sets child content.
*
* @param OpignoGroupManagedContent $child_content
* The child content object.
*
* @return $this
*/
public function setChildContent(OpignoGroupManagedContent $child_content) {
$this
->setChildContentId($child_content
->id());
return $this;
}
/**
* Returns minimum to go score from parent content to child content.
*
* @return int
* The minimum score to go from parent content to child content.
*/
public function getRequiredScore() {
return $this
->get('required_score')->value;
}
/**
* Sets minimum score to go from parent content to child content.
*
* @param int $required_score
* The minimum score to go from parent content to child content.
*
* @return $this
*/
public function setRequiredScore($required_score) {
$this
->set('required_score', $required_score);
return $this;
}
/**
* Gets required activities to go from parent content to child content.
*
* @return mixed
* The required activities ids array.
*/
public function getRequiredActivities() {
return unserialize($this
->get('required_activities')->value);
}
/**
* Sets required activities to go from parent content to child content.
*
* @param string $required_activities
* The required activities ids array.
*
* @return $this
*/
public function setRequiredActivities($required_activities) {
$this
->set('required_activities', $required_activities);
return $this;
}
/**
* {@inheritdoc}
*/
public static function baseFieldDefinitions(EntityTypeInterface $entity_type) {
$fields = parent::baseFieldDefinitions($entity_type);
$fields['group_id'] = BaseFieldDefinition::create('entity_reference')
->setLabel('Group')
->setDescription('The Group entity containing this link')
->setCardinality(1)
->setSetting('target_type', 'group');
$fields['parent_content_id'] = BaseFieldDefinition::create('entity_reference')
->setLabel('The parent group content')
->setDescription('The parent group content')
->setCardinality(1)
->setSetting('target_type', 'opigno_group_content');
$fields['child_content_id'] = BaseFieldDefinition::create('entity_reference')
->setLabel('The child group content')
->setDescription('The child group content')
->setCardinality(1)
->setSetting('target_type', 'opigno_group_content');
$fields['required_score'] = BaseFieldDefinition::create('integer')
->setLabel('Required score')
->setDescription('The required score to go from parent to child content');
$fields['required_activities'] = BaseFieldDefinition::create('string')
->setLabel(t('Required activities'))
->setDescription(t('The required activities of previous step'))
->setSetting('max_length', 8191)
->setDefaultValue(0);
return $fields;
}
/**
* Load one or more LPManagedLink filtered by the properties given in param.
*
* The available properties are the entity_keys
* specified in the header of this class.
*
* Best is to avoid to use this method
* and create a specific method for your search,
* like the method LPManagedContent::loadByLearningPathId.
*
* @param array $properties
* The properties to search for.
*
* @return \Drupal\Core\Entity\EntityInterface[]|self[]
* LPManagedLink objects.
*
* @throws \Drupal\Component\Plugin\Exception\InvalidPluginDefinitionException
* @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
*
* @see LPManagedContent::loadByLearningPathId()
*/
public static function loadByProperties(array $properties) {
return \Drupal::entityTypeManager()
->getStorage('opigno_group_link')
->loadByProperties($properties);
}
}
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(). | |
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 |
Deletes an entity permanently. Overrides EntityInterface:: |
2 |
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 | |
OpignoGroupManagedLink:: |
public static | function |
Provides base field definitions for an entity type. Overrides ContentEntityBase:: |
|
OpignoGroupManagedLink:: |
public static | function | Helper method to create a new LPManagedLink. | |
OpignoGroupManagedLink:: |
public | function | Returns child content. | |
OpignoGroupManagedLink:: |
public | function | Returns child content ID. | |
OpignoGroupManagedLink:: |
public | function | Returns group entity. | |
OpignoGroupManagedLink:: |
public | function | Returns group entity ID. | |
OpignoGroupManagedLink:: |
public | function | Returns parent content. | |
OpignoGroupManagedLink:: |
public | function | Returns parent content ID. | |
OpignoGroupManagedLink:: |
public | function | Gets required activities to go from parent content to child content. | |
OpignoGroupManagedLink:: |
public | function | Returns minimum to go score from parent content to child content. | |
OpignoGroupManagedLink:: |
public static | function | Load one or more LPManagedLink filtered by the properties given in param. | |
OpignoGroupManagedLink:: |
public | function | Sets child content. | |
OpignoGroupManagedLink:: |
public | function | Sets child content ID. | |
OpignoGroupManagedLink:: |
public | function | Sets group entity. | |
OpignoGroupManagedLink:: |
public | function | Sets group entity ID. | |
OpignoGroupManagedLink:: |
public | function | Sets parent content. | |
OpignoGroupManagedLink:: |
public | function | Sets parent content ID. | |
OpignoGroupManagedLink:: |
public | function | Sets required activities to go from parent content to child content. | |
OpignoGroupManagedLink:: |
public | function | Sets minimum score to go from parent content to child content. | |
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. |