You are here

Home » API reference » Salesforce Suite 5.0.x » MappedObjectInterface.php

interface MappedObjectInterface in Salesforce Suite 5.0.x

Same name and namespace in other branches
  1. 8.4 modules/salesforce_mapping/src/Entity/MappedObjectInterface.php \Drupal\salesforce_mapping\Entity\MappedObjectInterface
  2. 8.3 modules/salesforce_mapping/src/Entity/MappedObjectInterface.php \Drupal\salesforce_mapping\Entity\MappedObjectInterface

Mapped Object interface.

Hierarchy

Expanded class hierarchy of MappedObjectInterface

All classes that implement MappedObjectInterface

12 files declare their use of MappedObjectInterface
DeleteHandlerTest.php in modules/salesforce_pull/tests/src/Unit/DeleteHandlerTest.php
PullBase.php in modules/salesforce_pull/src/Plugin/QueueWorker/PullBase.php
PullBaseTest.php in modules/salesforce_pull/tests/src/Unit/PullBaseTest.php
SalesforceDeleteAllowedEvent.php in modules/salesforce_mapping/src/Event/SalesforceDeleteAllowedEvent.php
SalesforcePullEntityValueEvent.php in modules/salesforce_mapping/src/Event/SalesforcePullEntityValueEvent.php

... See full list

File

modules/salesforce_mapping/src/Entity/MappedObjectInterface.php, line 15

Namespace

Drupal\salesforce_mapping\Entity
View source 
interface MappedObjectInterface extends EntityChangedInterface, RevisionLogInterface, ContentEntityInterface {

  /**
   * Get the attached mapping entity.
   *
   * @return SalesforceMappingInterface
   *   The mapping entity.
   */
  public function getMapping();

  /**
   * Get the mapped Drupal entity.
   *
   * @return \Drupal\Core\Entity\EntityInterface
   *   The mapped Drupal entity.
   */
  public function getMappedEntity();

  /**
   * Return a numeric timestamp for comparing to Salesforce record timestamp.
   *
   * @return int
   *   The entity_updated value from the Mapped Object.
   */
  public function getChanged();

  /**
   * Wrapper for salesforce.client service.
   *
   * @return \Drupal\salesforce\Rest\RestClientInterface
   *   The service.
   */
  public function client();

  /**
   * Wrapper for Drupal core event_dispatcher service.
   *
   * @return \Symfony\Component\EventDispatcher\EventDispatcherInterface
   *   Event dispatcher.
   */
  public function eventDispatcher();

  /**
   * Wrapper for config getter.
   */
  public function config($name);

  /**
   * Wrapper for salesforce auth provider plugin manager.
   *
   * @return \Drupal\salesforce\SalesforceAuthProviderPluginManagerInterface
   *   The auth provider plugin manager.
   */
  public function authMan();

  /**
   * Get a salesforce url for the linked record.
   *
   * @return string
   *   The salesforce url for the linked SF record.
   */
  public function getSalesforceUrl();

  /**
   * Attach a Drupal entity to the mapped object.
   *
   * @param \Drupal\Core\Entity\EntityInterface $entity
   *   The entity to be attached.
   *
   * @return $this
   */
  public function setDrupalEntityStub(EntityInterface $entity = NULL);

  /**
   * Wrapper for drupalEntityStub.
   *
   * @return \Drupal\Core\Entity\FieldableEntityInterface
   *   The mapped entity.
   */
  public function getDrupalEntityStub();

  /**
   * Get the mapped Salesforce record, only available during pull.
   *
   * @return \Drupal\salesforce\SObject
   *   The SObject data, available only during pull.
   */
  public function getSalesforceRecord();

  /**
   * Getter for salesforce_id.
   *
   * @return string
   *   SFID.
   */
  public function sfid();

  /**
   * Push data to Salesforce.
   *
   * @return mixed
   *   SFID or NULL depending on result from SF.
   */
  public function push();

  /**
   * Delete the mapped SF object in Salesforce.
   *
   * @return $this
   */
  public function pushDelete();

  /**
   * Set a Drupal entity for this mapped object.
   *
   * @return $this
   */
  public function setDrupalEntity(EntityInterface $entity = NULL);

  /**
   * Assign Salesforce data to this mapped object, in preparation for saving.
   *
   * @param \Drupal\salesforce\SObject $sfObject
   *   The sobject.
   *
   * @return $this
   */
  public function setSalesforceRecord(SObject $sfObject);

  /**
   * Pull the mapped SF object data from Salesforce.
   *
   * @return $this
   */
  public function pull();

  /**
   * Based on the Mapped Object revision limit, delete old revisions.
   *
   * @return $this
   */
  public function pruneRevisions(EntityStorageInterface $storage);

}

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
EntityChangedInterface::getChangedTime public function Gets the timestamp of the last entity change for the current translation.
EntityChangedInterface::getChangedTimeAcrossTranslations public function Gets the timestamp of the last entity change across all translations.
EntityChangedInterface::setChangedTime public function Sets the timestamp of the last entity change for the current translation.
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::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::uuid public function Gets the entity UUID (Universally Unique Identifier). 2
FieldableEntityInterface::baseFieldDefinitions public static function Provides base field definitions for an entity type. 2
FieldableEntityInterface::bundleFieldDefinitions public static function Provides field definitions for a specific bundle. 2
FieldableEntityInterface::get public function Gets a field item list. 1
FieldableEntityInterface::getFieldDefinition public function Gets the definition of a contained field. 1
FieldableEntityInterface::getFieldDefinitions public function Gets an array of field definitions of all contained fields. 1
FieldableEntityInterface::getFields public function Gets an array of all field item lists. 1
FieldableEntityInterface::getTranslatableFields public function Gets an array of field item lists for translatable fields. 1
FieldableEntityInterface::hasField public function Determines whether the entity has a field with the given name. 1
FieldableEntityInterface::isValidationRequired public function Checks whether entity validation is required before saving the entity. 1
FieldableEntityInterface::onChange public function Reacts to changes to a field. 1
FieldableEntityInterface::set public function Sets a field value. 1
FieldableEntityInterface::setValidationRequired public function Sets whether entity validation is required before saving the entity. 1
FieldableEntityInterface::validate public function Validates the currently set values. 1
MappedObjectInterface::authMan public function Wrapper for salesforce auth provider plugin manager. 1
MappedObjectInterface::client public function Wrapper for salesforce.client service. 1
MappedObjectInterface::config public function Wrapper for config getter. 1
MappedObjectInterface::eventDispatcher public function Wrapper for Drupal core event_dispatcher service. 1
MappedObjectInterface::getChanged public function Return a numeric timestamp for comparing to Salesforce record timestamp. 1
MappedObjectInterface::getDrupalEntityStub public function Wrapper for drupalEntityStub. 1
MappedObjectInterface::getMappedEntity public function Get the mapped Drupal entity. 1
MappedObjectInterface::getMapping public function Get the attached mapping entity. 1
MappedObjectInterface::getSalesforceRecord public function Get the mapped Salesforce record, only available during pull. 1
MappedObjectInterface::getSalesforceUrl public function Get a salesforce url for the linked record. 1
MappedObjectInterface::pruneRevisions public function Based on the Mapped Object revision limit, delete old revisions. 1
MappedObjectInterface::pull public function Pull the mapped SF object data from Salesforce. 1
MappedObjectInterface::push public function Push data to Salesforce. 1
MappedObjectInterface::pushDelete public function Delete the mapped SF object in Salesforce. 1
MappedObjectInterface::setDrupalEntity public function Set a Drupal entity for this mapped object. 1
MappedObjectInterface::setDrupalEntityStub public function Attach a Drupal entity to the mapped object. 1
MappedObjectInterface::setSalesforceRecord public function Assign Salesforce data to this mapped object, in preparation for saving. 1
MappedObjectInterface::sfid public function Getter for salesforce_id. 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
RevisionableInterface::getLoadedRevisionId public function Gets the loaded Revision ID of the entity. 1
RevisionableInterface::getRevisionId public function Gets the revision identifier of the entity. 1
RevisionableInterface::isDefaultRevision public function Checks if this entity is the default revision. 1
RevisionableInterface::isLatestRevision public function Checks if this entity is the latest revision. 1
RevisionableInterface::isNewRevision public function Determines whether a new revision should be created on save. 1
RevisionableInterface::preSaveRevision public function Acts on a revision before it gets saved. 1
RevisionableInterface::setNewRevision public function Enforces an entity to be saved as a new revision. 1
RevisionableInterface::updateLoadedRevisionId public function Updates the loaded Revision ID with the revision ID. 1
RevisionableInterface::wasDefaultRevision public function Checks whether the entity object was a default revision when it was saved. 1
RevisionLogInterface::getRevisionCreationTime public function Gets the entity revision creation timestamp. 1
RevisionLogInterface::getRevisionLogMessage public function Returns the entity revision log message.
RevisionLogInterface::getRevisionUser public function Gets the entity revision author.
RevisionLogInterface::getRevisionUserId public function Gets the entity revision author ID.
RevisionLogInterface::setRevisionCreationTime public function Sets the entity revision creation timestamp. 1
RevisionLogInterface::setRevisionLogMessage public function Sets the entity revision log message.
RevisionLogInterface::setRevisionUser public function Sets the entity revision author.
RevisionLogInterface::setRevisionUserId public function Sets the entity revision author by ID.
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
TranslatableInterface::addTranslation public function Adds a new translation to the translatable object. 1
TranslatableInterface::getTranslation public function Gets a translation of the data. 1
TranslatableInterface::getTranslationLanguages public function Returns the languages the data is translated to. 1
TranslatableInterface::getUntranslated public function Returns the translatable object referring to the original language. 1
TranslatableInterface::hasTranslation public function Checks there is a translation for the given language code. 1
TranslatableInterface::hasTranslationChanges public function Determines if the current translation of the entity has unsaved changes. 1
TranslatableInterface::isDefaultTranslation public function Checks whether the translation is the default one. 1
TranslatableInterface::isNewTranslation public function Checks whether the translation is new. 1
TranslatableInterface::isTranslatable public function Returns the translation support status. 1
TranslatableInterface::removeTranslation public function Removes the translation identified by the given language code. 1
TranslatableRevisionableInterface::isDefaultTranslationAffectedOnly public function Checks if untranslatable fields should affect only the default translation. 1
TranslatableRevisionableInterface::isLatestTranslationAffectedRevision public function Checks whether this is the latest revision affecting this translation. 1
TranslatableRevisionableInterface::isRevisionTranslationAffected public function Checks whether the current translation is affected by the current revision. 1
TranslatableRevisionableInterface::isRevisionTranslationAffectedEnforced public function Checks if the revision translation affected flag value has been enforced. 1
TranslatableRevisionableInterface::setRevisionTranslationAffected public function Marks the current revision translation as affected. 1
TranslatableRevisionableInterface::setRevisionTranslationAffectedEnforced public function Enforces the revision translation affected flag value. 1