class CivicrmEntityStorageSchema in CiviCRM Entity 8.3
Implementation of the SqlContentEntityStorageSchema for CiviCRM entities.
This allows CiviCRM entities to support dedicated field storage while using CiviCRM for full data of the entity.
Hierarchy
- class \Drupal\Core\Entity\Sql\SqlContentEntityStorageSchema implements DynamicallyFieldableEntityStorageSchemaInterface uses DependencySerializationTrait, DeprecatedServicePropertyTrait, SqlFieldableEntityTypeListenerTrait
- class \Drupal\civicrm_entity\Entity\Sql\CivicrmEntityStorageSchema
Expanded class hierarchy of CivicrmEntityStorageSchema
1 file declares its use of CivicrmEntityStorageSchema
- civicrm_entity.module in ./
civicrm_entity.module - Module file for the CiviCRM Entity module.
File
- src/
Entity/ Sql/ CivicrmEntityStorageSchema.php, line 15
Namespace
Drupal\civicrm_entity\Entity\SqlView source
class CivicrmEntityStorageSchema extends SqlContentEntityStorageSchema {
/**
* The storage object for the given entity type.
*
* @var \Drupal\civicrm_entity\CiviEntityStorage
*/
protected $storage;
/**
* {@inheritdoc}
*/
public function onEntityTypeCreate(EntityTypeInterface $entity_type) {
$this
->checkEntityType($entity_type);
// Create dedicated field tables.
$table_mapping = $this->storage
->getTableMapping();
foreach ($this->fieldStorageDefinitions as $field_storage_definition) {
if ($table_mapping
->requiresDedicatedTableStorage($field_storage_definition)) {
$this
->createDedicatedTableSchema($field_storage_definition);
}
}
}
/**
* {@inheritdoc}
*/
public function onEntityTypeUpdate(EntityTypeInterface $entity_type, EntityTypeInterface $original) {
$this
->checkEntityType($entity_type);
$this
->checkEntityType($original);
}
/**
* {@inheritdoc}
*/
public function requiresEntityStorageSchemaChanges(EntityTypeInterface $entity_type, EntityTypeInterface $original) {
return FALSE;
}
/**
* {@inheritdoc}
*/
public function requiresFieldStorageSchemaChanges(FieldStorageDefinitionInterface $storage_definition, FieldStorageDefinitionInterface $original) {
return FALSE;
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
CivicrmEntityStorageSchema:: |
protected | property |
The storage object for the given entity type. Overrides SqlContentEntityStorageSchema:: |
|
CivicrmEntityStorageSchema:: |
public | function |
Reacts to the creation of the entity type. Overrides SqlContentEntityStorageSchema:: |
|
CivicrmEntityStorageSchema:: |
public | function |
Reacts to the update of the entity type. Overrides SqlContentEntityStorageSchema:: |
|
CivicrmEntityStorageSchema:: |
public | function |
Checks if the changes to the entity type requires storage schema changes. Overrides SqlContentEntityStorageSchema:: |
|
CivicrmEntityStorageSchema:: |
public | function |
Checks if the changes to the storage definition requires schema changes. Overrides SqlContentEntityStorageSchema:: |
|
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 | 1 | |
DependencySerializationTrait:: |
public | function | 2 | |
DeprecatedServicePropertyTrait:: |
public | function | Allows to access deprecated/removed properties. | |
SqlContentEntityStorageSchema:: |
protected | property | The database connection to be used. | |
SqlContentEntityStorageSchema:: |
protected | property | The deleted fields repository. | |
SqlContentEntityStorageSchema:: |
protected | property | ||
SqlContentEntityStorageSchema:: |
protected | property | The entity field manager service. | |
SqlContentEntityStorageSchema:: |
protected | property | The entity type this schema builder is responsible for. | |
SqlContentEntityStorageSchema:: |
protected | property | The entity type manager. | |
SqlContentEntityStorageSchema:: |
protected | property | The storage field definitions for this entity type. | |
SqlContentEntityStorageSchema:: |
protected | property | The key-value collection for tracking installed storage schema. | |
SqlContentEntityStorageSchema:: |
protected | property | A static cache of the generated schema array. | |
SqlContentEntityStorageSchema:: |
protected | property | The key-value collection for tracking entity update backup repository. | |
SqlContentEntityStorageSchema:: |
protected | function | Creates an index, dropping it if already existing. | |
SqlContentEntityStorageSchema:: |
protected | function | Adds a foreign key for the specified field to the given schema definition. | |
SqlContentEntityStorageSchema:: |
protected | function | Adds an index for the specified field to the given schema definition. | |
SqlContentEntityStorageSchema:: |
protected | function | Adds a unique key for the specified field to the given schema definition. | |
SqlContentEntityStorageSchema:: |
protected | function | Adds defaults to a table schema definition. | |
SqlContentEntityStorageSchema:: |
protected | function | Creates a unique key, dropping it if already existing. | |
SqlContentEntityStorageSchema:: |
public static | function | Typecasts values to proper datatypes. | |
SqlContentEntityStorageSchema:: |
protected | function | Checks that we are dealing with the correct entity type. | |
SqlContentEntityStorageSchema:: |
protected | function | Creates the schema for a field stored in a dedicated table. | |
SqlContentEntityStorageSchema:: |
protected | function | Creates the specified entity schema indexes and keys. | |
SqlContentEntityStorageSchema:: |
protected | function | Creates the schema for a field stored in a shared table. | |
SqlContentEntityStorageSchema:: |
protected | function | Deletes the schema for a field stored in a dedicated table. | |
SqlContentEntityStorageSchema:: |
protected | function | Gets the deleted fields repository. | |
SqlContentEntityStorageSchema:: |
protected | function | Deletes schema data for the given entity type definition. | |
SqlContentEntityStorageSchema:: |
protected | function | Deletes the specified entity schema indexes and keys. | |
SqlContentEntityStorageSchema:: |
protected | function | Deletes schema data for the given field storage definition. | |
SqlContentEntityStorageSchema:: |
protected | function | Deletes the schema for a field stored in a shared table. | |
SqlContentEntityStorageSchema:: |
public | function |
Performs final cleanup after all data of a field has been purged. Overrides DynamicallyFieldableEntityStorageSchemaInterface:: |
|
SqlContentEntityStorageSchema:: |
protected | function | Returns a list of column schema keys affecting data storage. | |
SqlContentEntityStorageSchema:: |
protected | function | Gets the SQL schema for a dedicated table. | 1 |
SqlContentEntityStorageSchema:: |
protected | function | Gets the name to be used for the given entity index. | |
SqlContentEntityStorageSchema:: |
protected | function | Gets the entity schema for the specified entity type. | 7 |
SqlContentEntityStorageSchema:: |
protected | function | Gets entity schema definitions for index and key definitions. | |
SqlContentEntityStorageSchema:: |
protected | function | Gets a list of entity type tables. | |
SqlContentEntityStorageSchema:: |
protected | function | Gets field foreign keys. | |
SqlContentEntityStorageSchema:: |
protected | function | Gets an index schema array for a given field. | |
SqlContentEntityStorageSchema:: |
protected | function | Generates an index name for a field data table. | |
SqlContentEntityStorageSchema:: |
protected | function | Gets field schema data for the given key. | |
SqlContentEntityStorageSchema:: |
protected | function | Generates a safe schema identifier (name of an index, column name etc.). | |
SqlContentEntityStorageSchema:: |
protected | function | Gets a unique key schema array for a given field. | |
SqlContentEntityStorageSchema:: |
protected | function | Gets the schema data for the given field storage definition. | |
SqlContentEntityStorageSchema:: |
protected | function | Returns a SELECT query suitable for inserting data into a dedicated table. | |
SqlContentEntityStorageSchema:: |
protected | function | Gets the schema for a single field definition. | 9 |
SqlContentEntityStorageSchema:: |
protected | function | Refreshes the table mapping with updated definitions. | |
SqlContentEntityStorageSchema:: |
private | function | Gets a list of table names for this entity type, field storage and mapping. | |
SqlContentEntityStorageSchema:: |
public static | function | Gets a string to be used as a prefix for a temporary table mapping object. | |
SqlContentEntityStorageSchema:: |
protected | function |
Handles the case when an error occurs during the data copying step. Overrides SqlFieldableEntityTypeListenerTrait:: |
|
SqlContentEntityStorageSchema:: |
protected | function | Compares schemas to check for changes in the column definitions. | |
SqlContentEntityStorageSchema:: |
protected | function | Checks whether a field property has NULL values. | |
SqlContentEntityStorageSchema:: |
protected | function | Detects whether any table name got renamed in an entity type update. | |
SqlContentEntityStorageSchema:: |
protected | function | Detects whether there is a change in the shared table structure. | |
SqlContentEntityStorageSchema:: |
protected | function | Initializes common information for a base table. | |
SqlContentEntityStorageSchema:: |
protected | function | Initializes common information for a data table. | |
SqlContentEntityStorageSchema:: |
protected | function | Initializes common information for a revision data table. | |
SqlContentEntityStorageSchema:: |
protected | function | Initializes common information for a revision table. | |
SqlContentEntityStorageSchema:: |
protected | function | Gets the keyvalue collection for tracking the installed schema. | |
SqlContentEntityStorageSchema:: |
protected | function | Checks whether a database table is non-existent or empty. | |
SqlContentEntityStorageSchema:: |
protected | function | Loads stored schema data for the given entity type definition. | |
SqlContentEntityStorageSchema:: |
protected | function | Loads stored schema data for the given field storage definition. | |
SqlContentEntityStorageSchema:: |
public | function |
Reacts to the deletion of the entity type. Overrides EntityTypeListenerInterface:: |
|
SqlContentEntityStorageSchema:: |
public | function |
Reacts to the creation of the fieldable entity type. Overrides EntityTypeListenerInterface:: |
|
SqlContentEntityStorageSchema:: |
public | function |
Reacts to the update of a fieldable entity type. Overrides EntityTypeListenerInterface:: |
|
SqlContentEntityStorageSchema:: |
public | function |
Reacts to the creation of a field storage definition. Overrides FieldStorageDefinitionListenerInterface:: |
|
SqlContentEntityStorageSchema:: |
public | function |
Reacts to the deletion of a field storage definition. Overrides FieldStorageDefinitionListenerInterface:: |
|
SqlContentEntityStorageSchema:: |
public | function |
Reacts to the update of a field storage definition. Overrides FieldStorageDefinitionListenerInterface:: |
|
SqlContentEntityStorageSchema:: |
protected | function | Performs the specified operation on a field. | |
SqlContentEntityStorageSchema:: |
protected | function |
Allows subscribers to do any cleanup necessary after data copying. Overrides SqlFieldableEntityTypeListenerTrait:: |
|
SqlContentEntityStorageSchema:: |
protected | function |
Allows subscribers to prepare their schema before data copying. Overrides SqlFieldableEntityTypeListenerTrait:: |
|
SqlContentEntityStorageSchema:: |
protected | function | Processes the gathered schema for a base table. | |
SqlContentEntityStorageSchema:: |
protected | function | Processes the gathered schema for a base table. | |
SqlContentEntityStorageSchema:: |
protected | function | Processes the schema for a field storage definition. | |
SqlContentEntityStorageSchema:: |
protected | function | Processes the specified entity key. | 1 |
SqlContentEntityStorageSchema:: |
protected | function | Processes the gathered schema for a base table. | |
SqlContentEntityStorageSchema:: |
protected | function | Processes the gathered schema for a base table. | |
SqlContentEntityStorageSchema:: |
public | function |
Checks if existing data would be lost if the schema changes were applied. Overrides EntityStorageSchemaInterface:: |
|
SqlContentEntityStorageSchema:: |
public | function |
Checks if existing data would be lost if the schema changes were applied. Overrides DynamicallyFieldableEntityStorageSchemaInterface:: |
|
SqlContentEntityStorageSchema:: |
protected | function | Stores schema data for the given entity type definition. | |
SqlContentEntityStorageSchema:: |
protected | function | Stores schema data for the given field storage definition. | |
SqlContentEntityStorageSchema:: |
protected | function | Gets the key/value collection for tracking the entity update backups. | |
SqlContentEntityStorageSchema:: |
protected | function | Updates the schema for a field stored in a shared table. | |
SqlContentEntityStorageSchema:: |
protected | function | Updates the schema for a field stored in a shared table. | |
SqlContentEntityStorageSchema:: |
public | function | Constructs a SqlContentEntityStorageSchema. | |
SqlFieldableEntityTypeListenerTrait:: |
protected | function | Copies entity data from the original storage to the temporary one. | |
SqlFieldableEntityTypeListenerTrait:: |
public | function | Aliased as: traitOnFieldableEntityTypeUpdate |