You are here

Home » API reference » Field Inheritance 2.0.x » FieldInheritance.php

class FieldInheritance in Field Inheritance 2.0.x

Same name in this branch
  1. 2.0.x src/Annotation/FieldInheritance.php \Drupal\field_inheritance\Annotation\FieldInheritance
  2. 2.0.x src/Entity/FieldInheritance.php \Drupal\field_inheritance\Entity\FieldInheritance
Same name and namespace in other branches
  1. 8 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

Expanded class hierarchy of FieldInheritance

File

src/Entity/FieldInheritance.php, line 54

Namespace

Drupal\field_inheritance\Entity
View 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

Namesort descending Modifiers Type Description Overrides
CacheableDependencyTrait::$cacheContexts protected property Cache contexts.
CacheableDependencyTrait::$cacheMaxAge protected property Cache max-age.
CacheableDependencyTrait::$cacheTags protected property Cache tags.
CacheableDependencyTrait::setCacheability protected function Sets cacheability; useful for value object constructors.
ConfigEntityBase::$isUninstalling private property Whether the config is being deleted by the uninstall process.
ConfigEntityBase::$langcode protected property The language code of the entity's default language.
ConfigEntityBase::$originalId protected property The original ID of the configuration entity.
ConfigEntityBase::$status protected property The enabled/disabled status of the configuration entity. 4
ConfigEntityBase::$third_party_settings protected property Third party entity settings.
ConfigEntityBase::$trustedData protected property Trust supplied data and not use configuration schema on save.
ConfigEntityBase::$uuid protected property The UUID for this entity.
ConfigEntityBase::$_core protected property
ConfigEntityBase::addDependency protected function Overrides \Drupal\Core\Entity\DependencyTrait:addDependency().
ConfigEntityBase::calculateDependencies public function Calculates dependencies and stores them in the dependency property. Overrides ConfigEntityInterface::calculateDependencies 14
ConfigEntityBase::createDuplicate public function Creates a duplicate of the entity. Overrides EntityBase::createDuplicate 1
ConfigEntityBase::disable public function Disables the configuration entity. Overrides ConfigEntityInterface::disable 1
ConfigEntityBase::enable public function Enables the configuration entity. Overrides ConfigEntityInterface::enable
ConfigEntityBase::get public function Returns the value of a property. Overrides ConfigEntityInterface::get
ConfigEntityBase::getCacheTagsToInvalidate public function Returns the cache tags that should be used to invalidate caches. Overrides EntityBase::getCacheTagsToInvalidate 1
ConfigEntityBase::getConfigDependencyName public function Gets the configuration dependency name. Overrides EntityBase::getConfigDependencyName
ConfigEntityBase::getConfigManager protected static function Gets the configuration manager.
ConfigEntityBase::getConfigTarget public function Gets the configuration target identifier for the entity. Overrides EntityBase::getConfigTarget
ConfigEntityBase::getDependencies public function Gets the configuration dependencies. Overrides ConfigEntityInterface::getDependencies
ConfigEntityBase::getOriginalId public function Gets the original ID. Overrides EntityBase::getOriginalId
ConfigEntityBase::getThirdPartyProviders public function Gets the list of third parties that store information. Overrides ThirdPartySettingsInterface::getThirdPartyProviders
ConfigEntityBase::getThirdPartySetting public function Gets the value of a third-party setting. Overrides ThirdPartySettingsInterface::getThirdPartySetting
ConfigEntityBase::getThirdPartySettings public function Gets all third-party settings of a given module. Overrides ThirdPartySettingsInterface::getThirdPartySettings
ConfigEntityBase::getTypedConfig protected function Gets the typed config manager.
ConfigEntityBase::hasTrustedData public function Gets whether on not the data is trusted. Overrides ConfigEntityInterface::hasTrustedData
ConfigEntityBase::invalidateTagsOnDelete protected static function Override to never invalidate the individual entities' cache tags; the config system already invalidates them. Overrides EntityBase::invalidateTagsOnDelete
ConfigEntityBase::invalidateTagsOnSave protected function Override to never invalidate the entity's cache tag; the config system already invalidates it. Overrides EntityBase::invalidateTagsOnSave
ConfigEntityBase::isInstallable public function Checks whether this entity is installable. Overrides ConfigEntityInterface::isInstallable 2
ConfigEntityBase::isNew public function Overrides Entity::isNew(). Overrides EntityBase::isNew
ConfigEntityBase::isUninstalling public function Returns whether this entity is being changed during the uninstall process. Overrides ConfigEntityInterface::isUninstalling
ConfigEntityBase::onDependencyRemoval public function Informs the entity that entities it depends on will be deleted. Overrides ConfigEntityInterface::onDependencyRemoval 8
ConfigEntityBase::preDelete public static function Acts on entities before they are deleted and before hooks are invoked. Overrides EntityBase::preDelete 8
ConfigEntityBase::preSave public function Acts on an entity before the presave hook is invoked. Overrides EntityBase::preSave 13
ConfigEntityBase::set public function Sets the value of a property. Overrides ConfigEntityInterface::set
ConfigEntityBase::setOriginalId public function Sets the original ID. Overrides EntityBase::setOriginalId
ConfigEntityBase::setStatus public function Sets the status of the configuration entity. Overrides ConfigEntityInterface::setStatus
ConfigEntityBase::setThirdPartySetting public function Sets the value of a third-party setting. Overrides ThirdPartySettingsInterface::setThirdPartySetting
ConfigEntityBase::setUninstalling public function
ConfigEntityBase::sort public static function Helper callback for uasort() to sort configuration entities by weight and label. 6
ConfigEntityBase::status public function Returns whether the configuration entity is enabled. Overrides ConfigEntityInterface::status 4
ConfigEntityBase::toArray public function Gets an array of all property values. Overrides EntityBase::toArray 2
ConfigEntityBase::toUrl public function Gets the URL object for the entity. Overrides EntityBase::toUrl
ConfigEntityBase::trustData public function Sets that the data should be trusted. Overrides ConfigEntityInterface::trustData
ConfigEntityBase::unsetThirdPartySetting public function Unsets a third-party setting. Overrides ThirdPartySettingsInterface::unsetThirdPartySetting
ConfigEntityBase::__construct public function Constructs an Entity object. Overrides EntityBase::__construct 10
ConfigEntityBase::__sleep public function Overrides EntityBase::__sleep 4
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function Aliased as: traitSleep 2
DependencySerializationTrait::__wakeup public function 2
DependencyTrait::$dependencies protected property The object's dependencies.
DependencyTrait::addDependencies protected function Adds multiple dependencies.
DependencyTrait::addDependency protected function Adds a dependency. Aliased as: addDependencyTrait
EntityBase::$enforceIsNew protected property Boolean indicating whether the entity should be forced to be new.
EntityBase::$entityTypeId protected property The entity type.
EntityBase::$typedData protected property A typed data object wrapping this entity.
EntityBase::access public function Checks data value access. Overrides AccessibleInterface::access 1
EntityBase::bundle public function Gets the bundle of the entity. Overrides EntityInterface::bundle 1
EntityBase::create public static function Constructs a new entity object, without permanently saving it. Overrides EntityInterface::create
EntityBase::delete public function Deletes an entity permanently. Overrides EntityInterface::delete 2
EntityBase::enforceIsNew public function Enforces an entity to be new. Overrides EntityInterface::enforceIsNew
EntityBase::entityTypeBundleInfo protected function Gets the entity type bundle info service.
EntityBase::entityTypeManager protected function Gets the entity type manager.
EntityBase::getCacheContexts public function The cache contexts associated with this object. Overrides CacheableDependencyTrait::getCacheContexts
EntityBase::getCacheMaxAge public function The maximum age for which this object may be cached. Overrides CacheableDependencyTrait::getCacheMaxAge
EntityBase::getCacheTags public function The cache tags associated with this object. Overrides CacheableDependencyTrait::getCacheTags
EntityBase::getConfigDependencyKey public function Gets the key that is used to store configuration dependencies. Overrides EntityInterface::getConfigDependencyKey
EntityBase::getEntityType public function Gets the entity type definition. Overrides EntityInterface::getEntityType
EntityBase::getEntityTypeId public function Gets the ID of the type of the entity. Overrides EntityInterface::getEntityTypeId
EntityBase::getListCacheTagsToInvalidate protected function The list cache tags to invalidate for this entity.
EntityBase::getTypedData public function Gets a typed data object for this entity object. Overrides EntityInterface::getTypedData
EntityBase::hasLinkTemplate public function Indicates if a link template exists for a given key. Overrides EntityInterface::hasLinkTemplate
EntityBase::id public function Gets the identifier. Overrides EntityInterface::id 11
EntityBase::label public function Gets the label of the entity. Overrides EntityInterface::label 6
EntityBase::language public function Gets the language of the entity. Overrides EntityInterface::language 1
EntityBase::languageManager protected function Gets the language manager.
EntityBase::linkTemplates protected function Gets an array link templates. 1
EntityBase::load public static function Loads an entity. Overrides EntityInterface::load
EntityBase::loadMultiple public static function Loads one or more entities. Overrides EntityInterface::loadMultiple
EntityBase::postCreate public function Acts on a created entity before hooks are invoked. Overrides EntityInterface::postCreate 4
EntityBase::postDelete public static function Acts on deleted entities before the delete hook is invoked. Overrides EntityInterface::postDelete 18
EntityBase::postLoad public static function Acts on loaded entities. Overrides EntityInterface::postLoad 2
EntityBase::postSave public function Acts on a saved entity before the insert or update hook is invoked. Overrides EntityInterface::postSave 14
EntityBase::preCreate public static function Changes the values of an entity before it is created. Overrides EntityInterface::preCreate 7
EntityBase::referencedEntities public function Gets a list of entities referenced by this entity. Overrides EntityInterface::referencedEntities 1
EntityBase::toLink public function Generates the HTML for a link to this entity. Overrides EntityInterface::toLink
EntityBase::uriRelationships public function Gets a list of URI relationships supported by this entity. Overrides EntityInterface::uriRelationships
EntityBase::urlRouteParameters protected function Gets an array of placeholders for this entity. 2
EntityBase::uuid public function Gets the entity UUID (Universally Unique Identifier). Overrides EntityInterface::uuid 1
EntityBase::uuidGenerator protected function Gets the UUID generator.
FieldInheritance::$destinationEntityBundle protected property The field inheritance destination entity bundle.
FieldInheritance::$destinationEntityType protected property The field inheritance destination entity type.
FieldInheritance::$destinationField protected property The field inheritance destination field.
FieldInheritance::$id protected property The field inheritance ID.
FieldInheritance::$label protected property The field inheritance label.
FieldInheritance::$plugin protected property The field inheritance plugin.
FieldInheritance::$sourceEntityBundle protected property The field inheritance source entity bundle.
FieldInheritance::$sourceEntityType protected property The field inheritance source entity type.
FieldInheritance::$sourceField protected property The field inheritance source field.
FieldInheritance::$type protected property The field inheritance type.
FieldInheritance::destinationEntityBundle public function Get the inheritance destination entity bundle. Overrides FieldInheritanceInterface::destinationEntityBundle
FieldInheritance::destinationEntityType public function Get the inheritance destination entity type. Overrides FieldInheritanceInterface::destinationEntityType
FieldInheritance::destinationField public function Get the inheritance destination field. Overrides FieldInheritanceInterface::destinationField
FieldInheritance::idWithoutTypeAndBundle public function Get the inheritance ID without the type and bundle. Overrides FieldInheritanceInterface::idWithoutTypeAndBundle
FieldInheritance::plugin public function Get the inheritance plugin. Overrides FieldInheritanceInterface::plugin
FieldInheritance::save public function Saves an entity permanently. Overrides ConfigEntityBase::save
FieldInheritance::setDestinationEntityBundle public function Set the inheritance destination entity bundles. Overrides FieldInheritanceInterface::setDestinationEntityBundle
FieldInheritance::setDestinationEntityType public function Set the inheritance destination entity type. Overrides FieldInheritanceInterface::setDestinationEntityType
FieldInheritance::setDestinationField public function Set the inheritance destination field. Overrides FieldInheritanceInterface::setDestinationField
FieldInheritance::setPlugin public function Set the inheritance plugin. Overrides FieldInheritanceInterface::setPlugin
FieldInheritance::setSourceEntityBundle public function Set the inheritance source entity bundles. Overrides FieldInheritanceInterface::setSourceEntityBundle
FieldInheritance::setSourceEntityType public function Set the inheritance source entity type. Overrides FieldInheritanceInterface::setSourceEntityType
FieldInheritance::setSourceField public function Set the inheritance source field. Overrides FieldInheritanceInterface::setSourceField
FieldInheritance::setType public function Set the inheritance type. Overrides FieldInheritanceInterface::setType
FieldInheritance::sourceEntityBundle public function Get the inheritance source entity bundle. Overrides FieldInheritanceInterface::sourceEntityBundle
FieldInheritance::sourceEntityType public function Get the inheritance source entity type. Overrides FieldInheritanceInterface::sourceEntityType
FieldInheritance::sourceField public function Get the inheritance source field. Overrides FieldInheritanceInterface::sourceField
FieldInheritance::type public function Get the inheritance type. Overrides FieldInheritanceInterface::type
PluginDependencyTrait::calculatePluginDependencies protected function Calculates and adds dependencies of a specific plugin instance. 1
PluginDependencyTrait::getPluginDependencies protected function Calculates and returns dependencies of a specific plugin instance.
PluginDependencyTrait::moduleHandler protected function Wraps the module handler. 1
PluginDependencyTrait::themeHandler protected function Wraps the theme handler. 1
RefinableCacheableDependencyTrait::addCacheableDependency public function 1
RefinableCacheableDependencyTrait::addCacheContexts public function
RefinableCacheableDependencyTrait::addCacheTags public function
RefinableCacheableDependencyTrait::mergeCacheMaxAge public function
SynchronizableEntityTrait::$isSyncing protected property Whether this entity is being created, updated or deleted through a synchronization process.
SynchronizableEntityTrait::isSyncing public function
SynchronizableEntityTrait::setSyncing public function