Commit d88d83cd authored by webchick's avatar webchick

Issue #1071846 by gbrands: Fixed conf_path() doc needs cleanup.

parent e1a3c1da
......@@ -223,31 +223,30 @@ function timer_stop($name) {
}
/**
* Find the appropriate configuration directory.
* Finds the appropriate configuration directory.
*
* Try finding a matching configuration directory by stripping the website's
* Finds a matching configuration directory by stripping the website's
* hostname from left to right and pathname from right to left. The first
* configuration file found will be used; the remaining will ignored. If no
* configuration file is found, return a default value '$confdir/default'.
* configuration file found will be used and the remaining ones will be ignored.
* If no configuration file is found, return a default value '$confdir/default'.
*
* Example for a fictitious site installed at
* http://www.drupal.org:8080/mysite/test/ the 'settings.php' is searched in
* the following directories:
* With a site located at http://www.example.com:8080/mysite/test/, the file,
* settings.php, is searched for in the following directories:
*
* 1. $confdir/8080.www.drupal.org.mysite.test
* 2. $confdir/www.drupal.org.mysite.test
* 3. $confdir/drupal.org.mysite.test
* 4. $confdir/org.mysite.test
* 1. $confdir/8080.www.example.com.mysite.test
* 2. $confdir/www.example.com.mysite.test
* 3. $confdir/example.com.mysite.test
* 4. $confdir/com.mysite.test
*
* 5. $confdir/8080.www.drupal.org.mysite
* 6. $confdir/www.drupal.org.mysite
* 7. $confdir/drupal.org.mysite
* 8. $confdir/org.mysite
* 5. $confdir/8080.www.example.com.mysite
* 6. $confdir/www.example.com.mysite
* 7. $confdir/example.com.mysite
* 8. $confdir/com.mysite
*
* 9. $confdir/8080.www.drupal.org
* 10. $confdir/www.drupal.org
* 11. $confdir/drupal.org
* 12. $confdir/org
* 9. $confdir/8080.www.example.com
* 10. $confdir/www.example.com
* 11. $confdir/example.com
* 12. $confdir/com
*
* 13. $confdir/default
*
......@@ -255,18 +254,18 @@ function timer_stop($name) {
* prior to scanning for directories. It should define an associative array
* named $sites, which maps domains to directories. It should be in the form
* of:
*
* @code
* $sites = array(
* 'The url to alias' => 'A directory within the sites directory'
* );
*
* @endcode
* For example:
*
* @code
* $sites = array(
* 'devexample.com' => 'example.com',
* 'localhost.example' => 'example.com',
* );
*
* @endcode
* The above array will cause Drupal to look for a directory named
* "example.com" in the sites directory whenever a request comes from
* "example.com", "devexample.com", or "localhost/example". That is useful
......@@ -275,14 +274,15 @@ function timer_stop($name) {
* (files, system table, etc.) this will ensure the paths are correct while
* accessed on development servers.
*
* @param $require_settings
* @param bool $require_settings
* Only configuration directories with an existing settings.php file
* will be recognized. Defaults to TRUE. During initial installation,
* this is set to FALSE so that Drupal can detect a matching directory,
* then create a new settings.php file in it.
* @param reset
* @param bool $reset
* Force a full search for matching directories even if one had been
* found previously.
* found previously. Defaults to FALSE.
*
* @return
* The path of the matching directory.
*/
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment