summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorKarl-Heinz Gödderz (GuKKDevel) <Devel@GuKK-Online.de>2018-11-30 10:33:03 +0100
committerKarl-Heinz Gödderz (GuKKDevel) <Devel@GuKK-Online.de>2018-11-30 10:33:03 +0100
commitc22dc42e942503ef777520c0dec6493f9ede5d80 (patch)
treececb267431458168f11cb0fbed4478b074db2d5c
parentfd372b18d9d022b4000ae1100dbc95322817b4d1 (diff)
downloadcacert-codedocs-c22dc42e942503ef777520c0dec6493f9ede5d80.tar.gz
cacert-codedocs-c22dc42e942503ef777520c0dec6493f9ede5d80.tar.xz
cacert-codedocs-c22dc42e942503ef777520c0dec6493f9ede5d80.zip
added global variables into doctree
-rw-r--r--source/globals.rst79
-rw-r--r--source/index.rst1
2 files changed, 60 insertions, 20 deletions
diff --git a/source/globals.rst b/source/globals.rst
index 2a36aff..49f4d8c 100644
--- a/source/globals.rst
+++ b/source/globals.rst
@@ -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']
diff --git a/source/index.rst b/source/index.rst
index 8ecf58f..1d87e9d 100644
--- a/source/index.rst
+++ b/source/index.rst
@@ -21,6 +21,7 @@ contribution. The canonical repository is the :cacertgit:`cacert-devel` though.
:caption: Contents:
general
+ globals
directories
database
signer