Created Dotenv::getSites method. Related documentation updates. Updating change log to prepare for version 0.1.7.

Author: dl-unleashed-technologies

CHANGELOG.md

@@ -4,6 +4,19 @@ Updates should follow the [Keep a CHANGELOG](https://keepachangelog.com/) princi
 
 ## [Unreleased][unreleased]
 
+## [0.1.7] - 2021-12-01
+
+### Changed
+
+- Added more documentation concerning Drupal multi-site configuration.
+- Added documentation for `DOMAINS` environment variable.
+- Added documentation for `SITES` environment variable.
+- Added Dotenv::getSites method to return Drupal-compatible list of sites.
+
+### Fixed
+
+- Inaccurate multi-site configuration examples in documentation.
+
 ## [0.1.6] - 2021-12-01
 
 ### Fixed
@@ -45,10 +58,11 @@ Updates should follow the [Keep a CHANGELOG](https://keepachangelog.com/) princi
 
 **Initial release!**
 
-[unreleased]: https://github.com/unleashedtech/dotenv-drupal/compare/0.1.6...main
-[0.1.3]: https://github.com/unleashedtech/dotenv-drupal/compare/0.1.5...0.1.6
-[0.1.3]: https://github.com/unleashedtech/dotenv-drupal/compare/0.1.4...0.1.5
-[0.1.3]: https://github.com/unleashedtech/dotenv-drupal/compare/0.1.3...0.1.4
+[unreleased]: https://github.com/unleashedtech/dotenv-drupal/compare/0.1.7...main
+[0.1.7]: https://github.com/unleashedtech/dotenv-drupal/compare/0.1.6...0.1.7
+[0.1.6]: https://github.com/unleashedtech/dotenv-drupal/compare/0.1.5...0.1.6
+[0.1.5]: https://github.com/unleashedtech/dotenv-drupal/compare/0.1.4...0.1.5
+[0.1.4]: https://github.com/unleashedtech/dotenv-drupal/compare/0.1.3...0.1.4
 [0.1.3]: https://github.com/unleashedtech/dotenv-drupal/compare/0.1.2...0.1.3
 [0.1.2]: https://github.com/unleashedtech/dotenv-drupal/compare/0.1.1...0.1.2
 [0.1.1]: https://github.com/unleashedtech/dotenv-drupal/compare/0.1.0...0.1.1

README.md

@@ -10,7 +10,7 @@ component's documentation about how `.env` files are used.
 ### Configuring Drupal
 First, you'll need to configure Drupal to use this package.
 
-#### Drupal Settings Files
+#### Drupal Settings & Sites Files
 Drupal is typically configured via `settings.php` files in various directories.
 To use this package with Drupal, some code will need to be added to the top of
 the relevant `settings.php` file(s):
@@ -36,8 +36,8 @@ empty to allow automatic database name selection based on the site name.
 <?php
 use UnleashedTech\Drupal\Dotenv\Dotenv;
 $dotenv = new Dotenv();
-$dotenv->setSiteName(__DIR__);
-require __DIR__ . '../default/settings.php';
+$dotenv->setSiteName(basename(__DIR__));
+require __DIR__ . '/../default/settings.php';
 ```
 
 If you'd like, you can manually set the database name for each site via the
@@ -47,15 +47,28 @@ If you'd like, you can manually set the database name for each site via the
 <?php
 use UnleashedTech\Drupal\Dotenv\Dotenv;
 $dotenv = new Dotenv();
-$dotenv->setSiteName(__DIR__);
+$dotenv->setSiteName(basename(__DIR__));
 $dotenv->setDatabaseName('foo');
-require __DIR__ . '../default/settings.php';
+require __DIR__ . '/../default/settings.php';
 ```
 
 If conditional logic is required for a given site, such logic is still supported.
 This package will auto-load various `settings.{{environment}}.php` or
 `config.{{environment}}.php` files, if they exist.
 
+###### Sites Files
+This package also provides functionality to configure Drupal's `$sites` variable
+via `sites.php`. The `$sites` variable is built from data in the [DOMAINS](#domains)
+& [SITES](#sites) environment variables. You will need to add the following code
+to `sites.php`:
+
+```php
+<?php
+use UnleashedTech\Drupal\Dotenv\Dotenv;
+$dotenv = new Dotenv();
+$sites = $dotenv->getSites();
+```
+
 #### Configuring Drupal via ENV Variables
 This package will provide many default setting & configuration values based on the
 detected environment. Some of these values can be populated by environment variables.
@@ -65,6 +78,8 @@ For production environments, environment variables should ideally be defined via
 configuration.
 
 * [DATABASE_URL](#database_url)
+* [DOMAINS](#domains)
+* [SITES](#sites)
 * [SOLR_URL](#solr_url)
 * More configuration options coming soon!
 
@@ -87,6 +102,20 @@ For multi-site installations, do _not_ specify a database name in the ENV file(s
 DATABASE_URL=mysql://foo:bar@host:3306
 ```
 
+##### DOMAINS
+A CSV list of domains used by the given environment:
+
+```dotenv
+DOMAINS=foo.example,bar.example,baz.example
+```
+
+##### SITES
+A CSV list of Drupal "sites" (e.g. "subdomains") used by the given environment:
+
+```dotenv
+SITES=foo,bar,baz,qux
+```
+
 ##### SOLR_URL
 The default Solr connection can be configured via a [DSN](https://en.wikipedia.org/wiki/Data_source_name):
 

src/Dotenv.php

@@ -219,6 +219,23 @@ public function getSettings(): array
         return $settings;
     }
 
+    /**
+     * Gets the Drupal-multi-site $sites array, based on environment variables.
+     *
+     * @return array
+     *   The Drupal-multi-site $sites array, based on environment variables.
+     */
+    public function getSites(): array {
+        $domains = explode(',', $_SERVER['DOMAINS'] ?? 'default.example');
+        $sites = explode(',', $_SERVER['SITES'] ?? 'default');
+        foreach ($sites as $site) {
+            foreach ($domains as $domain) {
+                $sites[$site . '.' . $domain] = $site;
+            }
+        }
+        return $sites;
+    }
+
     /**
      * Gets the absolute path for the given path.
      *