You are here

Home » API reference » Webform 6.x » WebformSubmissionInterface.php

interface WebformSubmissionInterface in Webform 6.x

Same name and namespace in other branches
  1. 8.5 src/WebformSubmissionInterface.php \Drupal\webform\WebformSubmissionInterface

Provides an interface defining a webform submission entity.

Hierarchy

Expanded class hierarchy of WebformSubmissionInterface

All classes that implement WebformSubmissionInterface

157 files declare their use of WebformSubmissionInterface
ActionWebformHandler.php in src/Plugin/WebformHandler/ActionWebformHandler.php
Address.php in src/Plugin/WebformElement/Address.php
BooleanBase.php in src/Plugin/WebformElement/BooleanBase.php
Captcha.php in src/Plugin/WebformElement/Captcha.php
Checkbox.php in src/Plugin/WebformElement/Checkbox.php

... See full list

File

src/WebformSubmissionInterface.php, line 13

Namespace

Drupal\webform
View source 
interface WebformSubmissionInterface extends ContentEntityInterface, EntityOwnerInterface {

  /**
   * Return status for new submission.
   */
  const STATE_UNSAVED = 'unsaved';

  /**
   * Return status for submission in draft created.
   */
  const STATE_DRAFT = 'draft';

  /**
   * Return status for submission in draft created.
   */
  const STATE_DRAFT_CREATED = 'draft_created';

  /**
   * Return status for submission in draft updated.
   */
  const STATE_DRAFT_UPDATED = 'draft_updated';

  /**
   * Return status for submission that has been completed.
   */
  const STATE_COMPLETED = 'completed';

  /**
   * Return status for submission that has been locked.
   */
  const STATE_LOCKED = 'locked';

  /**
   * Return status for submission that has been updated.
   */
  const STATE_UPDATED = 'updated';

  /**
   * Return status for submission that has been deleted.
   */
  const STATE_DELETED = 'deleted';

  /**
   * Return status for submission that has been converted from anonymous to authenticated.
   */
  const STATE_CONVERTED = 'converted';

  /**
   * Gets the serial number.
   *
   * @return int
   *   The serial number.
   */
  public function serial();

  /**
   * Gets the langcode of the field values held in the object.
   *
   * @return string
   *   The langcode.
   */
  public function getLangcode();

  /**
   * Sets the langcode of the field values held in the object.
   *
   * @param string $langcode
   *   The langcode.
   *
   * @return $this
   */
  public function setLangcode($langcode);

  /**
   * Returns the time that the submission was created.
   *
   * @return int
   *   The timestamp of when the submission was created.
   */
  public function getCreatedTime();

  /**
   * Sets the creation date of the submission.
   *
   * @param int $created
   *   The timestamp of when the submission was created.
   *
   * @return $this
   */
  public function setCreatedTime($created);

  /**
   * Gets the timestamp of the last submission change.
   *
   * @return int
   *   The timestamp of the last submission save operation.
   */
  public function getChangedTime();

  /**
   * Sets the timestamp of the last submission change.
   *
   * @param int $timestamp
   *   The timestamp of the last submission save operation.
   *
   * @return $this
   */
  public function setChangedTime($timestamp);

  /**
   * Gets the timestamp of the submission completion.
   *
   * @return int
   *   The timestamp of the submission completion.
   */
  public function getCompletedTime();

  /**
   * Sets the timestamp of the submission completion.
   *
   * @param int $timestamp
   *   The timestamp of the submission completion.
   *
   * @return $this
   */
  public function setCompletedTime($timestamp);

  /**
   * Get the submission's notes.
   *
   * @return string
   *   The submission's notes.
   */
  public function getNotes();

  /**
   * Sets the submission's notes.
   *
   * @param string $notes
   *   The submission's notes.
   *
   * @return $this
   */
  public function setNotes($notes);

  /**
   * Get the submission's sticky flag.
   *
   * @return string
   *   The submission's stick flag.
   */
  public function getSticky();

  /**
   * Sets the submission's sticky flag.
   *
   * @param bool $sticky
   *   The submission's stick flag.
   *
   * @return $this
   */
  public function setSticky($sticky);

  /**
   * Get the submission's locked status.
   *
   * @return string
   *   The submission's lock status.
   */
  public function isLocked();

  /**
   * Sets the submission's locked flag.
   *
   * @param bool $locked
   *   The submission's locked flag.
   *
   * @return $this
   */
  public function setLocked($locked);

  /**
   * Gets the remote IP address of the submission.
   *
   * @return string
   *   The remote IP address of the submission
   */
  public function getRemoteAddr();

  /**
   * Sets remote IP address of the submission.
   *
   * @param string $ip_address
   *   The remote IP address of the submission.
   *
   * @return $this
   */
  public function setRemoteAddr($ip_address);

  /**
   * Gets the submission's current page.
   *
   * @return string
   *   The submission's current page.
   */
  public function getCurrentPage();

  /**
   * Sets the submission's current page.
   *
   * @param string $current_page
   *   The submission's current page.
   *
   * @return $this
   */
  public function setCurrentPage($current_page);

  /**
   * Get the submission's current page title.
   *
   * @return string
   *   The submission's current page title.
   */
  public function getCurrentPageTitle();

  /**
   * Is the current submission in draft.
   *
   * @return bool
   *   TRUE if the current submission is a draft.
   */
  public function isDraft();

  /**
   * Is the current submission being converted from anonymous to authenticated.
   *
   * @return bool
   *   TRUE if the current submission being converted from anonymous to
   *   authenticated.
   */
  public function isConverting();

  /**
   * Is the current submission completed.
   *
   * @return bool
   *   TRUE if the current submission has been completed.
   */
  public function isCompleted();

  /**
   * Returns the submission sticky status.
   *
   * @return bool
   *   TRUE if the submission is sticky.
   */
  public function isSticky();

  /**
   * Test whether the provided account is owner of this webform submission.
   *
   * @param \Drupal\Core\Session\AccountInterface $account
   *   Account whose ownership to test.
   *
   * @return bool
   *   Whether the provided account is owner of this webform submission.
   */
  public function isOwner(AccountInterface $account);

  /**
   * Checks submission notes.
   *
   * @return bool
   *   TRUE if the submission has notes.
   */
  public function hasNotes();

  /**
   * Track the state of a submission.
   *
   * @return string
   *   Either STATE_UNSAVED, STATE_DRAFT_CREATED, STATE_DRAFT_UPDATED,
   *   STATE_COMPLETED, STATE_UPDATED, STATE_LOCKED, or STATE_CONVERTED
   *   depending on the last save operation performed.
   */
  public function getState();

  /**
   * Get a webform submission element's data.
   *
   * @param string $key
   *   An webform submission element's key.
   *
   * @return mixed
   *   An webform submission element's data/value.
   */
  public function getElementData($key);

  /**
   * Set a webform submission element's data.
   *
   * @param string $key
   *   An webform submission element's key.
   * @param mixed $value
   *   A value.
   *
   * @return $this
   */
  public function setElementData($key, $value);

  /**
   * Gets the webform submission's raw data.
   *
   * @return array
   *   The webform submission raw data.
   */
  public function getRawData();

  /**
   * Gets the webform submission's data with computed valued.
   *
   * @return array
   *   The webform submission data with computed valued.
   */
  public function getData();

  /**
   * Set the webform submission's data.
   *
   * @param array $data
   *   The webform submission data.
   *
   * @return $this
   */
  public function setData(array $data);

  /**
   * Gets the webform submission's original data before any changes.
   *
   * @return array
   *   The webform submission original data.
   */
  public function getOriginalData();

  /**
   * Set the webform submission's original data.
   *
   * @param array $data
   *   The webform submission data.
   *
   * @return $this
   */
  public function setOriginalData(array $data);

  /**
   * Get a webform submission element's original data.
   *
   * @param string $key
   *   An webform submission element's key.
   *
   * @return mixed
   *   An webform submission element's original data/value.
   */
  public function getElementOriginalData($key);

  /**
   * Get a webform submission data as a hash view.
   *
   * @return string
   *   Webform submission data as a hash view.
   */
  public function getDataHash();

  /**
   * Gets the webform submission's token.
   *
   * @return array
   *   The webform submission data.
   */
  public function getToken();

  /**
   * Gets the webform submission's webform entity.
   *
   * @return \Drupal\webform\WebformInterface
   *   The webform entity.
   */
  public function getWebform();

  /**
   * Gets the webform submission's source entity.
   *
   * @param bool $translate
   *   (optional) If TRUE the source entity will be translated.
   *
   * @return \Drupal\Core\Entity\EntityInterface|null
   *   The entity that this webform submission was created from.
   */
  public function getSourceEntity($translate = FALSE);

  /**
   * Gets the webform submission's source URL.
   *
   * @return \Drupal\Core\Url|false
   *   The source URL.
   */
  public function getSourceUrl();

  /**
   * Gets the webform submission's secure tokenized URL.
   *
   * @param string $operation
   *   Token URL's operation. Defaults to update.
   *
   * @return \Drupal\Core\Url
   *   The webform submission's secure tokenized URL.
   */
  public function getTokenUrl($operation = 'update');

  /**
   * Invoke all webform handlers method.
   *
   * @param string $method
   *   The webform handler method to be invoked.
   *
   * @return \Drupal\Core\Access\AccessResult|null
   *   If 'access' method is invoked an AccessResult is returned.
   */
  public function invokeWebformHandlers($method);

  /**
   * Invoke a webform element elements method.
   *
   * @param string $method
   *   The webform element method to be invoked.
   */
  public function invokeWebformElements($method);

  /**
   * Convert anonymous submission to authenticated.
   *
   * @param \Drupal\user\UserInterface $account
   *   An authenticated user account.
   */
  public function convert(UserInterface $account);

  /**
   * Resave a webform submission without trigger any hooks or handlers.
   */
  public function resave();

  /**
   * Gets an array of all property values.
   *
   * @param bool $custom
   *   If TRUE, return customized array that contains simplified properties
   *   and webform submission (element) data.
   * @param bool $check_access
   *   If $custom and $check_access is TRUE, view access is checked
   *   for webform submission (element) data.
   *
   * @return mixed[]
   *   An array of property values, keyed by property name.
   */
  public function toArray($custom = FALSE, $check_access = FALSE);

}

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
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::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
EntityOwnerInterface::getOwner public function Returns the entity owner's user entity. 1
EntityOwnerInterface::getOwnerId public function Returns the entity owner's user ID. 1
EntityOwnerInterface::setOwner public function Sets the entity owner's user entity. 1
EntityOwnerInterface::setOwnerId public function Sets the entity owner's user ID. 1
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
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
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
WebformSubmissionInterface::convert public function Convert anonymous submission to authenticated. 1
WebformSubmissionInterface::getChangedTime public function Gets the timestamp of the last submission change. 1
WebformSubmissionInterface::getCompletedTime public function Gets the timestamp of the submission completion. 1
WebformSubmissionInterface::getCreatedTime public function Returns the time that the submission was created. 1
WebformSubmissionInterface::getCurrentPage public function Gets the submission's current page. 1
WebformSubmissionInterface::getCurrentPageTitle public function Get the submission's current page title. 1
WebformSubmissionInterface::getData public function Gets the webform submission's data with computed valued. 1
WebformSubmissionInterface::getDataHash public function Get a webform submission data as a hash view. 1
WebformSubmissionInterface::getElementData public function Get a webform submission element's data. 1
WebformSubmissionInterface::getElementOriginalData public function Get a webform submission element's original data. 1
WebformSubmissionInterface::getLangcode public function Gets the langcode of the field values held in the object. 1
WebformSubmissionInterface::getNotes public function Get the submission's notes. 1
WebformSubmissionInterface::getOriginalData public function Gets the webform submission's original data before any changes. 1
WebformSubmissionInterface::getRawData public function Gets the webform submission's raw data. 1
WebformSubmissionInterface::getRemoteAddr public function Gets the remote IP address of the submission. 1
WebformSubmissionInterface::getSourceEntity public function Gets the webform submission's source entity. 1
WebformSubmissionInterface::getSourceUrl public function Gets the webform submission's source URL. 1
WebformSubmissionInterface::getState public function Track the state of a submission. 1
WebformSubmissionInterface::getSticky public function Get the submission's sticky flag. 1
WebformSubmissionInterface::getToken public function Gets the webform submission's token. 1
WebformSubmissionInterface::getTokenUrl public function Gets the webform submission's secure tokenized URL. 1
WebformSubmissionInterface::getWebform public function Gets the webform submission's webform entity. 1
WebformSubmissionInterface::hasNotes public function Checks submission notes. 1
WebformSubmissionInterface::invokeWebformElements public function Invoke a webform element elements method. 1
WebformSubmissionInterface::invokeWebformHandlers public function Invoke all webform handlers method. 1
WebformSubmissionInterface::isCompleted public function Is the current submission completed. 1
WebformSubmissionInterface::isConverting public function Is the current submission being converted from anonymous to authenticated. 1
WebformSubmissionInterface::isDraft public function Is the current submission in draft. 1
WebformSubmissionInterface::isLocked public function Get the submission's locked status. 1
WebformSubmissionInterface::isOwner public function Test whether the provided account is owner of this webform submission. 1
WebformSubmissionInterface::isSticky public function Returns the submission sticky status. 1
WebformSubmissionInterface::resave public function Resave a webform submission without trigger any hooks or handlers. 1
WebformSubmissionInterface::serial public function Gets the serial number. 1
WebformSubmissionInterface::setChangedTime public function Sets the timestamp of the last submission change. 1
WebformSubmissionInterface::setCompletedTime public function Sets the timestamp of the submission completion. 1
WebformSubmissionInterface::setCreatedTime public function Sets the creation date of the submission. 1
WebformSubmissionInterface::setCurrentPage public function Sets the submission's current page. 1
WebformSubmissionInterface::setData public function Set the webform submission's data. 1
WebformSubmissionInterface::setElementData public function Set a webform submission element's data. 1
WebformSubmissionInterface::setLangcode public function Sets the langcode of the field values held in the object. 1
WebformSubmissionInterface::setLocked public function Sets the submission's locked flag. 1
WebformSubmissionInterface::setNotes public function Sets the submission's notes. 1
WebformSubmissionInterface::setOriginalData public function Set the webform submission's original data. 1
WebformSubmissionInterface::setRemoteAddr public function Sets remote IP address of the submission. 1
WebformSubmissionInterface::setSticky public function Sets the submission's sticky flag. 1
WebformSubmissionInterface::STATE_COMPLETED constant Return status for submission that has been completed.
WebformSubmissionInterface::STATE_CONVERTED constant Return status for submission that has been converted from anonymous to authenticated.
WebformSubmissionInterface::STATE_DELETED constant Return status for submission that has been deleted.
WebformSubmissionInterface::STATE_DRAFT constant Return status for submission in draft created.
WebformSubmissionInterface::STATE_DRAFT_CREATED constant Return status for submission in draft created.
WebformSubmissionInterface::STATE_DRAFT_UPDATED constant Return status for submission in draft updated.
WebformSubmissionInterface::STATE_LOCKED constant Return status for submission that has been locked.
WebformSubmissionInterface::STATE_UNSAVED constant Return status for new submission.
WebformSubmissionInterface::STATE_UPDATED constant Return status for submission that has been updated.
WebformSubmissionInterface::toArray public function Gets an array of all property values. Overrides FieldableEntityInterface::toArray 1