www.aleph1.co.uk Git - yaffs-website/blob - web/sites/example.sites.php

   1 <?php
   2
   3 // @codingStandardsIgnoreFile
   4
   5 /**
   6  * @file
   7  * Configuration file for multi-site support and directory aliasing feature.
   8  *
   9  * This file is required for multi-site support and also allows you to define a
  10  * set of aliases that map hostnames, ports, and pathnames to configuration
  11  * directories in the sites directory. These aliases are loaded prior to
  12  * scanning for directories, and they are exempt from the normal discovery
  13  * rules. See default.settings.php to view how Drupal discovers the
  14  * configuration directory when no alias is found.
  15  *
  16  * Aliases are useful on development servers, where the domain name may not be
  17  * the same as the domain of the live server. Since Drupal stores file paths in
  18  * the database (files, system table, etc.) this will ensure the paths are
  19  * correct when the site is deployed to a live server.
  20  *
  21  * To activate this feature, copy and rename it such that its path plus
  22  * filename is 'sites/sites.php'.
  23  *
  24  * Aliases are defined in an associative array named $sites. The array is
  25  * written in the format: '<port>.<domain>.<path>' => 'directory'. As an
  26  * example, to map https://www.drupal.org:8080/mysite/test to the configuration
  27  * directory sites/example.com, the array should be defined as:
  28  * @code
  29  * $sites = [
  30  *   '8080.www.drupal.org.mysite.test' => 'example.com',
  31  * ];
  32  * @endcode
  33  * The URL, https://www.drupal.org:8080/mysite/test/, could be a symbolic link
  34  * or an Apache Alias directive that points to the Drupal root containing
  35  * index.php. An alias could also be created for a subdomain. See the
  36  * @link https://www.drupal.org/documentation/install online Drupal installation guide @endlink
  37  * for more information on setting up domains, subdomains, and subdirectories.
  38  *
  39  * The following examples look for a site configuration in sites/example.com:
  40  * @code
  41  * URL: http://dev.drupal.org
  42  * $sites['dev.drupal.org'] = 'example.com';
  43  *
  44  * URL: http://localhost/example
  45  * $sites['localhost.example'] = 'example.com';
  46  *
  47  * URL: http://localhost:8080/example
  48  * $sites['8080.localhost.example'] = 'example.com';
  49  *
  50  * URL: https://www.drupal.org:8080/mysite/test/
  51  * $sites['8080.www.drupal.org.mysite.test'] = 'example.com';
  52  * @endcode
  53  *
  54  * @see default.settings.php
  55  * @see \Drupal\Core\DrupalKernel::getSitePath()
  56  * @see https://www.drupal.org/documentation/install/multi-site
  57  */