interface MappingInterface in GatherContent 8.5

Same name and namespace in other branches

8.3 src/Entity/MappingInterface.php \Drupal\gathercontent\Entity\MappingInterface
8.4 src/Entity/MappingInterface.php \Drupal\gathercontent\Entity\MappingInterface

Provides an interface for defining GatherContent Mapping entities.

Hierarchy

interface \Drupal\Core\Entity\EntityInterface; interface \Drupal\Core\Config\Entity\ThirdPartySettingsInterface; interface \Drupal\Core\Entity\SynchronizableInterface
- interface \Drupal\Core\Config\Entity\ConfigEntityInterface
  - interface \Drupal\gathercontent\Entity\MappingInterface

Expanded class hierarchy of MappingInterface

All classes that implement MappingInterface

6 files declare their use of MappingInterface

Exporter.php in gathercontent_upload/src/Export/Exporter.php
gathercontent.module in ./gathercontent.module: Main module file for GatherContent module.
gathercontent_upload.module in gathercontent_upload/gathercontent_upload.module: Main module file for GatherContent Upload module.
MappingSteps.php in gathercontent_ui/src/Form/MappingEditSteps/MappingSteps.php
MappingStepService.php in gathercontent_ui/src/Form/MappingEditSteps/MappingStepService.php

... See full list

File

src/Entity/MappingInterface.php, line 10

Namespace

Drupal\gathercontent\Entity

View source

interface MappingInterface extends ConfigEntityInterface {

  /**
   * Getter for GatherContent project ID property.
   *
   * @return int
   *   GatherContent project ID.
   */
  public function getGathercontentProjectId();

  /**
   * Getter for GatherContent project property.
   *
   * @return string
   *   GatherContent project name.
   */
  public function getGathercontentProject();

  /**
   * Getter for GatherContent template ID property.
   *
   * @return int
   *   GatherContent template ID.
   */
  public function getGathercontentTemplateId();

  /**
   * Getter for GatherContent template property.
   *
   * @return string
   *   GatherContent template name.
   */
  public function getGathercontentTemplate();

  /**
   * Getter for entity type machine name.
   *
   * @return string
   *   Entity type machine name.
   */
  public function getMappedEntityType();

  /**
   * Setter for entity type machine name.
   *
   * @param string $entity_type
   *   Entity type machine name.
   */
  public function setMappedEntityType($entity_type);

  /**
   * Getter for content type machine name.
   *
   * @return string
   *   Content type machine name.
   */
  public function getContentType();

  /**
   * Setter for content type machine name.
   *
   * @param string $content_type
   *   Content type machine name.
   */
  public function setContentType($content_type);

  /**
   * Getter for content type human name.
   *
   * @return string
   *   Content type human name.
   */
  public function getContentTypeName();

  /**
   * Setter for content type human name.
   *
   * @param string $content_type_name
   *   Content type human name.
   */
  public function setContentTypeName($content_type_name);

  /**
   * Getter for GatherContent template serialized object.
   *
   * @return string
   *   Serialized GatherContent template.
   */
  public function getTemplate();

  /**
   * Setter for GatherContent template serialized object.
   *
   * @param string $template
   *   Serialized GatherContent template.
   */
  public function setTemplate($template);

  /**
   * Getter for mapping data.
   *
   * @return string
   *   Serialized object of mapping.
   */
  public function getData();

  /**
   * Setter for mapping data.
   *
   * @param string $data
   *   Serialized object of mapping.
   */
  public function setData($data);

  /**
   * Setter for updated drupal property.
   *
   * @param string $updated_drupal
   *   Timestamp when was mapping updated.
   */
  public function setUpdatedDrupal($updated_drupal);

  /**
   * Validate if object is configured with mapping.
   *
   * @return bool
   *   Return TRUE if object has mapping, otherwise FALSE.
   */
  public function hasMapping();

  /**
   * Formatter for content type property.
   *
   * @return string
   *   If not empty return human name for content type, else return None string.
   */
  public function getFormattedContentType();

  /**
   * Formatter for entity type property.
   *
   * @return string
   *   If not empty return human name for entity type, else return None string.
   */
  public function getFormattedEntityType();

  /**
   * Formatter for updated drupal property.
   *
   * @return string
   *   If not empty return formatted date, else return string Never.
   */
  public function getFormatterUpdatedDrupal();

  /**
   * Getter for GatherContent migrations list.
   *
   * @return array
   *   Migration id list as array.
   */
  public function getMigrations();

}

Members

Name	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
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
MappingInterface::getContentType	public	function	Getter for content type machine name.	1
MappingInterface::getContentTypeName	public	function	Getter for content type human name.	1
MappingInterface::getData	public	function	Getter for mapping data.	1
MappingInterface::getFormattedContentType	public	function	Formatter for content type property.	1
MappingInterface::getFormattedEntityType	public	function	Formatter for entity type property.	1
MappingInterface::getFormatterUpdatedDrupal	public	function	Formatter for updated drupal property.	1
MappingInterface::getGathercontentProject	public	function	Getter for GatherContent project property.	1
MappingInterface::getGathercontentProjectId	public	function	Getter for GatherContent project ID property.	1
MappingInterface::getGathercontentTemplate	public	function	Getter for GatherContent template property.	1
MappingInterface::getGathercontentTemplateId	public	function	Getter for GatherContent template ID property.	1
MappingInterface::getMappedEntityType	public	function	Getter for entity type machine name.	1
MappingInterface::getMigrations	public	function	Getter for GatherContent migrations list.	1
MappingInterface::getTemplate	public	function	Getter for GatherContent template serialized object.	1
MappingInterface::hasMapping	public	function	Validate if object is configured with mapping.	1
MappingInterface::setContentType	public	function	Setter for content type machine name.	1
MappingInterface::setContentTypeName	public	function	Setter for content type human name.	1
MappingInterface::setData	public	function	Setter for mapping data.	1
MappingInterface::setMappedEntityType	public	function	Setter for entity type machine name.	1
MappingInterface::setTemplate	public	function	Setter for GatherContent template serialized object.	1
MappingInterface::setUpdatedDrupal	public	function	Setter for updated drupal property.	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

You are here

interface MappingInterface in GatherContent 8.5

Hierarchy

File

Namespace

Members

API Navigation