annotate core/globals.api.php @ 19:fa3358dc1485 tip

Add ndrum files
author Chris Cannam
date Wed, 28 Aug 2019 13:14:47 +0100
parents 4c8ae668cc8c
children
rev   line source
Chris@0 1 <?php
Chris@0 2
Chris@0 3 /**
Chris@0 4 * @file
Chris@0 5 * These are the global variables that Drupal uses.
Chris@0 6 */
Chris@0 7
Chris@0 8 /**
Chris@0 9 * The insecure base URL of the Drupal installation.
Chris@0 10 *
Chris@0 11 * @see \Drupal\Core\DrupalKernel::initializeRequestGlobals()
Chris@0 12 */
Chris@0 13 global $base_insecure_url;
Chris@0 14
Chris@0 15 /**
Chris@0 16 * The base path of the Drupal installation.
Chris@0 17 *
Chris@0 18 * This will at least default to '/'.
Chris@0 19 *
Chris@0 20 * @see \Drupal\Core\DrupalKernel::initializeRequestGlobals()
Chris@0 21 */
Chris@0 22 global $base_path;
Chris@0 23
Chris@0 24 /**
Chris@0 25 * The root URL of the host, excluding the path.
Chris@0 26 *
Chris@0 27 * @see \Drupal\Core\DrupalKernel::initializeRequestGlobals()
Chris@0 28 */
Chris@0 29 global $base_root;
Chris@0 30
Chris@0 31 /**
Chris@0 32 * The secure base URL of the Drupal installation.
Chris@0 33 *
Chris@0 34 * @see \Drupal\Core\DrupalKernel::initializeRequestGlobals()
Chris@0 35 */
Chris@0 36 global $base_secure_url;
Chris@0 37
Chris@0 38 /**
Chris@0 39 * The base URL of the Drupal installation.
Chris@0 40 *
Chris@0 41 * @see \Drupal\Core\DrupalKernel::initializeRequestGlobals()
Chris@0 42 */
Chris@0 43 global $base_url;
Chris@0 44
Chris@0 45 /**
Chris@0 46 * Allows defining of site-specific service providers for the Drupal kernel.
Chris@0 47 *
Chris@0 48 * To define a site-specific service provider class, use code like this:
Chris@0 49 * @code
Chris@0 50 * $GLOBALS['conf']['container_service_providers']['MyClassName'] = 'Drupal\My\Namespace\MyClassName';
Chris@0 51 * @endcode
Chris@0 52 *
Chris@0 53 * @see \Drupal\Core\DrupalKernel::$serviceProviderClasses
Chris@0 54 */
Chris@0 55 global $conf;
Chris@0 56
Chris@0 57 /**
Chris@0 58 * Array of configuration overrides from the settings.php file.
Chris@0 59 */
Chris@0 60 global $config;
Chris@0 61
Chris@0 62 /**
Chris@0 63 * The location of file system directories used for site configuration data.
Chris@0 64 *
Chris@0 65 * @see drupal_install_config_directories()
Chris@0 66 */
Chris@0 67 global $config_directories;
Chris@0 68
Chris@0 69 /**
Chris@0 70 * Store settings and profile information during installation process.
Chris@0 71 *
Chris@0 72 * @see install_drupal()
Chris@0 73 */
Chris@0 74 global $install_state;
Chris@0 75
Chris@0 76 /**
Chris@0 77 * Array of the number of items per page for each pager.
Chris@0 78 *
Chris@0 79 * The array index is the pager element index (0 by default).
Chris@0 80 *
Chris@0 81 * @see pager_default_initialize()
Chris@0 82 */
Chris@0 83 global $pager_limits;
Chris@0 84
Chris@0 85 /**
Chris@0 86 * Array of current page numbers for each pager.
Chris@0 87 *
Chris@0 88 * The array index is the pager element index (0 by default).
Chris@0 89 *
Chris@0 90 * @see pager_default_initialize()
Chris@0 91 */
Chris@0 92 global $pager_page_array;
Chris@0 93
Chris@0 94 /**
Chris@0 95 * Array of the total number of pages for each pager.
Chris@0 96 *
Chris@0 97 * The array index is the pager element index (0 by default).
Chris@0 98 *
Chris@0 99 * @see pager_default_initialize()
Chris@0 100 */
Chris@0 101 global $pager_total;
Chris@0 102
Chris@0 103 /**
Chris@0 104 * Array of the total number of items for each pager.
Chris@0 105 *
Chris@0 106 * The array index is the pager element index (0 by default).
Chris@0 107 *
Chris@0 108 * @see pager_default_initialize()
Chris@0 109 */
Chris@0 110 global $pager_total_items;