www.aleph1.co.uk Git - yaffs-website/blob - vendor/drush/drush/src/SiteAlias/SiteAliasName.php

   1 <?php
   2 namespace Drush\SiteAlias;
   3
   4 /**
   5  * Parse a string that contains a site alias name, and provide convenience
   6  * methods to access the parts.
   7  *
   8  * When provided by users, aliases must be in one of the following forms:
   9  *
  10  *   - @sitename.env: List only sitename and environment.
  11  *
  12  *   - @env: Look up a named environment in instances where the site root
  13  *       is known (e.g. via cwd). In this form, there is an implicit sitename
  14  *       'self' which is replaced by the actual site alias name once known.
  15  *
  16  *   - @sitename: Provides only the sitename; uses the 'default' environment,
  17  *       or 'dev' if there is no 'default' (or whatever is there if there is
  18  *       only one). With this form, the site alias name has no environment
  19  *       until the appropriate default environment is looked up. This form
  20  *       is checked only after `@env` returns no matches.
  21  *
  22  * There are also two special aliases that are recognized:
  23  *
  24  *   - @self: The current bootstrapped site.
  25  *
  26  *   - @none: No alias ('root' and 'uri' unset).
  27  *
  28  * The special alias forms have no environment component.
  29  *
  30  * When provided to an API, the '@' is optional.
  31  *
  32  * Note that @sitename and @env are ambiguous. Aliases in this form
  33  * (that are not one of the special aliases) will first be assumed
  34  * to be @env, and may be converted to @sitename later.
  35  *
  36  * Note that:
  37  *
  38  * - 'sitename' and 'env' MUST NOT contain a '.' (unlike previous
  39  *     versions of Drush).
  40  * - Users SHOULD NOT create any environments that have the same name
  41  *     as any site name (and visa-versa).
  42  * - All environments in one site record SHOULD be different versions
  43  *     of the same site (e.g. dev / test / live).
  44  */
  45 class SiteAliasName extends \Consolidation\SiteAlias\SiteAliasName
  46 {
  47 }