From 755ea8ce0691cae3a0c9b5f9675c64cfcf7b3f58 Mon Sep 17 00:00:00 2001
From: Carsten Rose <carsten.rose@math.uzh.ch>
Date: Sun, 17 Jan 2016 17:54:20 +0100
Subject: [PATCH] Store.php: docs enhanced.
---
qfq/store/Store.php | 28 ++++++++++++++++++++++++++++
1 file changed, 28 insertions(+)
diff --git a/qfq/store/Store.php b/qfq/store/Store.php
index 1f136babb..b78686e8e 100644
--- a/qfq/store/Store.php
+++ b/qfq/store/Store.php
@@ -29,12 +29,40 @@ require_once(__DIR__ . '/../../qfq/Database.php');
class Store {
+ /**
+ * @var Store Instance of class Store. There should only be one class 'Store' at a time.
+ */
private static $instance = null;
+ /**
+ * @var Sip Instance of class SIP
+ */
private static $sip = null;
+ /**
+ * @var array Stores all indiviudal stores with the variable raw values
+ *
+ * $raw['D']['id'] = 0 - Defaultvalues from Tabledefinition
+ * ...
+ * $raw['S']['r'] = 1234 - record ID from current SIP identifier
+ * ...
+ * $raw['C']['HTTP_SERVER'] = 'qfq' - Servername
+ * $raw['C']['s'] = 'badcaffee1234' - recent SIP
+ */
private static $raw = array();
+
+ /**
+ * @var array Default sanatize classes.
+ */
private static $sanatizeClass = array();
+
+ /**
+ * $sanatizeClass['S'] = false
+ * $sanatizeClass['C'] = true
+ * ...
+ *
+ * @var array each entry with true/false - depending if store needs to be sanatized.
+ */
private static $sanatizeStore = array();
/**
--
GitLab