interface WebformEntityStorageInterface in Webform 6.x

Provides an interface for Webform storage.

Hierarchy

• interface \Drupal\Core\Config\Entity\ConfigEntityStorageInterface; interface \Drupal\Core\Config\Entity\ImportableEntityStorageInterface
  • interface \Drupal\webform\WebformEntityStorageInterface

File

src/WebformEntityStorageInterface.php, line 11

Namespace

Drupal\webform

interface WebformEntityStorageInterface extends ConfigEntityStorageInterface, ImportableEntityStorageInterface {

  /**
   * Gets the names of all categories.
   *
   * @param null|bool $template
   *   If TRUE only template categories will be returned.
   *   If FALSE only webform categories will be returned.
   *   If NULL all categories will be returned.
   *
   * @return string[]
   *   An array of translated categories, sorted alphabetically.
   */
  public function getCategories($template = NULL);

  /**
   * Get all webforms grouped by category.
   *
   * @param null|bool $template
   *   If TRUE only template categories will be returned.
   *   If FALSE only webform categories will be returned.
   *   If NULL all categories will be returned.
   *
   * @return string[]
   *   An array of options grouped by category.
   */
  public function getOptions($template = NULL);

  /**
   * Returns the next serial number.
   *
   * @return int
   *   The next serial number.
   */
  public function getNextSerial(WebformInterface $webform);

  /**
   * Set the next serial number.
   *
   * @param \Drupal\webform\WebformInterface $webform
   *   A webform.
   * @param int $next_serial
   *   The next serial number.
   */
  public function setNextSerial(WebformInterface $webform, $next_serial);

  /**
   * Returns the next serial number for a webform's submission.
   *
   * @return int
   *   The next serial number for a webform's submission.
   */
  public function getSerial(WebformInterface $webform);

  /**
   * Returns a webform's max serial number.
   *
   * @param \Drupal\webform\WebformInterface $webform
   *   A webform.
   *
   * @return int
   *   The next serial number.
   */
  public function getMaxSerial(WebformInterface $webform);

  /**
   * Get total results for all webforms.
   *
   * @return array
   *   An associative array keyed by webform id contains total results for
   *   all webforms.
   */
  public function getTotalNumberOfResults();

}

Members

Name	Modifiers	Type	Description	Overrides
ConfigEntityStorageInterface::createFromStorageRecord	public	function	Creates a configuration entity from storage values.	1
ConfigEntityStorageInterface::getIDFromConfigName	public static	function	Extracts the configuration entity ID from the full configuration name.	1
ConfigEntityStorageInterface::loadMultipleOverrideFree	public	function	Loads one or more entities in their original form without overrides.	1
ConfigEntityStorageInterface::loadOverrideFree	public	function	Loads one entity in their original form without overrides.	1
ConfigEntityStorageInterface::updateFromStorageRecord	public	function	Updates a configuration entity from storage values.	1
EntityStorageInterface::create	public	function	Constructs a new entity object, without permanently saving it.	1
EntityStorageInterface::delete	public	function	Deletes permanently saved entities.	1
EntityStorageInterface::deleteRevision	public	function	Delete a specific entity revision.	4
EntityStorageInterface::FIELD_LOAD_CURRENT		constant	Load the most recent version of an entity's field data.
EntityStorageInterface::FIELD_LOAD_REVISION		constant	Load the version of an entity's field data specified in the entity.
EntityStorageInterface::getAggregateQuery	public	function	Gets an aggregated query instance.	1
EntityStorageInterface::getEntityType	public	function	Gets the entity type definition.	1
EntityStorageInterface::getEntityTypeId	public	function	Gets the entity type ID.	1
EntityStorageInterface::getQuery	public	function	Gets an entity query instance.	1
EntityStorageInterface::hasData	public	function	Determines if the storage contains any data.	1
EntityStorageInterface::load	public	function	Loads one entity.	1
EntityStorageInterface::loadByProperties	public	function	Load entities by their property values.	1
EntityStorageInterface::loadMultiple	public	function	Loads one or more entities.	1
EntityStorageInterface::loadRevision	public	function	Load a specific entity revision.	4
EntityStorageInterface::loadUnchanged	public	function	Loads an unchanged entity from the database.	1
EntityStorageInterface::resetCache	public	function	Resets the internal entity cache.	1
EntityStorageInterface::restore	public	function	Restores a previously saved entity.	1
EntityStorageInterface::save	public	function	Saves the entity permanently.	1
ImportableEntityStorageInterface::importCreate	public	function	Creates entities upon synchronizing configuration changes.	1
ImportableEntityStorageInterface::importDelete	public	function	Delete entities upon synchronizing configuration changes.	1
ImportableEntityStorageInterface::importRename	public	function	Renames entities upon synchronizing configuration changes.	1
ImportableEntityStorageInterface::importUpdate	public	function	Updates entities upon synchronizing configuration changes.	1
WebformEntityStorageInterface::getCategories	public	function	Gets the names of all categories.	1
WebformEntityStorageInterface::getMaxSerial	public	function	Returns a webform's max serial number.	1
WebformEntityStorageInterface::getNextSerial	public	function	Returns the next serial number.	1
WebformEntityStorageInterface::getOptions	public	function	Get all webforms grouped by category.	1
WebformEntityStorageInterface::getSerial	public	function	Returns the next serial number for a webform's submission.	1
WebformEntityStorageInterface::getTotalNumberOfResults	public	function	Get total results for all webforms.	1
WebformEntityStorageInterface::setNextSerial	public	function	Set the next serial number.	1