You are here

interface WebformOptionsCustomStorageInterface in Webform 6.x

Same name and namespace in other branches
  1. 8.5 modules/webform_options_custom/src/WebformOptionsCustomStorageInterface.php \Drupal\webform_options_custom\WebformOptionsCustomStorageInterface

Provides an interface for webform options custom storage.

Hierarchy

Expanded class hierarchy of WebformOptionsCustomStorageInterface

All classes that implement WebformOptionsCustomStorageInterface

File

modules/webform_options_custom/src/WebformOptionsCustomStorageInterface.php, line 11

Namespace

Drupal\webform_options_custom
View source
interface WebformOptionsCustomStorageInterface extends ConfigEntityStorageInterface, ImportableEntityStorageInterface {

  /**
   * Gets the names of all categories.
   *
   * @return string[]
   *   An array of translated categories, sorted alphabetically.
   */
  public function getCategories();

  /**
   * Get all webform options custom grouped by category.
   *
   * @return string[]
   *   An array of webform options custom grouped by category.
   */
  public function getOptionsCustom();

  /**
   * Get list of webform that use the specified webform custom options.
   *
   * @param \Drupal\webform_options_custom\WebformOptionsCustomInterface $webform_options_custom
   *   A webform options custom entity.
   *
   * @return array
   *   A list of webform that use the specified webform custom options
   */
  public function getUsedByWebforms(WebformOptionsCustomInterface $webform_options_custom);

}

Members

Namesort descending 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
WebformOptionsCustomStorageInterface::getCategories public function Gets the names of all categories. 1
WebformOptionsCustomStorageInterface::getOptionsCustom public function Get all webform options custom grouped by category. 1
WebformOptionsCustomStorageInterface::getUsedByWebforms public function Get list of webform that use the specified webform custom options. 1