You are here

Home » API reference » Corresponding Entity References 8.4 » CorrespondingReferenceInterface.php

interface CorrespondingReferenceInterface in Corresponding Entity References 8.4

Defines the interface for corresponding reference config entities.

Hierarchy

Expanded class hierarchy of CorrespondingReferenceInterface

All classes that implement CorrespondingReferenceInterface

2 files declare their use of CorrespondingReferenceInterface
CorrespondingReferenceForm.php in src/Form/CorrespondingReferenceForm.php
CorrespondingReferenceListBuilder.php in src/CorrespondingReferenceListBuilder.php

File

src/Entity/CorrespondingReferenceInterface.php, line 11

Namespace

Drupal\cer\Entity
View source 
interface CorrespondingReferenceInterface extends ConfigEntityInterface {

  /**
   * Gets the corresponding reference machine name.
   *
   * @return string
   *   The machine name.
   */
  public function getId();

  /**
   * Sets the corresponding reference machine name.
   *
   * @param string $id
   *   The machine name.
   *
   * @return $this
   */
  public function setId($id);

  /**
   * Gets the corresponding reference label.
   *
   * @return string
   *   The label.
   */
  public function getLabel();

  /**
   * Sets the corresponding reference label.
   *
   * @param string $label
   *   The label.
   *
   * @return $this
   */
  public function setLabel($label);

  /**
   * Gets the first corresponding reference field id.
   *
   * @return string
   *   The first corresponding reference field.
   */
  public function getFirstField();

  /**
   * Sets the first corresponding reference field ID.
   *
   * @param string $firstField
   *   The first corresponding reference field ID.
   *
   * @return $this
   */
  public function setFirstField($firstField);

  /**
   * Gets the second corresponding reference field id.
   *
   * @return string
   *   The second corresponding reference field.
   */
  public function getSecondField();

  /**
   * Sets the second corresponding reference field ID.
   *
   * @param string $secondField
   *   The second corresponding reference field ID.
   *
   * @return $this
   */
  public function setSecondField($secondField);

  /**
   * Gets an array of referenced bundle names keyed by entity ID.
   *
   * @return array
   *   The referenced bundles, keyed by entity ID.
   */
  public function getBundles();

  /**
   * Sets the array of referenced bundle names keyed by entity ID.
   *
   * @param array $bundles
   *   The new referenced bundle names, keyed by entity ID.
   *
   * @return $this
   */
  public function setBundles(array $bundles);

  /**
   * Get whether the corresponding reference is enabled.
   *
   * @return bool
   *   TRUE if the corresponding reference is enabled, FALSE otherwise.
   */
  public function isEnabled();

  /**
   * Sets whether the corresponding reference is enabled.
   *
   * @param bool $enabled
   *   Whether the corresponding reference is enabled.
   *
   * @return $this
   */
  public function setEnabled($enabled);

  /**
   * Gets an array of the corresponding field names.
   *
   * @return array
   *   The corresponding field names.
   */
  public function getCorrespondingFields();

  /**
   * Gets the name of the corresponding field of the provided field.
   *
   * @param $fieldName string
   *   The provided field name.
   *
   * @return string
   *   The corresponding field name.
   */
  public function getCorrespondingField($fieldName);

  /**
   * Checks if this corresponding reference is valid for the provided entity.
   *
   * @param \Drupal\Core\Entity\FieldableEntityInterface $entity
   *   The entity to check.
   *
   * @return bool
   *   TRUE if this reference field applies to the entity, FALSE otherwise.
   */
  public function isValid(FieldableEntityInterface $entity);

  /**
   * Checks whether the given entity has the configured corresponding reference fields.
   *
   * @param \Drupal\Core\Entity\FieldableEntityInterface $entity
   *   The entity.
   *
   * @return bool
   *   TRUE if the entity has corresponding fields, FALSE otherwise.
   */
  public function hasCorrespondingFields(FieldableEntityInterface $entity);

  /**
   * Synchronizes corresponding fields on the given entity.
   *
   * @param \Drupal\Core\Entity\FieldableEntityInterface $entity
   *   The entity.
   * @param bool $deleted
   *   Whether the entity is deleted.
   */
  public function synchronizeCorrespondingFields(FieldableEntityInterface $entity, $deleted);

  /**
   * Synchronizes a single corresponding field on a corresponding entity.
   *
   * @param \Drupal\Core\Entity\FieldableEntityInterface $entity
   *   The original entity.
   *
   * @param \Drupal\Core\Entity\FieldableEntityInterface $correspondingEntity
   *   The corresponding entity.
   *
   * @param $fieldName
   *   The field name.
   */
  public function synchronizeCorrespondingField(FieldableEntityInterface $entity, FieldableEntityInterface $correspondingEntity, $fieldName);

}

Members

Namesort descending Modifiers Type Description Overrides
AccessibleInterface::access public function Checks data value access. 9
CacheableDependencyInterface::getCacheContexts public function The cache contexts associated with this object. 34
CacheableDependencyInterface::getCacheMaxAge public function The maximum age for which this object may be cached. 34
CacheableDependencyInterface::getCacheTags public function The cache tags associated with this object. 27
ConfigEntityInterface::calculateDependencies public function Calculates dependencies and stores them in the dependency property. 2
ConfigEntityInterface::disable public function Disables the configuration entity. 2
ConfigEntityInterface::enable public function Enables the configuration entity. 2
ConfigEntityInterface::get public function Returns the value of a property. 2
ConfigEntityInterface::getDependencies public function Gets the configuration dependencies. 2
ConfigEntityInterface::hasTrustedData public function Gets whether on not the data is trusted. 2
ConfigEntityInterface::isInstallable public function Checks whether this entity is installable. 2
ConfigEntityInterface::isUninstalling public function Returns whether this entity is being changed during the uninstall process. 2
ConfigEntityInterface::onDependencyRemoval public function Informs the entity that entities it depends on will be deleted. 2
ConfigEntityInterface::set public function Sets the value of a property. 2
ConfigEntityInterface::setStatus public function Sets the status of the configuration entity. 2
ConfigEntityInterface::status public function Returns whether the configuration entity is enabled. 2
ConfigEntityInterface::trustData public function Sets that the data should be trusted. 2
CorrespondingReferenceInterface::getBundles public function Gets an array of referenced bundle names keyed by entity ID. 1
CorrespondingReferenceInterface::getCorrespondingField public function Gets the name of the corresponding field of the provided field. 1
CorrespondingReferenceInterface::getCorrespondingFields public function Gets an array of the corresponding field names. 1
CorrespondingReferenceInterface::getFirstField public function Gets the first corresponding reference field id. 1
CorrespondingReferenceInterface::getId public function Gets the corresponding reference machine name. 1
CorrespondingReferenceInterface::getLabel public function Gets the corresponding reference label. 1
CorrespondingReferenceInterface::getSecondField public function Gets the second corresponding reference field id. 1
CorrespondingReferenceInterface::hasCorrespondingFields public function Checks whether the given entity has the configured corresponding reference fields. 1
CorrespondingReferenceInterface::isEnabled public function Get whether the corresponding reference is enabled. 1
CorrespondingReferenceInterface::isValid public function Checks if this corresponding reference is valid for the provided entity. 1
CorrespondingReferenceInterface::setBundles public function Sets the array of referenced bundle names keyed by entity ID. 1
CorrespondingReferenceInterface::setEnabled public function Sets whether the corresponding reference is enabled. 1
CorrespondingReferenceInterface::setFirstField public function Sets the first corresponding reference field ID. 1
CorrespondingReferenceInterface::setId public function Sets the corresponding reference machine name. 1
CorrespondingReferenceInterface::setLabel public function Sets the corresponding reference label. 1
CorrespondingReferenceInterface::setSecondField public function Sets the second corresponding reference field ID. 1
CorrespondingReferenceInterface::synchronizeCorrespondingField public function Synchronizes a single corresponding field on a corresponding entity. 1
CorrespondingReferenceInterface::synchronizeCorrespondingFields public function Synchronizes corresponding fields on the given entity. 1
EntityInterface::bundle public function Gets the bundle of the entity. 2
EntityInterface::create public static function Constructs a new entity object, without permanently saving it. 2
EntityInterface::createDuplicate public function Creates a duplicate of the entity. 2
EntityInterface::delete public function Deletes an entity permanently. 2
EntityInterface::enforceIsNew public function Enforces an entity to be new. 2
EntityInterface::getCacheTagsToInvalidate public function Returns the cache tags that should be used to invalidate caches. 2
EntityInterface::getConfigDependencyKey public function Gets the key that is used to store configuration dependencies. 2
EntityInterface::getConfigDependencyName public function Gets the configuration dependency name. 2
EntityInterface::getConfigTarget public function Gets the configuration target identifier for the entity. 2
EntityInterface::getEntityType public function Gets the entity type definition. 2
EntityInterface::getEntityTypeId public function Gets the ID of the type of the entity. 2
EntityInterface::getOriginalId public function Gets the original ID. 2
EntityInterface::getTypedData public function Gets a typed data object for this entity object. 2
EntityInterface::hasLinkTemplate public function Indicates if a link template exists for a given key. 2
EntityInterface::id public function Gets the identifier. 2
EntityInterface::isNew public function Determines whether the entity is new. 2
EntityInterface::label public function Gets the label of the entity. 2
EntityInterface::language public function Gets the language of the entity. 2
EntityInterface::link Deprecated public function Deprecated way of generating a link to the entity. See toLink(). 2
EntityInterface::load public static function Loads an entity. 2
EntityInterface::loadMultiple public static function Loads one or more entities. 2
EntityInterface::postCreate public function Acts on a created entity before hooks are invoked. 2
EntityInterface::postDelete public static function Acts on deleted entities before the delete hook is invoked. 2
EntityInterface::postLoad public static function Acts on loaded entities. 3
EntityInterface::postSave public function Acts on a saved entity before the insert or update hook is invoked. 2
EntityInterface::preCreate public static function Changes the values of an entity before it is created. 2
EntityInterface::preDelete public static function Acts on entities before they are deleted and before hooks are invoked. 2
EntityInterface::preSave public function Acts on an entity before the presave hook is invoked. 2
EntityInterface::referencedEntities public function Gets a list of entities referenced by this entity. 2
EntityInterface::save public function Saves an entity permanently. 2
EntityInterface::setOriginalId public function Sets the original ID. 2
EntityInterface::toArray public function Gets an array of all property values. 3
EntityInterface::toLink public function Generates the HTML for a link to this entity. 2
EntityInterface::toUrl public function Gets the URL object for the entity. 2
EntityInterface::uriRelationships public function Gets a list of URI relationships supported by this entity. 2
EntityInterface::url Deprecated public function Gets the public URL for this entity. 2
EntityInterface::urlInfo Deprecated public function Gets the URL object for the entity. 2
EntityInterface::uuid public function Gets the entity UUID (Universally Unique Identifier). 2
RefinableCacheableDependencyInterface::addCacheableDependency public function Adds a dependency on an object: merges its cacheability metadata. 1
RefinableCacheableDependencyInterface::addCacheContexts public function Adds cache contexts. 1
RefinableCacheableDependencyInterface::addCacheTags public function Adds cache tags. 1
RefinableCacheableDependencyInterface::mergeCacheMaxAge public function Merges the maximum age (in seconds) with the existing maximum age. 1
SynchronizableInterface::isSyncing public function Returns whether this entity is being changed as part of a synchronization. 1
SynchronizableInterface::setSyncing public function Sets the status of the synchronization flag. 1
ThirdPartySettingsInterface::getThirdPartyProviders public function Gets the list of third parties that store information. 5
ThirdPartySettingsInterface::getThirdPartySetting public function Gets the value of a third-party setting. 5
ThirdPartySettingsInterface::getThirdPartySettings public function Gets all third-party settings of a given module. 5
ThirdPartySettingsInterface::setThirdPartySetting public function Sets the value of a third-party setting. 5
ThirdPartySettingsInterface::unsetThirdPartySetting public function Unsets a third-party setting. 5