Webform module and config export
This commit is contained in:
Rob Davies
parent
3e6a5cbed2
commit
0e15467384
1040 changed files with 117682 additions and 0 deletions
328
web/modules/contrib/webform/src/WebformSubmissionInterface.php
Normal file
328
web/modules/contrib/webform/src/WebformSubmissionInterface.php
Normal file
|
|
@ -0,0 +1,328 @@
|
|||
<?php
|
||||
|
||||
namespace Drupal\webform;
|
||||
|
||||
use Drupal\user\EntityOwnerInterface;
|
||||
use Drupal\Core\Entity\ContentEntityInterface;
|
||||
|
||||
/**
|
||||
* Provides an interface defining a webform submission entity.
|
||||
*/
|
||||
interface WebformSubmissionInterface extends ContentEntityInterface, EntityOwnerInterface {
|
||||
|
||||
/**
|
||||
* Return status for new submission.
|
||||
*/
|
||||
const STATE_UNSAVED = 'unsaved';
|
||||
|
||||
/**
|
||||
* Return status for submission in draft.
|
||||
*/
|
||||
const STATE_DRAFT = 'draft';
|
||||
|
||||
/**
|
||||
* Return status for submission that has been completed.
|
||||
*/
|
||||
const STATE_COMPLETED = 'completed';
|
||||
|
||||
/**
|
||||
* Return status for submission that has been updated.
|
||||
*/
|
||||
const STATE_UPDATED = 'updated';
|
||||
|
||||
/**
|
||||
* Gets the serial number.
|
||||
*
|
||||
* @return int
|
||||
* The serial number.
|
||||
*/
|
||||
public function serial();
|
||||
|
||||
/**
|
||||
* 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);
|
||||
|
||||
/**
|
||||
* 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 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();
|
||||
|
||||
/**
|
||||
* Checks submission notes.
|
||||
*
|
||||
* @return bool
|
||||
* TRUE if the submission has notes.
|
||||
*/
|
||||
public function hasNotes();
|
||||
|
||||
/**
|
||||
* Track the state of a submission.
|
||||
*
|
||||
* @return int
|
||||
* Either STATE_NEW, STATE_DRAFT, STATE_COMPLETED, or STATE_UPDATED,
|
||||
* depending on the last save operation performed.
|
||||
*/
|
||||
public function getState();
|
||||
|
||||
/**
|
||||
* Gets the webform submission's data.
|
||||
*
|
||||
* @param string $key
|
||||
* A string that maps to a key in the submission's data.
|
||||
* If no key is specified, then the entire data array is returned.
|
||||
*
|
||||
* @return array
|
||||
* The webform submission data.
|
||||
*/
|
||||
public function getData($key = NULL);
|
||||
|
||||
/**
|
||||
* Set the webform submission's data.
|
||||
*
|
||||
* @param array $data
|
||||
* The webform submission data.
|
||||
*/
|
||||
public function setData(array $data);
|
||||
|
||||
/**
|
||||
* Gets the webform submission's original data before any changes..
|
||||
*
|
||||
* @param string $key
|
||||
* A string that maps to a key in the submission's original data.
|
||||
* If no key is specified, then the entire data array is returned.
|
||||
*
|
||||
* @return array
|
||||
* The webform submission original data.
|
||||
*/
|
||||
public function getOriginalData($key = NULL);
|
||||
|
||||
/**
|
||||
* Set the webform submission's original data.
|
||||
*
|
||||
* @param array $data
|
||||
* The webform submission data.
|
||||
*
|
||||
* @return $this
|
||||
*/
|
||||
public function setOriginalData(array $data);
|
||||
|
||||
/**
|
||||
* 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.
|
||||
*
|
||||
* @return \Drupal\Core\Entity\EntityInterface|null
|
||||
* The entity that this webform submission was created from.
|
||||
*/
|
||||
public function getSourceEntity();
|
||||
|
||||
/**
|
||||
* 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.
|
||||
*
|
||||
* @return \Drupal\Core\Url
|
||||
* The the webform submission's secure tokenized URL.
|
||||
*/
|
||||
public function getTokenUrl();
|
||||
|
||||
/**
|
||||
* Invoke all webform handlers method.
|
||||
*
|
||||
* @param string $method
|
||||
* The webform handler method to be invoked.
|
||||
*/
|
||||
public function invokeWebformHandlers($method);
|
||||
|
||||
/**
|
||||
* Invoke a webform element elements method.
|
||||
*
|
||||
* @param string $method
|
||||
* The webform element method to be invoked.
|
||||
*/
|
||||
public function invokeWebformElements($method);
|
||||
|
||||
/**
|
||||
* Gets an array of all property values.
|
||||
*
|
||||
* @param bool $custom
|
||||
* If TRUE, return customized array that contains simplified properties
|
||||
* and webform submission data.
|
||||
* @param bool $check_access
|
||||
* If TRUE, view access is checked for element data.
|
||||
*
|
||||
* @return mixed[]
|
||||
* An array of property values, keyed by property name.
|
||||
*/
|
||||
public function toArray($custom = FALSE, $check_access = FALSE);
|
||||
|
||||
}
|
||||
Reference in a new issue