You are here

Home » API reference » Relation 8.2 » RelationType.php

class RelationType in Relation 8.2

Same name and namespace in other branches
  1. 8 src/Entity/RelationType.php \Drupal\relation\Entity\RelationType

Defines relation type entity.

Plugin annotation


@ConfigEntityType(
  id = "relation_type",
  label = @Translation("Relation type"),
  module = "relation",
  handlers = {
    "storage" = "Drupal\Core\Config\Entity\ConfigEntityStorage",
    "render" = "Drupal\Core\Entity\EntityViewBuilder",
    "list_builder" = "Drupal\relation\RelationTypeListBuilder",
    "form" = {
      "add" = "Drupal\relation\RelationTypeForm",
      "edit" = "Drupal\relation\RelationTypeForm",
      "delete" = "Drupal\relation\Form\RelationTypeDeleteConfirm"
    },
    "route_provider" = {
      "html" = "Drupal\Core\Entity\Routing\DefaultHtmlRouteProvider",
    }
  },
  admin_permission = "administer relation types",
  config_prefix = "type",
  bundle_of = "relation",
  entity_keys = {
    "id" = "id",
    "label" = "label"
  },
  config_export = {
    "id",
    "label",
    "reverse_label",
    "directional",
    "transitive",
    "r_unique",
    "min_arity",
    "max_arity",
    "source_bundles",
    "target_bundles",
  },
  links = {
    "add-form" = "/admin/structure/relation/add",
    "edit-form" = "/admin/structure/relation/manage/{relation_type}",
    "delete-form" = "/admin/structure/relation/manage/{relation_type}/delete",
    "collection" = "/admin/structure/relation",
  }
)

Hierarchy

Expanded class hierarchy of RelationType

11 files declare their use of RelationType
EntityCollector.php in relation_entity_collector/src/Form/EntityCollector.php
Contains \Drupal\relation_entity_collector\Form\EntityCollector.
relation.drush.inc in ./relation.drush.inc
Drush integration for the relation module.
relation.module in ./relation.module
Describes relations between entities.
relation.rules.inc in ./relation.rules.inc
Implements the Rules module API for Relation.
relation.views.inc in ./relation.views.inc

... See full list

File

src/Entity/RelationType.php, line 57

Namespace

Drupal\relation\Entity
View source 
class RelationType extends ConfigEntityBundleBase implements RelationTypeInterface, EntityDescriptionInterface {

  /**
   * The machine name of this relation type.
   *
   * @var string
   */
  public $id;

  /**
   * The human-readable name of this type.
   *
   * Defaults to relation type id.
   *
   * @var string
   */
  public $label;

  /**
   * The reverse human-readable name of this type.
   *
   * Only used for directional relations.
   *
   * @var string
   */
  public $reverse_label;

  /**
   * Whether this relation type is directional. If not, all indexes are ignored.
   *
   * @var bool
   */
  public $directional = FALSE;

  /**
   * Whether this relation type is transitive.
   *
   * @var bool
   */
  public $transitive = FALSE;

  /**
   * Whether relations of this type are unique.
   *
   * @var bool
   */
  public $r_unique = FALSE;

  /**
   * The minimum number of entities that can make up a relation of this type.
   *
   * @var int
   */
  public $min_arity = 2;

  /**
   * The maximum number of entities that can make up a relation of this type.
   *
   * Similar to field cardinality.
   *
   * @var int
   */
  public $max_arity = 2;

  /**
   * List of entity bundles that can be used as relation sources.
   *
   * This is used for both directional and non-directional relations. Bundle key
   * arrays are of the form 'entity:bundle', eg. 'node:article', or 'entity:*'
   * for all bundles of the type.
   *
   * @var array
   */
  public $source_bundles = array();

  /**
   * List of entity bundles that can be used as relation targets.
   *
   * This is the same format as source bundles, but is only used for directional
   * relations.
   *
   * @var array
   */
  public $target_bundles = array();

  /**
   * A brief description of this relation type.
   *
   * @var string
   */
  public $description;

  /**
   * {@inheritdoc}
   */
  public function reverseLabel() {
    return $this->reverse_label;
  }

  /**
   * {@inheritdoc}
   */
  public function getDescription() {
    return $this->description;
  }

  /**
   * {@inheritdoc}
   */
  public function setDescription($description) {
    $this->description = $description;
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function postSave(EntityStorageInterface $storage, $update = TRUE) {
    parent::postSave($storage, $update);

    // Ensure endpoints field is attached to relation type.
    if (!$update) {
      relation_add_endpoint_field($this);
    }
    else {

      // Clear the cached field definitions as some settings affect the field
      // definitions.
      \Drupal::service('entity_field.manager')
        ->clearCachedFieldDefinitions();
    }
  }

  /**
   * {@inheritdoc}
   */
  public function getBundles($direction = NULL) {
    $pairs = array();
    if ((!$direction || $direction == 'source') && is_array($this->source_bundles)) {
      $pairs += $this->source_bundles;
    }
    if ((!$direction || $direction == 'target') && is_array($this->target_bundles)) {
      $pairs += $this->target_bundles;
    }
    $bundles = array();
    foreach ($pairs as $pair) {
      list($entity_type_id, $bundle) = explode(':', $pair, 2);
      $bundles[$entity_type_id][$bundle] = $bundle;
    }
    return $bundles;
  }

  /**
   * {@inheritdoc}
   */
  public function preSave(EntityStorageInterface $storage) {
    parent::preSave($storage);
    if (empty($this->label)) {
      $this->label = $this
        ->id();
    }

    // Directional relations should have a reverse label. If they are symmetric
    // or if they don't have it, fill it with the label.
    if (empty($this->reverse_label)) {
      $this->reverse_label = $this->label;
    }
  }

}

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 Information maintained by Drupal core about configuration.
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 13
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::link public function Deprecated way of generating a link to the entity. See toLink(). Overrides EntityBase::link
ConfigEntityBase::onDependencyRemoval public function Informs the entity that entities it depends on will be deleted. Overrides ConfigEntityInterface::onDependencyRemoval 7
ConfigEntityBase::preDelete public static function Acts on entities before they are deleted and before hooks are invoked. Overrides EntityBase::preDelete 8
ConfigEntityBase::save public function Saves an entity permanently. Overrides EntityBase::save 1
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::url public function Gets the public URL for this entity. Overrides EntityBase::url
ConfigEntityBase::urlInfo public function Gets the URL object for the entity. Overrides EntityBase::urlInfo
ConfigEntityBase::__construct public function Constructs an Entity object. Overrides EntityBase::__construct 10
ConfigEntityBase::__sleep public function Overrides EntityBase::__sleep 4
ConfigEntityBundleBase::deleteDisplays protected function Deletes display if a bundle is deleted.
ConfigEntityBundleBase::loadDisplays protected function Returns view or form displays for this bundle.
ConfigEntityBundleBase::postDelete public static function Acts on deleted entities before the delete hook is invoked. Overrides EntityBase::postDelete 2
DependencySerializationTrait::$_entityStorages protected property An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function Aliased as: traitSleep 1
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::entityManager Deprecated protected function Gets the entity manager.
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::postLoad public static function Acts on loaded entities. Overrides EntityInterface::postLoad 2
EntityBase::preCreate public static function Changes the values of an entity before it is created. Overrides EntityInterface::preCreate 5
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.
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
RelationType::$description public property A brief description of this relation type.
RelationType::$directional public property Whether this relation type is directional. If not, all indexes are ignored.
RelationType::$id public property The machine name of this relation type.
RelationType::$label public property The human-readable name of this type.
RelationType::$max_arity public property The maximum number of entities that can make up a relation of this type.
RelationType::$min_arity public property The minimum number of entities that can make up a relation of this type.
RelationType::$reverse_label public property The reverse human-readable name of this type.
RelationType::$r_unique public property Whether relations of this type are unique.
RelationType::$source_bundles public property List of entity bundles that can be used as relation sources.
RelationType::$target_bundles public property List of entity bundles that can be used as relation targets.
RelationType::$transitive public property Whether this relation type is transitive.
RelationType::getBundles public function Get valid entity/bundle pairs that can be associated with this type of Relation. Overrides RelationTypeInterface::getBundles
RelationType::getDescription public function Gets the entity description. Overrides EntityDescriptionInterface::getDescription
RelationType::postSave public function Acts on a saved entity before the insert or update hook is invoked. Overrides ConfigEntityBundleBase::postSave
RelationType::preSave public function Acts on an entity before the presave hook is invoked. Overrides ConfigEntityBundleBase::preSave
RelationType::reverseLabel public function Returns a reversed label of this relation type. Overrides RelationTypeInterface::reverseLabel
RelationType::setDescription public function Sets the entity description. Overrides EntityDescriptionInterface::setDescription
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