www.aleph1.co.uk Git - yaffs-website/blob - vendor/drush/drush/docs/site-alias-manager.md

   1 Site Alias Manager
   2 ==================
   3
   4 The [Site Alias Manager (SAM)](https://github.com/consolidation/site-alias/blob/master/src/SiteAliasManager.php) service is used to retrieve information about one or all of the site aliases for the current installation.
   5
   6 - An informative example is the [browse command](https://github.com/drush-ops/drush/blob/master/src/Commands/core/BrowseCommands.php)
   7 - A commandfile gets access to the SAM by implementing the SiteAliasManagerAwareInterface and *use*ing the SiteAliasManagerAwareTrait trait. Then you gain access via `$this->siteAliasManager()`.
   8 - If an alias was used for the current request, it is available via $this->siteAliasManager()->getself().
   9 - The SAM generally deals in [AliasRecord](https://github.com/consolidation/site-alias/blob/master/src/AliasRecord.php) objects. That is how any given site alias is represented. See its methods for determining things like whether the alias points to a local host or remote host.
  10 - [An example site alias file](https://raw.githubusercontent.com/drush-ops/drush/master/examples/example.site.yml).
  11 - [Dynamically alter site aliases](https://raw.githubusercontent.com/drush-ops/drush/master/examples/Commands/SiteAliasAlterCommands.php).
  12 - The SAM is also available for as [a standalone Composer project](https://github.com/consolidation/site-alias). More information available in the README there.