class Registrant in RNG - Events and Registrations 8.2
Same name and namespace in other branches
- 8 src/Entity/Registrant.php \Drupal\rng\Entity\Registrant
- 3.x src/Entity/Registrant.php \Drupal\rng\Entity\Registrant
Defines the registrant entity class.
Plugin annotation
@ContentEntityType(
id = "registrant",
label = @Translation("Registrant"),
bundle_label = @Translation("Registrant type"),
bundle_entity_type = "registrant_type",
handlers = {
"storage_schema" = "Drupal\rng\RegistrantStorageSchema",
"views_data" = "Drupal\rng\Views\RegistrantViewsData",
"view_builder" = "Drupal\Core\Entity\EntityViewBuilder",
"route_provider" = {
"html" = "Drupal\rng\Routing\RegistrantRouteProvider",
},
"form" = {
"default" = "Drupal\rng\Form\Entity\RegistrantForm",
"edit" = "Drupal\rng\Form\Entity\RegistrantForm",
"compact" = "Drupal\rng\Form\Entity\RegistrantForm",
"delete" = "Drupal\rng\Form\Entity\RegistrantDeleteForm",
},
},
admin_permission = "administer rng",
base_table = "registrant",
entity_keys = {
"id" = "id",
"uuid" = "uuid",
"bundle" = "type"
},
field_ui_base_route = "entity.registrant_type.edit_form",
links = {
"canonical" = "/registrant/{registrant}",
"edit-form" = "/registrant/{registrant}/edit",
"delete-form" = "/registrant/{registrant}/delete"
},
)
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\rng\Entity\Registrant implements RegistrantInterface
- class \Drupal\Core\Entity\ContentEntityBase implements \Drupal\Core\Entity\IteratorAggregate, ContentEntityInterface, TranslationStatusInterface uses EntityChangesDetectionTrait, SynchronizableEntityTrait
Expanded class hierarchy of Registrant
3 files declare their use of Registrant
- RngEntityModel.php in src/
RngEntityModel.php - RngRegistrantRouteTest.php in src/
Tests/ RngRegistrantRouteTest.php - RngRegistrationEntityTest.php in tests/
src/ Kernel/ RngRegistrationEntityTest.php
4 string references to 'Registrant'
- Registrants::processIdentityElement in src/
Element/ Registrants.php - Process the registrant element.
- RegistrantsElementUtility::peopleTypeOptions in src/
RegistrantsElementUtility.php - Generate available people type options suitable for radios element.
- rng.registrant_type.registrant.yml in config/
install/ rng.registrant_type.registrant.yml - config/install/rng.registrant_type.registrant.yml
- rng_update_8002 in ./
rng.install - Convert registrant entity to one with bundles.
File
- src/
Entity/ Registrant.php, line 49
Namespace
Drupal\rng\EntityView source
class Registrant extends ContentEntityBase implements RegistrantInterface {
/**
* {@inheritdoc}
*/
public function getRegistration() {
return $this
->get('registration')->entity;
}
/**
* {@inheritdoc}
*/
public function setRegistration(RegistrationInterface $registration) {
$this
->set('registration', [
'entity' => $registration,
]);
return $this;
}
/**
* {@inheritdoc}
*/
public function getIdentity() {
return $this
->get('identity')->entity;
}
/**
* {@inheritdoc}
*/
public function getIdentityId() {
return [
'entity_type' => $this
->get('identity')->target_type,
'entity_id' => $this
->get('identity')->target_id,
];
}
/**
* {@inheritdoc}
*/
public function setIdentity(EntityInterface $entity) {
$this
->set('identity', [
'entity' => $entity,
]);
return $this;
}
/**
* {@inheritdoc}
*/
public function clearIdentity() {
$this->identity
->setValue(NULL);
return $this;
}
/**
* {@inheritdoc}
*/
public function hasIdentity(EntityInterface $entity) {
$keys = $this
->getIdentityId();
return $entity
->getEntityTypeId() == $keys['entity_type'] && $entity
->id() == $keys['entity_id'];
}
/**
* {@inheritDoc}
*
* If a value is set on the identity and blank on the registrant, copy values
* from identity to registrant, and vice-versa.
*/
public function preSave(EntityStorageInterface $storage) {
if (!$this
->getRegistration()) {
throw new InvalidRegistrant('Registrant created with no registration.');
}
$event_type = $this
->getRegistration()
->getEventMeta()
->getEventType();
if ($this->event
->isEmpty()) {
$registration = $this
->getRegistration();
$this->event
->setValue([
'target_id' => $registration->event->target_id,
'target_type' => $registration->event->target_type,
]);
}
/** @var \Drupal\Core\Entity\ContentEntityInterface $entity */
$entity = $this
->getIdentity();
if (!$entity && !$event_type
->getAllowAnonRegistrants()) {
throw new InvalidRegistrant('Registrant created with no identity, and anonymous registrants are not allowed.');
}
if (!$entity && $event_type
->getAutoAttachUsers()) {
$email_field = $event_type
->getRegistrantEmailField();
if (!$this
->get($email_field)
->isEmpty()) {
$email = $this
->get($email_field)->value;
$entity = user_load_by_mail($email);
if ($entity) {
$this
->setIdentity($entity);
}
}
}
if ($entity && $event_type
->getAutoSyncRegistrants()) {
$fields = $this
->getFields(FALSE);
$entity_fields = $entity
->getFields(FALSE);
$entity_changed = FALSE;
foreach ($fields as $name => $field) {
if (isset($entity_fields[$name])) {
if (empty($field) && !$entity_fields[$name]) {
$this
->set($name, $entity_fields[$name]);
}
elseif (empty($entity_fields[$name]) && !empty($field)) {
$entity
->set($name, $field);
$entity_changed = TRUE;
}
}
}
if ($entity_changed) {
$entity
->save();
}
}
}
/**
* {@inheritdoc}
*/
public static function getRegistrantsIdsForIdentity(EntityInterface $identity) {
return \Drupal::entityQuery('registrant')
->condition('identity__target_type', $identity
->getEntityTypeId(), '=')
->condition('identity__target_id', $identity
->id(), '=')
->execute();
}
/**
* {@inheritdoc}
*/
public function label() {
$identity = $this
->getIdentity();
if ($identity) {
return t('@type @id', [
'@type' => $identity
->getEntityTypeId(),
'@id' => $identity
->label(),
]);
}
$registration = $this
->getRegistration();
$pattern = $this->type->entity->label_pattern;
if (!empty($pattern)) {
$label = \Drupal::token()
->replace($pattern, [
'registrant' => $this,
'registration' => $registration,
]);
if (!empty(trim($label))) {
return $label;
}
}
if ($registration) {
return $registration
->label();
}
return t('New registrant');
}
/**
* {@inheritdoc}
*/
public static function baseFieldDefinitions(EntityTypeInterface $entity_type) {
$fields = parent::baseFieldDefinitions($entity_type);
$fields['registration'] = BaseFieldDefinition::create('entity_reference')
->setLabel(t('Registration'))
->setDescription(t('The registration associated with this registrant.'))
->setSetting('target_type', 'registration')
->setCardinality(1)
->setReadOnly(TRUE);
$fields['identity'] = BaseFieldDefinition::create('dynamic_entity_reference')
->setLabel(t('Identity'))
->setDescription(t('The person associated with this registrant.'))
->setSetting('exclude_entity_types', 'true')
->setSetting('entity_type_ids', [
'registrant',
'registration',
])
->setCardinality(1)
->setReadOnly(TRUE);
$fields['event'] = BaseFieldDefinition::create('dynamic_entity_reference')
->setLabel(t('Event'))
->setDescription(t('The event for the registrant.'))
->setSetting('exclude_entity_types', 'true')
->setSetting('entity_type_ids', [
'registrant',
'registration',
])
->setDescription(t('The relationship between this registrant and an event.'))
->setRevisionable(TRUE)
->setReadOnly(TRUE);
return $fields;
}
}
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 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 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 | |
RefinableCacheableDependencyTrait:: |
public | function | 1 | |
RefinableCacheableDependencyTrait:: |
public | function | ||
RefinableCacheableDependencyTrait:: |
public | function | ||
RefinableCacheableDependencyTrait:: |
public | function | ||
Registrant:: |
public static | function |
Provides base field definitions for an entity type. Overrides ContentEntityBase:: |
|
Registrant:: |
public | function |
Removes identity associated with this registrant. Overrides RegistrantInterface:: |
|
Registrant:: |
public | function |
Get associated identity. Overrides RegistrantInterface:: |
|
Registrant:: |
public | function |
Get associated identity entity keys. Overrides RegistrantInterface:: |
|
Registrant:: |
public static | function |
Get registrants belonging to an identity. Overrides RegistrantInterface:: |
|
Registrant:: |
public | function |
Get associated registration. Overrides RegistrantInterface:: |
|
Registrant:: |
public | function |
Checks if the identity is the registrant. Overrides RegistrantInterface:: |
|
Registrant:: |
public | function |
Gets the label of the entity. Overrides ContentEntityBase:: |
|
Registrant:: |
public | function |
If a value is set on the identity and blank on the registrant, copy values
from identity to registrant, and vice-versa. Overrides ContentEntityBase:: |
|
Registrant:: |
public | function |
Set associated identity. Overrides RegistrantInterface:: |
|
Registrant:: |
public | function |
Set associated registration. Overrides RegistrantInterface:: |
|
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. |