class FieldInheritance in Field Inheritance 8
Same name in this branch
- 8 src/Annotation/FieldInheritance.php \Drupal\field_inheritance\Annotation\FieldInheritance
- 8 src/Entity/FieldInheritance.php \Drupal\field_inheritance\Entity\FieldInheritance
Same name and namespace in other branches
- 2.0.x src/Entity/FieldInheritance.php \Drupal\field_inheritance\Entity\FieldInheritance
Defines the Field inheritance entity.
Plugin annotation
@ConfigEntityType(
id = "field_inheritance",
label = @Translation("Field inheritance"),
handlers = {
"view_builder" = "Drupal\Core\Entity\EntityViewBuilder",
"list_builder" = "Drupal\field_inheritance\FieldInheritanceListBuilder",
"form" = {
"add" = "Drupal\field_inheritance\Form\FieldInheritanceForm",
"edit" = "Drupal\field_inheritance\Form\FieldInheritanceForm",
"ajax" = "Drupal\field_inheritance\Form\FieldInheritanceAjaxForm",
"delete" = "Drupal\field_inheritance\Form\FieldInheritanceDeleteForm"
},
"route_provider" = {
"html" = "Drupal\field_inheritance\FieldInheritanceHtmlRouteProvider",
},
},
config_prefix = "field_inheritance",
admin_permission = "administer site configuration",
entity_keys = {
"id" = "id",
"label" = "label",
"uuid" = "uuid"
},
links = {
"canonical" = "/admin/structure/field_inheritance/{field_inheritance}",
"add-form" = "/admin/structure/field_inheritance/add",
"edit-form" = "/admin/structure/field_inheritance/{field_inheritance}/edit",
"delete-form" = "/admin/structure/field_inheritance/{field_inheritance}/delete",
"collection" = "/admin/structure/field_inheritance"
},
config_export = {
"id",
"label",
"type",
"sourceEntityType",
"destinationEntityType",
"sourceEntityBundle",
"destinationEntityBundle",
"sourceField",
"destinationField",
"plugin"
}
)
Hierarchy
- class \Drupal\Core\Entity\EntityBase implements EntityInterface uses RefinableCacheableDependencyTrait, DependencySerializationTrait
- class \Drupal\Core\Config\Entity\ConfigEntityBase implements ConfigEntityInterface uses SynchronizableEntityTrait, PluginDependencyTrait
- class \Drupal\field_inheritance\Entity\FieldInheritance implements FieldInheritanceInterface
- class \Drupal\Core\Config\Entity\ConfigEntityBase implements ConfigEntityInterface uses SynchronizableEntityTrait, PluginDependencyTrait
Expanded class hierarchy of FieldInheritance
File
- src/
Entity/ FieldInheritance.php, line 54
Namespace
Drupal\field_inheritance\EntityView source
class FieldInheritance extends ConfigEntityBase implements FieldInheritanceInterface {
/**
* The field inheritance ID.
*
* @var string
*/
protected $id;
/**
* The field inheritance label.
*
* @var string
*/
protected $label;
/**
* The field inheritance type.
*
* @var string
*/
protected $type;
/**
* The field inheritance source entity type.
*
* @var string
*/
protected $sourceEntityType;
/**
* The field inheritance destination entity type.
*
* @var string
*/
protected $destinationEntityType;
/**
* The field inheritance source entity bundle.
*
* @var string
*/
protected $sourceEntityBundle;
/**
* The field inheritance destination entity bundle.
*
* @var string
*/
protected $destinationEntityBundle;
/**
* The field inheritance source field.
*
* @var string
*/
protected $sourceField;
/**
* The field inheritance destination field.
*
* @var string
*/
protected $destinationField;
/**
* The field inheritance plugin.
*
* @var string
*/
protected $plugin;
/**
* {@inheritdoc}
*/
public function type() {
return isset($this->type) ? $this->type : NULL;
}
/**
* {@inheritdoc}
*/
public function idWithoutTypeAndBundle() {
$prefix = $this
->destinationEntityType() . '_' . $this
->destinationEntityBundle() . '_';
return str_replace($prefix, '', $this
->id());
}
/**
* {@inheritdoc}
*/
public function sourceEntityType() {
return isset($this->sourceEntityType) ? $this->sourceEntityType : NULL;
}
/**
* {@inheritdoc}
*/
public function destinationEntityType() {
return isset($this->destinationEntityType) ? $this->destinationEntityType : NULL;
}
/**
* {@inheritdoc}
*/
public function sourceEntityBundle() {
return isset($this->sourceEntityBundle) ? $this->sourceEntityBundle : NULL;
}
/**
* {@inheritdoc}
*/
public function destinationEntityBundle() {
return isset($this->destinationEntityBundle) ? $this->destinationEntityBundle : NULL;
}
/**
* {@inheritdoc}
*/
public function sourceField() {
return isset($this->sourceField) ? $this->sourceField : NULL;
}
/**
* {@inheritdoc}
*/
public function destinationField() {
return isset($this->destinationField) ? $this->destinationField : NULL;
}
/**
* {@inheritdoc}
*/
public function plugin() {
return isset($this->plugin) ? $this->plugin : NULL;
}
/**
* {@inheritdoc}
*/
public function setType($type) {
$this->type = $type;
return $this;
}
/**
* {@inheritdoc}
*/
public function setSourceEntityType($source_entity_type) {
$this->sourceEntityType = $source_entity_type;
return $this;
}
/**
* {@inheritdoc}
*/
public function setDestinationEntityType($destination_entity_type) {
$this->destinationEntityType = $destination_entity_type;
return $this;
}
/**
* {@inheritdoc}
*/
public function setSourceEntityBundle($source_entity_bundle) {
$this->sourceEntityBundle = $source_entity_bundle;
return $this;
}
/**
* {@inheritdoc}
*/
public function setDestinationEntityBundle($destination_entity_bundle) {
$this->destinationEntityBundle = $destination_entity_bundle;
return $this;
}
/**
* {@inheritdoc}
*/
public function setSourceField($source_field) {
$this->sourceField = $source_field;
return $this;
}
/**
* {@inheritdoc}
*/
public function setDestinationField($destination_field) {
$this->destinationField = $destination_field;
return $this;
}
/**
* {@inheritdoc}
*/
public function setPlugin($plugin) {
$this->plugin = $plugin;
return $this;
}
/**
* {@inheritdoc}
*/
public function save() {
if (strpos($this
->id(), $this
->destinationEntityType() . '_' . $this
->destinationEntityBundle() . '_') === FALSE) {
$this->id = $this
->destinationEntityType() . '_' . $this
->destinationEntityBundle() . '_' . $this
->id();
}
parent::save();
}
}
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. | |
ConfigEntityBase:: |
private | property | Whether the config is being deleted by the uninstall process. | |
ConfigEntityBase:: |
protected | property | The language code of the entity's default language. | |
ConfigEntityBase:: |
protected | property | The original ID of the configuration entity. | |
ConfigEntityBase:: |
protected | property | The enabled/disabled status of the configuration entity. | 4 |
ConfigEntityBase:: |
protected | property | Third party entity settings. | |
ConfigEntityBase:: |
protected | property | Trust supplied data and not use configuration schema on save. | |
ConfigEntityBase:: |
protected | property | The UUID for this entity. | |
ConfigEntityBase:: |
protected | property | Information maintained by Drupal core about configuration. | |
ConfigEntityBase:: |
protected | function | Overrides \Drupal\Core\Entity\DependencyTrait:addDependency(). | |
ConfigEntityBase:: |
public | function |
Calculates dependencies and stores them in the dependency property. Overrides ConfigEntityInterface:: |
13 |
ConfigEntityBase:: |
public | function |
Creates a duplicate of the entity. Overrides EntityBase:: |
1 |
ConfigEntityBase:: |
public | function |
Disables the configuration entity. Overrides ConfigEntityInterface:: |
1 |
ConfigEntityBase:: |
public | function |
Enables the configuration entity. Overrides ConfigEntityInterface:: |
|
ConfigEntityBase:: |
public | function |
Returns the value of a property. Overrides ConfigEntityInterface:: |
|
ConfigEntityBase:: |
public | function |
Returns the cache tags that should be used to invalidate caches. Overrides EntityBase:: |
1 |
ConfigEntityBase:: |
public | function |
Gets the configuration dependency name. Overrides EntityBase:: |
|
ConfigEntityBase:: |
protected static | function | Gets the configuration manager. | |
ConfigEntityBase:: |
public | function |
Gets the configuration target identifier for the entity. Overrides EntityBase:: |
|
ConfigEntityBase:: |
public | function |
Gets the configuration dependencies. Overrides ConfigEntityInterface:: |
|
ConfigEntityBase:: |
public | function |
Gets the original ID. Overrides EntityBase:: |
|
ConfigEntityBase:: |
public | function |
Gets the list of third parties that store information. Overrides ThirdPartySettingsInterface:: |
|
ConfigEntityBase:: |
public | function |
Gets the value of a third-party setting. Overrides ThirdPartySettingsInterface:: |
|
ConfigEntityBase:: |
public | function |
Gets all third-party settings of a given module. Overrides ThirdPartySettingsInterface:: |
|
ConfigEntityBase:: |
protected | function | Gets the typed config manager. | |
ConfigEntityBase:: |
public | function |
Gets whether on not the data is trusted. Overrides ConfigEntityInterface:: |
|
ConfigEntityBase:: |
protected static | function |
Override to never invalidate the individual entities' cache tags; the
config system already invalidates them. Overrides EntityBase:: |
|
ConfigEntityBase:: |
protected | function |
Override to never invalidate the entity's cache tag; the config system
already invalidates it. Overrides EntityBase:: |
|
ConfigEntityBase:: |
public | function |
Checks whether this entity is installable. Overrides ConfigEntityInterface:: |
2 |
ConfigEntityBase:: |
public | function |
Overrides Entity::isNew(). Overrides EntityBase:: |
|
ConfigEntityBase:: |
public | function |
Returns whether this entity is being changed during the uninstall process. Overrides ConfigEntityInterface:: |
|
ConfigEntityBase:: |
public | function |
Deprecated way of generating a link to the entity. See toLink(). Overrides EntityBase:: |
|
ConfigEntityBase:: |
public | function |
Informs the entity that entities it depends on will be deleted. Overrides ConfigEntityInterface:: |
7 |
ConfigEntityBase:: |
public static | function |
Acts on entities before they are deleted and before hooks are invoked. Overrides EntityBase:: |
8 |
ConfigEntityBase:: |
public | function |
Acts on an entity before the presave hook is invoked. Overrides EntityBase:: |
13 |
ConfigEntityBase:: |
public | function |
Sets the value of a property. Overrides ConfigEntityInterface:: |
|
ConfigEntityBase:: |
public | function |
Sets the original ID. Overrides EntityBase:: |
|
ConfigEntityBase:: |
public | function |
Sets the status of the configuration entity. Overrides ConfigEntityInterface:: |
|
ConfigEntityBase:: |
public | function |
Sets the value of a third-party setting. Overrides ThirdPartySettingsInterface:: |
|
ConfigEntityBase:: |
public | function | ||
ConfigEntityBase:: |
public static | function | Helper callback for uasort() to sort configuration entities by weight and label. | 6 |
ConfigEntityBase:: |
public | function |
Returns whether the configuration entity is enabled. Overrides ConfigEntityInterface:: |
4 |
ConfigEntityBase:: |
public | function |
Gets an array of all property values. Overrides EntityBase:: |
2 |
ConfigEntityBase:: |
public | function |
Gets the URL object for the entity. Overrides EntityBase:: |
|
ConfigEntityBase:: |
public | function |
Sets that the data should be trusted. Overrides ConfigEntityInterface:: |
|
ConfigEntityBase:: |
public | function |
Unsets a third-party setting. Overrides ThirdPartySettingsInterface:: |
|
ConfigEntityBase:: |
public | function |
Gets the public URL for this entity. Overrides EntityBase:: |
|
ConfigEntityBase:: |
public | function |
Gets the URL object for the entity. Overrides EntityBase:: |
|
ConfigEntityBase:: |
public | function |
Constructs an Entity object. Overrides EntityBase:: |
10 |
ConfigEntityBase:: |
public | function |
Overrides EntityBase:: |
4 |
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 | |
DependencyTrait:: |
protected | property | The object's dependencies. | |
DependencyTrait:: |
protected | function | Adds multiple dependencies. | |
DependencyTrait:: |
protected | function | Adds a dependency. Aliased as: addDependencyTrait | |
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 | function |
Checks data value access. Overrides AccessibleInterface:: |
1 |
EntityBase:: |
public | function |
Gets the bundle of the entity. Overrides EntityInterface:: |
1 |
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 |
Gets the key that is used to store configuration dependencies. Overrides EntityInterface:: |
|
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 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:: |
public | function |
Gets the identifier. Overrides EntityInterface:: |
11 |
EntityBase:: |
public | function |
Gets the label of the entity. Overrides EntityInterface:: |
6 |
EntityBase:: |
public | function |
Gets the language of the entity. Overrides EntityInterface:: |
1 |
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 | function |
Acts on a created entity before hooks are invoked. Overrides EntityInterface:: |
4 |
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 | function |
Acts on a saved entity before the insert or update hook is invoked. Overrides EntityInterface:: |
14 |
EntityBase:: |
public static | function |
Changes the values of an entity before it is created. Overrides EntityInterface:: |
5 |
EntityBase:: |
public | function |
Gets a list of entities referenced by this entity. Overrides EntityInterface:: |
1 |
EntityBase:: |
public | function |
Generates the HTML for a link to this entity. Overrides EntityInterface:: |
|
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:: |
public | function |
Gets the entity UUID (Universally Unique Identifier). Overrides EntityInterface:: |
1 |
EntityBase:: |
protected | function | Gets the UUID generator. | |
FieldInheritance:: |
protected | property | The field inheritance destination entity bundle. | |
FieldInheritance:: |
protected | property | The field inheritance destination entity type. | |
FieldInheritance:: |
protected | property | The field inheritance destination field. | |
FieldInheritance:: |
protected | property | The field inheritance ID. | |
FieldInheritance:: |
protected | property | The field inheritance label. | |
FieldInheritance:: |
protected | property | The field inheritance plugin. | |
FieldInheritance:: |
protected | property | The field inheritance source entity bundle. | |
FieldInheritance:: |
protected | property | The field inheritance source entity type. | |
FieldInheritance:: |
protected | property | The field inheritance source field. | |
FieldInheritance:: |
protected | property | The field inheritance type. | |
FieldInheritance:: |
public | function |
Get the inheritance destination entity bundle. Overrides FieldInheritanceInterface:: |
|
FieldInheritance:: |
public | function |
Get the inheritance destination entity type. Overrides FieldInheritanceInterface:: |
|
FieldInheritance:: |
public | function |
Get the inheritance destination field. Overrides FieldInheritanceInterface:: |
|
FieldInheritance:: |
public | function |
Get the inheritance ID without the type and bundle. Overrides FieldInheritanceInterface:: |
|
FieldInheritance:: |
public | function |
Get the inheritance plugin. Overrides FieldInheritanceInterface:: |
|
FieldInheritance:: |
public | function |
Saves an entity permanently. Overrides ConfigEntityBase:: |
|
FieldInheritance:: |
public | function |
Set the inheritance destination entity bundles. Overrides FieldInheritanceInterface:: |
|
FieldInheritance:: |
public | function |
Set the inheritance destination entity type. Overrides FieldInheritanceInterface:: |
|
FieldInheritance:: |
public | function |
Set the inheritance destination field. Overrides FieldInheritanceInterface:: |
|
FieldInheritance:: |
public | function |
Set the inheritance plugin. Overrides FieldInheritanceInterface:: |
|
FieldInheritance:: |
public | function |
Set the inheritance source entity bundles. Overrides FieldInheritanceInterface:: |
|
FieldInheritance:: |
public | function |
Set the inheritance source entity type. Overrides FieldInheritanceInterface:: |
|
FieldInheritance:: |
public | function |
Set the inheritance source field. Overrides FieldInheritanceInterface:: |
|
FieldInheritance:: |
public | function |
Set the inheritance type. Overrides FieldInheritanceInterface:: |
|
FieldInheritance:: |
public | function |
Get the inheritance source entity bundle. Overrides FieldInheritanceInterface:: |
|
FieldInheritance:: |
public | function |
Get the inheritance source entity type. Overrides FieldInheritanceInterface:: |
|
FieldInheritance:: |
public | function |
Get the inheritance source field. Overrides FieldInheritanceInterface:: |
|
FieldInheritance:: |
public | function |
Get the inheritance type. Overrides FieldInheritanceInterface:: |
|
PluginDependencyTrait:: |
protected | function | Calculates and adds dependencies of a specific plugin instance. | 1 |
PluginDependencyTrait:: |
protected | function | Calculates and returns dependencies of a specific plugin instance. | |
PluginDependencyTrait:: |
protected | function | Wraps the module handler. | 1 |
PluginDependencyTrait:: |
protected | function | Wraps the theme handler. | 1 |
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 |