interface DomainAliasStorageInterface in Domain Access 8

Supplies storage methods for common domain_alias requests.

Hierarchy

• interface \Drupal\Core\Entity\EntityStorageInterface
  • interface \Drupal\Core\Config\Entity\ConfigEntityStorageInterface
    • interface \Drupal\domain_alias\DomainAliasStorageInterface

File

domain_alias/src/DomainAliasStorageInterface.php, line 11

Namespace

Drupal\domain_alias

interface DomainAliasStorageInterface extends ConfigEntityStorageInterface {

  /**
   * Loads a domain alias record by hostname lookup.
   *
   * This method will return the best match to a request.
   *
   * @param string $hostname
   *   A hostname string, in the format example.com.
   *
   * @return \Drupal\domain_alias\DomainAliasInterface|null
   *   The best match alias record for the provided hostname.
   */
  public function loadByHostname($hostname);

  /**
   * Loads a domain alias record by pattern lookup.
   *
   * @param string $pattern
   *   A pattern string, in the format *.example.com.
   *
   * @return \Drupal\domain_alias\DomainAliasInterface|null
   *   The domain alias record given a pattern string.
   */
  public function loadByPattern($pattern);

  /**
   * Loads an array of domain alias record by environment lookup.
   *
   * @param string $environment
   *   An environment string, e.g. 'default' or 'local'.
   *
   * @return array
   *   An array of \Drupal\domain_alias\DomainAliasInterface objects.
   */
  public function loadByEnvironment($environment);

  /**
   * Loads a domain alias record by pattern lookup.
   *
   * @param \Drupal\domain\DomainInterface $domain
   *   A domain entity.
   * @param string $environment
   *   An environment string, e.g. 'default' or 'local'.
   *
   * @return array
   *   An array of \Drupal\domain_alias\DomainAliasInterface objects.
   */
  public function loadByEnvironmentMatch(DomainInterface $domain, $environment);

  /**
   * Sorts aliases by wildcard to float exact matches to the top.
   *
   * For use by loadByHostname().
   */
  public function sort($a, $b);

  /**
   * Gets the schema for domain alias records.
   *
   * @return array
   *   An array representing the field schema of the object.
   */
  public function loadSchema();

}

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
DomainAliasStorageInterface::loadByEnvironment	public	function	Loads an array of domain alias record by environment lookup.	1
DomainAliasStorageInterface::loadByEnvironmentMatch	public	function	Loads a domain alias record by pattern lookup.	1
DomainAliasStorageInterface::loadByHostname	public	function	Loads a domain alias record by hostname lookup.	1
DomainAliasStorageInterface::loadByPattern	public	function	Loads a domain alias record by pattern lookup.	1
DomainAliasStorageInterface::loadSchema	public	function	Gets the schema for domain alias records.	1
DomainAliasStorageInterface::sort	public	function	Sorts aliases by wildcard to float exact matches to the top.	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, static entity cache.	1
EntityStorageInterface::restore	public	function	Restores a previously saved entity.	1
EntityStorageInterface::save	public	function	Saves the entity permanently.	1