X-Git-Url: http://www.aleph1.co.uk/gitweb/?a=blobdiff_plain;ds=sidebyside;f=vendor%2Fdrush%2Fdrush%2Fdocs%2Fsite-alias-manager.md;fp=vendor%2Fdrush%2Fdrush%2Fdocs%2Fsite-alias-manager.md;h=e90711ad9e1d447b07f464ee2d9cd24f00aa028c;hb=af6d1fb995500ae68849458ee10d66abbdcfb252;hp=0000000000000000000000000000000000000000;hpb=680c79a86e3ed402f263faeac92e89fb6d9edcc0;p=yaffs-website

diff --git a/vendor/drush/drush/docs/site-alias-manager.md b/vendor/drush/drush/docs/site-alias-manager.md
new file mode 100644
index 000000000..e90711ad9
--- /dev/null
+++ b/vendor/drush/drush/docs/site-alias-manager.md
@@ -0,0 +1,11 @@
+Site Alias Manager
+==================
+
+The [Site Alias Manager (SAM)](https://github.com/drush-ops/drush/blob/master/src/SiteAlias/SiteAliasManager.php) service is used to retrieve information about one or all of the site aliases for the current installation.
+
+- An informative example is the [browse command](https://github.com/drush-ops/drush/blob/master/src/Commands/core/BrowseCommands.php)
+- A commandfile gets access to the SAM by implementing the SiteAliasManagerAwareInterface and *use*ing the SiteAliasManagerAwareTrait trait. Then you gain access via `$this->siteAliasManager()`.
+- If an alias was used for the current request, it is available via $this->siteAliasManager()->getself().
+- The SAM generally deals in [AliasRecord](https://github.com/drush-ops/drush/blob/master/src/SiteAlias/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.
+- [An example site alias file](https://raw.githubusercontent.com/drush-ops/drush/master/examples/example.site.yml).
+- [Dynamically alter site aliases](https://raw.githubusercontent.com/drush-ops/drush/master/examples/Commands/SiteAliasAlterCommands.php).