summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJan Dittberner <jandd@cacert.org>2020-12-29 12:44:18 +0100
committerJan Dittberner <jandd@cacert.org>2020-12-29 12:44:18 +0100
commite97c8b5afbd587b851fe174a9de77da6879a9900 (patch)
tree2141f27b0710bab4fb95074d3a95f5a25739bf55
parentddfc693f1611c3e6303dd8068228e4c9905e64a5 (diff)
downloadcacert-codedocs-e97c8b5afbd587b851fe174a9de77da6879a9900.tar.gz
cacert-codedocs-e97c8b5afbd587b851fe174a9de77da6879a9900.tar.xz
cacert-codedocs-e97c8b5afbd587b851fe174a9de77da6879a9900.zip
Add notes to session variables
-rw-r--r--source/conf.py2
-rw-r--r--source/globals.rst9
2 files changed, 8 insertions, 3 deletions
diff --git a/source/conf.py b/source/conf.py
index 4e0e14b..36e5dc3 100644
--- a/source/conf.py
+++ b/source/conf.py
@@ -38,7 +38,7 @@ except requests.exceptions.SSLError as err:
# -- Project information -----------------------------------------------------
project = 'CAcert code documentation'
-copyright = '2018, CAcert development team'
+copyright = '2018-2020 CAcert development team'
author = 'CAcert development team'
# The short X.Y version
diff --git a/source/globals.rst b/source/globals.rst
index 877d01e..ae713f8 100644
--- a/source/globals.rst
+++ b/source/globals.rst
@@ -5,8 +5,8 @@
Global Variables
================
- As the modules this website includes have to communicate together there are some global variables defined as arrays
-
+As the modules this website includes have to communicate together there are some global
+variables defined as arrays.
.. index:: $_REQUEST
@@ -61,6 +61,11 @@ This variable is used in :file:`includes/general.php`
:php:global:`$_SESSION`
========================
+.. note::
+ The web application uses the session to store global variables. It might be a better
+ idea to use real variables or constants. The session is user related and should only
+ store the minimum information to make information available across request boundaries.
+
.. php:global:: $_SESSION['mconn']
This global variable defines the status of the database connection