added global variables into doctree
[cacert-codedocs.git] / source / globals.rst
index 2a36aff..49f4d8c 100644 (file)
@@ -1,35 +1,74 @@
-.. this file should contain all definitions of global variables
+.. index:: scripts
+.. index:: PHP
 
-    .. php:global:: $_SESSION['mconn']
+================
+Global Variables
+================
 
-    This global variable defines the status of the database connection
+    As the modules this website includes have to communicate together there are some global variables defined as arrays
 
-    * TRUE if a connection could be established
-    * FALSE otherwise
 
-    .. php:global:: $_SESSION['_config']['normalhostname']
+.. index:: $_REQUEST
 
-    This global variable defines the main CAcert-website
+:php:global:`$_REQUEST`
+=======================
 
-    * "www.cacert.org" for production
-    * "test.cacert.org" for testing
+.. php:global:: $_REQUEST["lang"]
 
-    .. php:global:: $_SESSION['_config']['securehostname']
 
-    This global variable defines the secure CAcert-website
+.. index:: $_SERVER
 
-    * "secure.cacert.org" for production
-    * "       cacert.org" for testing
+:php:global:`$_SERVER`
+======================
 
-    .. php:global:: $_SESSION['_config']['tverify']
+.. php:global:: $_SERVER['HTTP_ACCEPT_LANGUAGE']
 
-    This global variable defines TVERIFY 
 
-    * "tverify.cacert.org" for production
-    * "                  " for testing
+.. index:: $_SESSION
 
-    .. todo:: checkout what TVERIFY means, check names for test-system
+:php:global:`$_SESSION`
+========================
+
+.. php:global:: $_SESSION['mconn']
+
+This global variable defines the status of the database connection
+
+* TRUE if a connection could be established
+* FALSE otherwise
+
+.. index:: $_SESSION['_config']
+
+----------------------------------
+:php:global:`$_SESSION['_config']`
+----------------------------------
+
+.. php:global:: $_SESSION['_config']['normalhostname']
+
+This global variable defines the main CAcert-website
+
+* "www.cacert.org" for production
+* "test.cacert.org" for testing
+
+.. php:global:: $_SESSION['_config']['securehostname']
+
+This global variable defines the secure CAcert-website
+
+* "secure.cacert.org" for production
+* "       cacert.org" for testing
+
+.. php:global:: $_SESSION['_config']['tverify']
+
+This global variable defines TVERIFY 
+
+* "tverify.cacert.org" for production
+* "                  " for testing
+
+.. todo:: checkout what TVERIFY means, check names for test-system
+
+.. php:global:: $_SESSION['_config']['language'] 
+
+.. php:global:: $_SESSION['_config']['recode']
+
+.. php:global:: $_SESSION['_config']['filepath']
 
-    .. php:global:: $_SESSION['_config']['language'] 
 
-    .. php:global:: $_SESSION['_config']['recode']