class DomainAliasStorage in Domain Access 8

Alias loader utility class.

Hierarchy

class \Drupal\Core\Entity\EntityHandlerBase uses DependencySerializationTrait, StringTranslationTrait
- class \Drupal\Core\Entity\EntityStorageBase implements EntityHandlerInterface, EntityStorageInterface
  - class \Drupal\Core\Config\Entity\ConfigEntityStorage implements ConfigEntityStorageInterface, ImportableEntityStorageInterface
    class \Drupal\domain_alias\DomainAliasStorage implements DomainAliasStorageInterface

Expanded class hierarchy of DomainAliasStorage

File

domain_alias/src/DomainAliasStorage.php, line 15

Namespace

Drupal\domain_alias

View source

class DomainAliasStorage extends ConfigEntityStorage implements DomainAliasStorageInterface {

  /**
   * The typed config handler.
   *
   * @var \Drupal\Core\Config\TypedConfigManagerInterface
   */
  protected $typedConfig;

  /**
   * The request stack object.
   *
   * @var \Symfony\Component\HttpFoundation\RequestStack
   */
  protected $requestStack;

  /**
   * Sets the TypedConfigManager dependency.
   *
   * @param \Drupal\Core\Config\TypedConfigManagerInterface $typed_config
   *   The typed config handler.
   */
  protected function setTypedConfigManager(TypedConfigManagerInterface $typed_config) {
    $this->typedConfig = $typed_config;
  }

  /**
   * Sets the request stack object dependency.
   *
   * @param \Symfony\Component\HttpFoundation\RequestStack $requestStack
   *   The request stack object.
   */
  protected function setRequestStack(RequestStack $request_stack) {
    $this->requestStack = $request_stack;
  }

  /**
   * {@inheritdoc}
   */
  public static function createInstance(ContainerInterface $container, EntityTypeInterface $entity_type) {
    $instance = parent::createInstance($container, $entity_type);
    $instance
      ->setTypedConfigManager($container
      ->get('config.typed'));
    $instance
      ->setRequestStack($container
      ->get('request_stack'));
    return $instance;
  }

  /**
   * {@inheritdoc}
   */
  public function loadSchema() {
    $fields = $this->typedConfig
      ->getDefinition('domain_alias.alias.*');
    return isset($fields['mapping']) ? $fields['mapping'] : [];
  }

  /**
   * {@inheritdoc}
   */
  public function loadByHostname($hostname) {
    $patterns = $this
      ->getPatterns($hostname);
    foreach ($patterns as $pattern) {
      if ($alias = $this
        ->loadByPattern($pattern)) {
        return $alias;
      }
    }
    return NULL;
  }

  /**
   * {@inheritdoc}
   */
  public function loadByPattern($pattern) {
    $result = $this
      ->loadByProperties([
      'pattern' => $pattern,
    ]);
    if (empty($result)) {
      return NULL;
    }
    return current($result);
  }

  /**
   * {@inheritdoc}
   */
  public function loadByEnvironment($environment) {
    $result = $this
      ->loadByProperties([
      'environment' => $environment,
    ]);
    if (empty($result)) {
      return NULL;
    }
    return $result;
  }

  /**
   * {@inheritdoc}
   */
  public function loadByEnvironmentMatch(DomainInterface $domain, $environment) {
    $result = $this
      ->loadByProperties([
      'domain_id' => $domain
        ->id(),
      'environment' => $environment,
    ]);
    if (empty($result)) {
      return [];
    }
    return $result;
  }

  /**
   * {@inheritdoc}
   */
  public function sort($a, $b) {

    // Fewer wildcards is a closer match.
    // A longer string indicates a closer match.
    if (substr_count($a, '*') > substr_count($b, '*') || strlen($a) < strlen($b)) {
      return 1;
    }
    return 0;
  }

  /**
   * Returns an array of eligible matching patterns.
   *
   * @param string $hostname
   *   A hostname string, in the format example.com.
   *
   * @return array
   *   An array of eligible matching patterns.
   */
  public function getPatterns($hostname) {
    $parts = explode('.', $hostname);
    $count = count($parts);

    // Account for ports.
    $port = NULL;
    if (substr_count($hostname, ':') > 0) {

      // Extract port and save for later.
      $ports = explode(':', $parts[$count - 1]);
      $parts[$count - 1] = preg_replace('/:(\\d+)/', '', $parts[$count - 1]);
      $port = $ports[1];
    }

    // Build the list of possible matching patterns.
    $patterns = $this
      ->buildPatterns($parts);

    // Pattern lists are sorted based on the fewest wildcards. That gives us
    // more precise matches first.
    uasort($patterns, [
      $this,
      'sort',
    ]);

    // Re-assemble parts without port
    array_unshift($patterns, implode('.', $parts));

    // Account for ports.
    $patterns = $this
      ->buildPortPatterns($patterns, $hostname, $port);

    // Return unique patters.
    return array_unique($patterns);
  }

  /**
   * Builds a list of matching patterns.
   *
   * @param array $parts
   *   The hostname of the request, as an array split by dots.
   *
   * @return array
   *   An array of eligible matching patterns.
   */
  private function buildPatterns(array $parts) {
    $count = count($parts);
    for ($i = 0; $i < $count; $i++) {

      // Basic replacement of each value.
      $temp = $parts;
      $temp[$i] = '*';
      $patterns[] = implode('.', $temp);

      // Advanced multi-value wildcards.
      // Pattern *.*.
      if (count($temp) > 2 && $i < $count - 1) {
        $temp[$i + 1] = '*';
        $patterns[] = implode('.', $temp);
      }

      // Pattern foo.bar.*.
      if ($count > 3 && $i < $count - 2) {
        $temp[$i + 2] = '*';
        $patterns[] = implode('.', $temp);
      }

      // Pattern *.foo.*.
      if ($count > 3 && $i < 2) {
        $temp = $parts;
        $temp[$i] = '*';
        $temp[$i + 2] = '*';
        $patterns[] = implode('.', $temp);
      }

      // Pattern *.foo.*.*.
      if ($count > 2) {
        $temp = array_fill(0, $count, '*');
        $temp[$i] = $parts[$i];
        $patterns[] = implode('.', $temp);
      }
    }
    return $patterns;
  }

  /**
   * Builds a list of matching patterns, including ports.
   *
   * @param array $patterns
   *   An array of eligible matching patterns.
   * @param string $hostname
   *   A hostname string, in the format example.com.
   * @param integer $port
   *   The port of the request.
   *
   * @return array
   *   An array of eligible matching patterns, modified by port.
   */
  private function buildPortPatterns(array $patterns, $hostname, $port = NULL) {

    // Fetch the port if empty.
    if (empty($port) && !empty($this->requestStack
      ->getCurrentRequest())) {
      $port = $this->requestStack
        ->getCurrentRequest()
        ->getPort();
    }
    $new_patterns = [];
    foreach ($patterns as $index => $pattern) {

      // If default ports, allow exact no-port alias
      $new_patterns[] = $pattern . ':*';
      if (empty($port) || $port == 80 || $port == 443) {
        $new_patterns[] = $pattern;
      }
      if (!empty($port)) {
        $new_patterns[] = $pattern . ':' . $port;
      }
    }
    return $new_patterns;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ConfigEntityStorage::$configFactory	protected	property	The config factory service.
ConfigEntityStorage::$configStorage	protected	property	The config storage service.
ConfigEntityStorage::$entities	protected	property	Static cache of entities, keyed first by entity ID, then by an extra key.
ConfigEntityStorage::$languageManager	protected	property	The language manager.
ConfigEntityStorage::$overrideFree	protected	property	Determines if the underlying configuration is retrieved override free.
ConfigEntityStorage::$uuidKey	protected	property	Name of entity's UUID database table field, if it supports UUIDs. Overrides EntityStorageBase::$uuidKey
ConfigEntityStorage::buildCacheId	protected	function	Builds the cache ID for the passed in entity ID. Overrides EntityStorageBase::buildCacheId
ConfigEntityStorage::createFromStorageRecord	public	function	Creates a configuration entity from storage values. Overrides ConfigEntityStorageInterface::createFromStorageRecord
ConfigEntityStorage::deleteRevision	public	function	Delete a specific entity revision. Overrides EntityStorageInterface::deleteRevision
ConfigEntityStorage::doCreate	protected	function	Performs storage-specific creation of entities. Overrides EntityStorageBase::doCreate
ConfigEntityStorage::doDelete	protected	function	Performs storage-specific entity deletion. Overrides EntityStorageBase::doDelete
ConfigEntityStorage::doLoadMultiple	protected	function	Performs storage-specific loading of entities. Overrides EntityStorageBase::doLoadMultiple
ConfigEntityStorage::doSave	protected	function	Performs storage-specific saving of the entity. Overrides EntityStorageBase::doSave
ConfigEntityStorage::getIDFromConfigName	public static	function	Extracts the configuration entity ID from the full configuration name. Overrides ConfigEntityStorageInterface::getIDFromConfigName
ConfigEntityStorage::getPrefix	protected	function	Returns the prefix used to create the configuration name.
ConfigEntityStorage::getQueryServiceName	protected	function	Gets the name of the service for the query for this entity storage. Overrides EntityStorageBase::getQueryServiceName
ConfigEntityStorage::has	protected	function	Determines if this entity already exists in storage. Overrides EntityStorageBase::has
ConfigEntityStorage::hasData	public	function	Determines if the storage contains any data. Overrides EntityStorageBase::hasData
ConfigEntityStorage::importCreate	public	function	Creates entities upon synchronizing configuration changes. Overrides ImportableEntityStorageInterface::importCreate	1
ConfigEntityStorage::importDelete	public	function	Delete entities upon synchronizing configuration changes. Overrides ImportableEntityStorageInterface::importDelete	2
ConfigEntityStorage::importRename	public	function	Renames entities upon synchronizing configuration changes. Overrides ImportableEntityStorageInterface::importRename
ConfigEntityStorage::importUpdate	public	function	Updates entities upon synchronizing configuration changes. Overrides ImportableEntityStorageInterface::importUpdate	1
ConfigEntityStorage::invokeHook	protected	function	Invokes a hook on behalf of the entity. Overrides EntityStorageBase::invokeHook
ConfigEntityStorage::loadMultipleOverrideFree	public	function	Loads one or more entities in their original form without overrides. Overrides ConfigEntityStorageInterface::loadMultipleOverrideFree
ConfigEntityStorage::loadOverrideFree	public	function	Loads one entity in their original form without overrides. Overrides ConfigEntityStorageInterface::loadOverrideFree
ConfigEntityStorage::loadRevision	public	function	Load a specific entity revision. Overrides EntityStorageInterface::loadRevision
ConfigEntityStorage::mapToStorageRecord	protected	function	Maps from an entity object to the storage record.	3
ConfigEntityStorage::MAX_ID_LENGTH		constant	Length limit of the configuration entity ID.	1
ConfigEntityStorage::save	public	function	Implements Drupal\Core\Entity\EntityStorageInterface::save(). Overrides EntityStorageBase::save
ConfigEntityStorage::updateFromStorageRecord	public	function	Updates a configuration entity from storage values. Overrides ConfigEntityStorageInterface::updateFromStorageRecord
ConfigEntityStorage::_doCreateFromStorageRecord	protected	function	Helps create a configuration entity from storage values.
ConfigEntityStorage::__construct	public	function	Constructs a ConfigEntityStorage object. Overrides EntityStorageBase::__construct	4
DependencySerializationTrait::$_entityStorages	protected	property	An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function		1
DependencySerializationTrait::__wakeup	public	function		2
DomainAliasStorage::$requestStack	protected	property	The request stack object.
DomainAliasStorage::$typedConfig	protected	property	The typed config handler.
DomainAliasStorage::buildPatterns	private	function	Builds a list of matching patterns.
DomainAliasStorage::buildPortPatterns	private	function	Builds a list of matching patterns, including ports.
DomainAliasStorage::createInstance	public static	function	Instantiates a new instance of this entity handler. Overrides ConfigEntityStorage::createInstance
DomainAliasStorage::getPatterns	public	function	Returns an array of eligible matching patterns.
DomainAliasStorage::loadByEnvironment	public	function	Loads an array of domain alias record by environment lookup. Overrides DomainAliasStorageInterface::loadByEnvironment
DomainAliasStorage::loadByEnvironmentMatch	public	function	Loads a domain alias record by pattern lookup. Overrides DomainAliasStorageInterface::loadByEnvironmentMatch
DomainAliasStorage::loadByHostname	public	function	Loads a domain alias record by hostname lookup. Overrides DomainAliasStorageInterface::loadByHostname
DomainAliasStorage::loadByPattern	public	function	Loads a domain alias record by pattern lookup. Overrides DomainAliasStorageInterface::loadByPattern
DomainAliasStorage::loadSchema	public	function	Gets the schema for domain alias records. Overrides DomainAliasStorageInterface::loadSchema
DomainAliasStorage::setRequestStack	protected	function	Sets the request stack object dependency.
DomainAliasStorage::setTypedConfigManager	protected	function	Sets the TypedConfigManager dependency.
DomainAliasStorage::sort	public	function	Sorts aliases by wildcard to float exact matches to the top. Overrides DomainAliasStorageInterface::sort
EntityHandlerBase::$moduleHandler	protected	property	The module handler to invoke hooks on.	2
EntityHandlerBase::moduleHandler	protected	function	Gets the module handler.	2
EntityHandlerBase::setModuleHandler	public	function	Sets the module handler for this handler.
EntityStorageBase::$entityClass	protected	property	Name of the entity class.
EntityStorageBase::$entityType	protected	property	Information about the entity type.
EntityStorageBase::$entityTypeId	protected	property	Entity type ID for this storage.
EntityStorageBase::$idKey	protected	property	Name of the entity's ID field in the entity database table.
EntityStorageBase::$langcodeKey	protected	property	The name of the entity langcode property.	1
EntityStorageBase::$memoryCache	protected	property	The memory cache.
EntityStorageBase::$memoryCacheTag	protected	property	The memory cache cache tag.
EntityStorageBase::$uuidService	protected	property	The UUID service.	1
EntityStorageBase::buildPropertyQuery	protected	function	Builds an entity query.	1
EntityStorageBase::create	public	function	Constructs a new entity object, without permanently saving it. Overrides EntityStorageInterface::create	1
EntityStorageBase::delete	public	function	Deletes permanently saved entities. Overrides EntityStorageInterface::delete	2
EntityStorageBase::doPostSave	protected	function	Performs post save entity processing.	1
EntityStorageBase::doPreSave	protected	function	Performs presave entity processing.	1
EntityStorageBase::getAggregateQuery	public	function	Gets an aggregated query instance. Overrides EntityStorageInterface::getAggregateQuery
EntityStorageBase::getEntityType	public	function	Gets the entity type definition. Overrides EntityStorageInterface::getEntityType
EntityStorageBase::getEntityTypeId	public	function	Gets the entity type ID. Overrides EntityStorageInterface::getEntityTypeId
EntityStorageBase::getFromStaticCache	protected	function	Gets entities from the static cache.
EntityStorageBase::getQuery	public	function	Gets an entity query instance. Overrides EntityStorageInterface::getQuery
EntityStorageBase::load	public	function	Loads one entity. Overrides EntityStorageInterface::load	2
EntityStorageBase::loadByProperties	public	function	Load entities by their property values. Overrides EntityStorageInterface::loadByProperties	3
EntityStorageBase::loadMultiple	public	function	Loads one or more entities. Overrides EntityStorageInterface::loadMultiple	1
EntityStorageBase::loadUnchanged	public	function	Loads an unchanged entity from the database. Overrides EntityStorageInterface::loadUnchanged	1
EntityStorageBase::mapFromStorageRecords	protected	function	Maps from storage records to entity objects.	4
EntityStorageBase::postLoad	protected	function	Attaches data to entities upon loading.
EntityStorageBase::preLoad	protected	function	Gathers entities from a 'preload' step.	1
EntityStorageBase::resetCache	public	function	Resets the internal, static entity cache. Overrides EntityStorageInterface::resetCache	2
EntityStorageBase::restore	public	function	Restores a previously saved entity. Overrides EntityStorageInterface::restore	1
EntityStorageBase::setStaticCache	protected	function	Stores entities in the static entity cache.
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.
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	1
StringTranslationTrait::formatPlural	protected	function	Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals	protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation	protected	function	Gets the string translation service.
StringTranslationTrait::setStringTranslation	public	function	Sets the string translation service to use.	2
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.

You are here

class DomainAliasStorage in Domain Access 8

Hierarchy

File

Namespace

Members

API Navigation