interface RdfMappingInterface

Same name in other branches
  1. 9 core/modules/rdf/src/RdfMappingInterface.php \Drupal\rdf\RdfMappingInterface

Provides an interface defining an RDF mapping entity.

Hierarchy

  • interface \Drupal\Core\Config\Entity\ThirdPartySettingsInterface; interface \Drupal\Core\Entity\EntityInterface extends \Drupal\Core\Access\AccessibleInterface \Drupal\Core\Cache\CacheableDependencyInterface \Drupal\Core\Cache\RefinableCacheableDependencyInterface; interface \Drupal\Core\Entity\SynchronizableInterface extends \Drupal\Core\Entity\EntityInterface
    • interface \Drupal\Core\Config\Entity\ConfigEntityInterface extends \Drupal\Core\Entity\EntityInterface \Drupal\Core\Config\Entity\ThirdPartySettingsInterface \Drupal\Core\Entity\SynchronizableInterface
      • interface \Drupal\rdf\RdfMappingInterface extends \Drupal\Core\Config\Entity\ConfigEntityInterface

Expanded class hierarchy of RdfMappingInterface

All classes that implement RdfMappingInterface

2 files declare their use of RdfMappingInterface
MigrateRdfMappingTest.php in core/modules/rdf/tests/src/Kernel/Migrate/d7/MigrateRdfMappingTest.php
RdfMapping.php in core/modules/rdf/src/Entity/RdfMapping.php

File

core/modules/rdf/src/RdfMappingInterface.php, line 10

Namespace

Drupal\rdf
View source
interface RdfMappingInterface extends ConfigEntityInterface {
    
    /**
     * Gets the mapping for the bundle-level data.
     *
     * The prepared bundle mapping should be used when outputting data in RDF
     * serializations such as RDFa. In the prepared mapping, the mapping
     * configuration's CURIE arrays are processed into CURIE strings suitable for
     * output.
     *
     * @return array
     *   The bundle mapping.
     */
    public function getPreparedBundleMapping();
    
    /**
     * Gets the mapping config for the bundle-level data.
     *
     * This function returns the bundle mapping as stored in config, which may
     * contain CURIE arrays. If the mapping is needed for output in a
     * serialization format, such as RDFa, then getPreparedBundleMapping() should
     * be used instead.
     *
     * @return array
     *   The bundle mapping, or an empty array if there is no mapping.
     */
    public function getBundleMapping();
    
    /**
     * Sets the mapping config for the bundle-level data.
     *
     * This only sets bundle-level mappings, such as the RDF type. Mappings for
     * a bundle's fields should be handled with setFieldMapping.
     *
     * Example usage:
     * -Map the 'article' bundle to 'sioc:Post'.
     * @code
     * rdf_get_mapping('node', 'article')
     *   ->setBundleMapping(array(
     *     'types' => array('sioc:Post'),
     *   ))
     *   ->save();
     * @endcode
     *
     * @param array $mapping
     *   The bundle mapping.
     *
     * @return \Drupal\rdf\Entity\RdfMapping
     *   The RdfMapping object.
     */
    public function setBundleMapping(array $mapping);
    
    /**
     * Gets the prepared mapping for a field.
     *
     * The prepared field mapping should be used when outputting data in RDF
     * serializations such as RDFa. In the prepared mapping, the mapping
     * configuration's CURIE arrays are processed into CURIE strings suitable for
     * output.
     *
     * @param string $field_name
     *   The name of the field.
     *
     * @return array
     *   The prepared field mapping, or an empty array if there is no mapping.
     */
    public function getPreparedFieldMapping($field_name);
    
    /**
     * Gets the mapping config for a field.
     *
     * This function returns the field mapping as stored in config, which may
     * contain CURIE arrays. If the mapping is needed for output in a
     * serialization format, such as RDFa, then getPreparedFieldMapping() should
     * be used instead.
     *
     * @param string $field_name
     *   The name of the field.
     *
     * @return array
     *   The field mapping config array, or an empty array if there is no mapping.
     */
    public function getFieldMapping($field_name);
    
    /**
     * Sets the mapping config for a field.
     *
     * @param string $field_name
     *   The name of the field.
     * @param array $mapping
     *   The field mapping.
     *
     * @return \Drupal\rdf\Entity\RdfMapping
     *   The RdfMapping object.
     */
    public function setFieldMapping($field_name, array $mapping = []);

}

Members

Title Sort descending Deprecated Modifiers Object type Summary 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
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
RdfMappingInterface::getBundleMapping public function Gets the mapping config for the bundle-level data. 1
RdfMappingInterface::getFieldMapping public function Gets the mapping config for a field. 1
RdfMappingInterface::getPreparedBundleMapping public function Gets the mapping for the bundle-level data. 1
RdfMappingInterface::getPreparedFieldMapping public function Gets the prepared mapping for a field. 1
RdfMappingInterface::setBundleMapping public function Sets the mapping config for the bundle-level data. 1
RdfMappingInterface::setFieldMapping public function Sets the mapping config for a field. 1
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

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.