SimpleWebPresenter: Options.inc annotate

annotate Options.inc @ 62:b7efe2ecbc11

Wrapped everything in inputParser in a class.

author	Tom Fredrik "BFG" Klaussen <bfg@blenning.no>
date	Thu, 11 Oct 2012 18:21:59 +0200
parents	c6d0892f81ff
children	74f7b64bdb78

rev	line source
26 d8c7b328899e Removed globals, and introduced Options object for passing values Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: diff changeset	1 <?php
48 c6d0892f81ff Documentation. Tom Fredrik Blenning Klaussen <bfg@blenning.no> parents: 47 diff changeset	2 /**
c6d0892f81ff Documentation. Tom Fredrik Blenning Klaussen <bfg@blenning.no> parents: 47 diff changeset	3 * Contains alle configurable parameters, and "globals"
c6d0892f81ff Documentation. Tom Fredrik Blenning Klaussen <bfg@blenning.no> parents: 47 diff changeset	4 *
c6d0892f81ff Documentation. Tom Fredrik Blenning Klaussen <bfg@blenning.no> parents: 47 diff changeset	5 * @author Tom Fredrik Blenning Klaussen
c6d0892f81ff Documentation. Tom Fredrik Blenning Klaussen <bfg@blenning.no> parents: 47 diff changeset	6 */
26 d8c7b328899e Removed globals, and introduced Options object for passing values Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: diff changeset	7 class Options
d8c7b328899e Removed globals, and introduced Options object for passing values Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: diff changeset	8 {
d8c7b328899e Removed globals, and introduced Options object for passing values Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: diff changeset	9 private $defaultLang;
d8c7b328899e Removed globals, and introduced Options object for passing values Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: diff changeset	10 private $lang;
d8c7b328899e Removed globals, and introduced Options object for passing values Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: diff changeset	11 private $name;
d8c7b328899e Removed globals, and introduced Options object for passing values Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: diff changeset	12 private $acceptedLanguages = array();
29 394b5df43d1a Fix some formatting. Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: 26 diff changeset	13 private $inputDefaults = array();
32 7b19be62ea94 Remove yet another global, replace by CacheTimeCheck class. Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: 29 diff changeset	14 private $cache;
35 aec57ed6f5f6 Remove globals from activeNav function. Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: 33 diff changeset	15 private $urlParams = array();
39 bd82b719a0de Make CacheTimeCheck a singleton. Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: 35 diff changeset	16 private $basePath;
47 66382989353f Extract baseDir only once. Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: 39 diff changeset	17 private $flagUrl;
66382989353f Extract baseDir only once. Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: 39 diff changeset	18 private $baseUrl;
62 b7efe2ecbc11 Wrapped everything in inputParser in a class. Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: 48 diff changeset	19 private $cacheable;
26 d8c7b328899e Removed globals, and introduced Options object for passing values Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: diff changeset	20
48 c6d0892f81ff Documentation. Tom Fredrik Blenning Klaussen <bfg@blenning.no> parents: 47 diff changeset	21 /**
c6d0892f81ff Documentation. Tom Fredrik Blenning Klaussen <bfg@blenning.no> parents: 47 diff changeset	22 * Gets the default language
c6d0892f81ff Documentation. Tom Fredrik Blenning Klaussen <bfg@blenning.no> parents: 47 diff changeset	23 *
c6d0892f81ff Documentation. Tom Fredrik Blenning Klaussen <bfg@blenning.no> parents: 47 diff changeset	24 * @return two letter code for the language
c6d0892f81ff Documentation. Tom Fredrik Blenning Klaussen <bfg@blenning.no> parents: 47 diff changeset	25 */
26 d8c7b328899e Removed globals, and introduced Options object for passing values Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: diff changeset	26 function getDefaultLang()
d8c7b328899e Removed globals, and introduced Options object for passing values Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: diff changeset	27 {
d8c7b328899e Removed globals, and introduced Options object for passing values Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: diff changeset	28 return $this->defaultLang;
d8c7b328899e Removed globals, and introduced Options object for passing values Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: diff changeset	29 }
d8c7b328899e Removed globals, and introduced Options object for passing values Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: diff changeset	30
48 c6d0892f81ff Documentation. Tom Fredrik Blenning Klaussen <bfg@blenning.no> parents: 47 diff changeset	31 /**
c6d0892f81ff Documentation. Tom Fredrik Blenning Klaussen <bfg@blenning.no> parents: 47 diff changeset	32 * Gets the selected language
c6d0892f81ff Documentation. Tom Fredrik Blenning Klaussen <bfg@blenning.no> parents: 47 diff changeset	33 *
c6d0892f81ff Documentation. Tom Fredrik Blenning Klaussen <bfg@blenning.no> parents: 47 diff changeset	34 * @return two letter code for the language
c6d0892f81ff Documentation. Tom Fredrik Blenning Klaussen <bfg@blenning.no> parents: 47 diff changeset	35 */
26 d8c7b328899e Removed globals, and introduced Options object for passing values Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: diff changeset	36 function getLang()
d8c7b328899e Removed globals, and introduced Options object for passing values Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: diff changeset	37 {
d8c7b328899e Removed globals, and introduced Options object for passing values Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: diff changeset	38 return $this->lang;
d8c7b328899e Removed globals, and introduced Options object for passing values Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: diff changeset	39 }
d8c7b328899e Removed globals, and introduced Options object for passing values Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: diff changeset	40
62 b7efe2ecbc11 Wrapped everything in inputParser in a class. Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: 48 diff changeset	41 function setCacheable($cacheable)
b7efe2ecbc11 Wrapped everything in inputParser in a class. Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: 48 diff changeset	42 {
b7efe2ecbc11 Wrapped everything in inputParser in a class. Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: 48 diff changeset	43 $this->cacheable = $cacheable;
b7efe2ecbc11 Wrapped everything in inputParser in a class. Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: 48 diff changeset	44 }
b7efe2ecbc11 Wrapped everything in inputParser in a class. Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: 48 diff changeset	45
b7efe2ecbc11 Wrapped everything in inputParser in a class. Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: 48 diff changeset	46 function getCacheable()
b7efe2ecbc11 Wrapped everything in inputParser in a class. Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: 48 diff changeset	47 {
b7efe2ecbc11 Wrapped everything in inputParser in a class. Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: 48 diff changeset	48 return $this->cacheable;
b7efe2ecbc11 Wrapped everything in inputParser in a class. Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: 48 diff changeset	49 }
b7efe2ecbc11 Wrapped everything in inputParser in a class. Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: 48 diff changeset	50
48 c6d0892f81ff Documentation. Tom Fredrik Blenning Klaussen <bfg@blenning.no> parents: 47 diff changeset	51 /**
c6d0892f81ff Documentation. Tom Fredrik Blenning Klaussen <bfg@blenning.no> parents: 47 diff changeset	52 * Get the base url, or if non set, extracts it from _SERVER
c6d0892f81ff Documentation. Tom Fredrik Blenning Klaussen <bfg@blenning.no> parents: 47 diff changeset	53 *
c6d0892f81ff Documentation. Tom Fredrik Blenning Klaussen <bfg@blenning.no> parents: 47 diff changeset	54 * @return the baseurl for the scripts
c6d0892f81ff Documentation. Tom Fredrik Blenning Klaussen <bfg@blenning.no> parents: 47 diff changeset	55 */
47 66382989353f Extract baseDir only once. Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: 39 diff changeset	56 function getBaseUrl()
66382989353f Extract baseDir only once. Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: 39 diff changeset	57 {
66382989353f Extract baseDir only once. Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: 39 diff changeset	58 if ($this->baseUrl)
66382989353f Extract baseDir only once. Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: 39 diff changeset	59 return $this->baseUrl;
66382989353f Extract baseDir only once. Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: 39 diff changeset	60
66382989353f Extract baseDir only once. Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: 39 diff changeset	61 $request = $_SERVER['REQUEST_URI'];
66382989353f Extract baseDir only once. Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: 39 diff changeset	62 $l = strpos($request, '?');
66382989353f Extract baseDir only once. Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: 39 diff changeset	63 $base = ($l) ? substr($request, 0 , $l) : $request;
66382989353f Extract baseDir only once. Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: 39 diff changeset	64
66382989353f Extract baseDir only once. Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: 39 diff changeset	65 return "http://" . $_SERVER['HTTP_HOST'] . $base;
66382989353f Extract baseDir only once. Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: 39 diff changeset	66 }
66382989353f Extract baseDir only once. Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: 39 diff changeset	67
48 c6d0892f81ff Documentation. Tom Fredrik Blenning Klaussen <bfg@blenning.no> parents: 47 diff changeset	68 /**
c6d0892f81ff Documentation. Tom Fredrik Blenning Klaussen <bfg@blenning.no> parents: 47 diff changeset	69 * Replaces placeholder variables, with actual values.
c6d0892f81ff Documentation. Tom Fredrik Blenning Klaussen <bfg@blenning.no> parents: 47 diff changeset	70 *
c6d0892f81ff Documentation. Tom Fredrik Blenning Klaussen <bfg@blenning.no> parents: 47 diff changeset	71 * Currently supported values:
c6d0892f81ff Documentation. Tom Fredrik Blenning Klaussen <bfg@blenning.no> parents: 47 diff changeset	72 * @li \%HOST\%
c6d0892f81ff Documentation. Tom Fredrik Blenning Klaussen <bfg@blenning.no> parents: 47 diff changeset	73 *
c6d0892f81ff Documentation. Tom Fredrik Blenning Klaussen <bfg@blenning.no> parents: 47 diff changeset	74 * @param $value string to replace values in
c6d0892f81ff Documentation. Tom Fredrik Blenning Klaussen <bfg@blenning.no> parents: 47 diff changeset	75 * @return the processed string
c6d0892f81ff Documentation. Tom Fredrik Blenning Klaussen <bfg@blenning.no> parents: 47 diff changeset	76 */
47 66382989353f Extract baseDir only once. Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: 39 diff changeset	77 function replacePlaceholders($value)
66382989353f Extract baseDir only once. Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: 39 diff changeset	78 {
66382989353f Extract baseDir only once. Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: 39 diff changeset	79 $value = preg_replace('/%HOST%/', $_SERVER['HTTP_HOST'], $value);
66382989353f Extract baseDir only once. Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: 39 diff changeset	80 return $value;
66382989353f Extract baseDir only once. Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: 39 diff changeset	81 }
66382989353f Extract baseDir only once. Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: 39 diff changeset	82
48 c6d0892f81ff Documentation. Tom Fredrik Blenning Klaussen <bfg@blenning.no> parents: 47 diff changeset	83 /**
c6d0892f81ff Documentation. Tom Fredrik Blenning Klaussen <bfg@blenning.no> parents: 47 diff changeset	84 * Sets the base url where scripts are located
c6d0892f81ff Documentation. Tom Fredrik Blenning Klaussen <bfg@blenning.no> parents: 47 diff changeset	85 *
c6d0892f81ff Documentation. Tom Fredrik Blenning Klaussen <bfg@blenning.no> parents: 47 diff changeset	86 * @param $baseUrl the url where scripts are located
c6d0892f81ff Documentation. Tom Fredrik Blenning Klaussen <bfg@blenning.no> parents: 47 diff changeset	87 */
47 66382989353f Extract baseDir only once. Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: 39 diff changeset	88 function setBaseUrl($baseUrl)
66382989353f Extract baseDir only once. Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: 39 diff changeset	89 {
66382989353f Extract baseDir only once. Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: 39 diff changeset	90 $baseUrl = self::replacePlaceholders($baseUrl);
66382989353f Extract baseDir only once. Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: 39 diff changeset	91 $this->baseUrl = $baseUrl;
66382989353f Extract baseDir only once. Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: 39 diff changeset	92 }
66382989353f Extract baseDir only once. Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: 39 diff changeset	93
48 c6d0892f81ff Documentation. Tom Fredrik Blenning Klaussen <bfg@blenning.no> parents: 47 diff changeset	94 /**
c6d0892f81ff Documentation. Tom Fredrik Blenning Klaussen <bfg@blenning.no> parents: 47 diff changeset	95 * Sets the url for the flag script
c6d0892f81ff Documentation. Tom Fredrik Blenning Klaussen <bfg@blenning.no> parents: 47 diff changeset	96 *
c6d0892f81ff Documentation. Tom Fredrik Blenning Klaussen <bfg@blenning.no> parents: 47 diff changeset	97 * @param $flagUrl for flag script
c6d0892f81ff Documentation. Tom Fredrik Blenning Klaussen <bfg@blenning.no> parents: 47 diff changeset	98 */
47 66382989353f Extract baseDir only once. Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: 39 diff changeset	99 function setFlagUrl($flagUrl)
66382989353f Extract baseDir only once. Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: 39 diff changeset	100 {
66382989353f Extract baseDir only once. Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: 39 diff changeset	101 $flagUrl = self::replacePlaceholders($flagUrl);
66382989353f Extract baseDir only once. Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: 39 diff changeset	102 $this->flagUrl = $flagUrl;
66382989353f Extract baseDir only once. Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: 39 diff changeset	103 }
66382989353f Extract baseDir only once. Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: 39 diff changeset	104
48 c6d0892f81ff Documentation. Tom Fredrik Blenning Klaussen <bfg@blenning.no> parents: 47 diff changeset	105 /**
c6d0892f81ff Documentation. Tom Fredrik Blenning Klaussen <bfg@blenning.no> parents: 47 diff changeset	106 * Gets the url for the flag script, or autogenerate if not set
c6d0892f81ff Documentation. Tom Fredrik Blenning Klaussen <bfg@blenning.no> parents: 47 diff changeset	107 *
c6d0892f81ff Documentation. Tom Fredrik Blenning Klaussen <bfg@blenning.no> parents: 47 diff changeset	108 * @return url for flag script
c6d0892f81ff Documentation. Tom Fredrik Blenning Klaussen <bfg@blenning.no> parents: 47 diff changeset	109 */
47 66382989353f Extract baseDir only once. Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: 39 diff changeset	110 function getFlagUrl()
66382989353f Extract baseDir only once. Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: 39 diff changeset	111 {
66382989353f Extract baseDir only once. Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: 39 diff changeset	112 if ($this->flagUrl)
66382989353f Extract baseDir only once. Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: 39 diff changeset	113 return $this->flagUrl;
66382989353f Extract baseDir only once. Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: 39 diff changeset	114
66382989353f Extract baseDir only once. Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: 39 diff changeset	115 return $this->getBaseUrl() . "/flag.php";
66382989353f Extract baseDir only once. Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: 39 diff changeset	116 }
66382989353f Extract baseDir only once. Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: 39 diff changeset	117
48 c6d0892f81ff Documentation. Tom Fredrik Blenning Klaussen <bfg@blenning.no> parents: 47 diff changeset	118 /**
c6d0892f81ff Documentation. Tom Fredrik Blenning Klaussen <bfg@blenning.no> parents: 47 diff changeset	119 * Sets the selected language
c6d0892f81ff Documentation. Tom Fredrik Blenning Klaussen <bfg@blenning.no> parents: 47 diff changeset	120 *
c6d0892f81ff Documentation. Tom Fredrik Blenning Klaussen <bfg@blenning.no> parents: 47 diff changeset	121 * @param $lang two letter code for the language
c6d0892f81ff Documentation. Tom Fredrik Blenning Klaussen <bfg@blenning.no> parents: 47 diff changeset	122 */
26 d8c7b328899e Removed globals, and introduced Options object for passing values Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: diff changeset	123 function setLang($lang)
d8c7b328899e Removed globals, and introduced Options object for passing values Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: diff changeset	124 {
d8c7b328899e Removed globals, and introduced Options object for passing values Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: diff changeset	125 $this->lang = $lang;
d8c7b328899e Removed globals, and introduced Options object for passing values Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: diff changeset	126 }
d8c7b328899e Removed globals, and introduced Options object for passing values Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: diff changeset	127
48 c6d0892f81ff Documentation. Tom Fredrik Blenning Klaussen <bfg@blenning.no> parents: 47 diff changeset	128 /**
c6d0892f81ff Documentation. Tom Fredrik Blenning Klaussen <bfg@blenning.no> parents: 47 diff changeset	129 * Gets the path where the scripts are located
c6d0892f81ff Documentation. Tom Fredrik Blenning Klaussen <bfg@blenning.no> parents: 47 diff changeset	130 *
c6d0892f81ff Documentation. Tom Fredrik Blenning Klaussen <bfg@blenning.no> parents: 47 diff changeset	131 * @return path where scripts are located
c6d0892f81ff Documentation. Tom Fredrik Blenning Klaussen <bfg@blenning.no> parents: 47 diff changeset	132 */
39 bd82b719a0de Make CacheTimeCheck a singleton. Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: 35 diff changeset	133 function getBasePath()
bd82b719a0de Make CacheTimeCheck a singleton. Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: 35 diff changeset	134 {
bd82b719a0de Make CacheTimeCheck a singleton. Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: 35 diff changeset	135 return $this->basePath;
bd82b719a0de Make CacheTimeCheck a singleton. Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: 35 diff changeset	136 }
bd82b719a0de Make CacheTimeCheck a singleton. Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: 35 diff changeset	137
48 c6d0892f81ff Documentation. Tom Fredrik Blenning Klaussen <bfg@blenning.no> parents: 47 diff changeset	138 /**
c6d0892f81ff Documentation. Tom Fredrik Blenning Klaussen <bfg@blenning.no> parents: 47 diff changeset	139 * Sets the path where the scripts are located
c6d0892f81ff Documentation. Tom Fredrik Blenning Klaussen <bfg@blenning.no> parents: 47 diff changeset	140 *
c6d0892f81ff Documentation. Tom Fredrik Blenning Klaussen <bfg@blenning.no> parents: 47 diff changeset	141 * @param $basePath path where scripts are located
c6d0892f81ff Documentation. Tom Fredrik Blenning Klaussen <bfg@blenning.no> parents: 47 diff changeset	142 */
39 bd82b719a0de Make CacheTimeCheck a singleton. Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: 35 diff changeset	143 function setBasePath($basePath)
bd82b719a0de Make CacheTimeCheck a singleton. Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: 35 diff changeset	144 {
bd82b719a0de Make CacheTimeCheck a singleton. Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: 35 diff changeset	145 $this->basePath = $basePath;
bd82b719a0de Make CacheTimeCheck a singleton. Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: 35 diff changeset	146 }
bd82b719a0de Make CacheTimeCheck a singleton. Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: 35 diff changeset	147
48 c6d0892f81ff Documentation. Tom Fredrik Blenning Klaussen <bfg@blenning.no> parents: 47 diff changeset	148 /**
c6d0892f81ff Documentation. Tom Fredrik Blenning Klaussen <bfg@blenning.no> parents: 47 diff changeset	149 * Sets a set of urlparameters
c6d0892f81ff Documentation. Tom Fredrik Blenning Klaussen <bfg@blenning.no> parents: 47 diff changeset	150 *
c6d0892f81ff Documentation. Tom Fredrik Blenning Klaussen <bfg@blenning.no> parents: 47 diff changeset	151 * @param $urlParams list of parameters to get from the URL
c6d0892f81ff Documentation. Tom Fredrik Blenning Klaussen <bfg@blenning.no> parents: 47 diff changeset	152 */
33 511b6514823f Remove more globals. Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: 32 diff changeset	153 function setUrlParams($urlParams)
511b6514823f Remove more globals. Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: 32 diff changeset	154 {
35 aec57ed6f5f6 Remove globals from activeNav function. Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: 33 diff changeset	155 foreach($urlParams as $key) {
39 bd82b719a0de Make CacheTimeCheck a singleton. Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: 35 diff changeset	156 $value = array_key_exists($key, $_GET) ? $_GET[$key] : '';
35 aec57ed6f5f6 Remove globals from activeNav function. Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: 33 diff changeset	157 $this->urlParams[$key] = $value;
aec57ed6f5f6 Remove globals from activeNav function. Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: 33 diff changeset	158 }
33 511b6514823f Remove more globals. Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: 32 diff changeset	159 }
511b6514823f Remove more globals. Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: 32 diff changeset	160
48 c6d0892f81ff Documentation. Tom Fredrik Blenning Klaussen <bfg@blenning.no> parents: 47 diff changeset	161 /**
c6d0892f81ff Documentation. Tom Fredrik Blenning Klaussen <bfg@blenning.no> parents: 47 diff changeset	162 * Gets the default language
c6d0892f81ff Documentation. Tom Fredrik Blenning Klaussen <bfg@blenning.no> parents: 47 diff changeset	163 *
c6d0892f81ff Documentation. Tom Fredrik Blenning Klaussen <bfg@blenning.no> parents: 47 diff changeset	164 * @return associative array of key and value for the url parameters
c6d0892f81ff Documentation. Tom Fredrik Blenning Klaussen <bfg@blenning.no> parents: 47 diff changeset	165 */
33 511b6514823f Remove more globals. Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: 32 diff changeset	166 function getUrlParams()
511b6514823f Remove more globals. Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: 32 diff changeset	167 {
511b6514823f Remove more globals. Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: 32 diff changeset	168 return $this->urlParams;
511b6514823f Remove more globals. Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: 32 diff changeset	169 }
511b6514823f Remove more globals. Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: 32 diff changeset	170
48 c6d0892f81ff Documentation. Tom Fredrik Blenning Klaussen <bfg@blenning.no> parents: 47 diff changeset	171 /**
c6d0892f81ff Documentation. Tom Fredrik Blenning Klaussen <bfg@blenning.no> parents: 47 diff changeset	172 * Sets the name(identity) for this page
c6d0892f81ff Documentation. Tom Fredrik Blenning Klaussen <bfg@blenning.no> parents: 47 diff changeset	173 *
c6d0892f81ff Documentation. Tom Fredrik Blenning Klaussen <bfg@blenning.no> parents: 47 diff changeset	174 * @param $name name(identity)
c6d0892f81ff Documentation. Tom Fredrik Blenning Klaussen <bfg@blenning.no> parents: 47 diff changeset	175 */
26 d8c7b328899e Removed globals, and introduced Options object for passing values Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: diff changeset	176 function setName($name)
d8c7b328899e Removed globals, and introduced Options object for passing values Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: diff changeset	177 {
d8c7b328899e Removed globals, and introduced Options object for passing values Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: diff changeset	178 $this->name = $name;
d8c7b328899e Removed globals, and introduced Options object for passing values Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: diff changeset	179 }
d8c7b328899e Removed globals, and introduced Options object for passing values Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: diff changeset	180
48 c6d0892f81ff Documentation. Tom Fredrik Blenning Klaussen <bfg@blenning.no> parents: 47 diff changeset	181 /**
c6d0892f81ff Documentation. Tom Fredrik Blenning Klaussen <bfg@blenning.no> parents: 47 diff changeset	182 * Gets the name(identity) for this page
c6d0892f81ff Documentation. Tom Fredrik Blenning Klaussen <bfg@blenning.no> parents: 47 diff changeset	183 *
c6d0892f81ff Documentation. Tom Fredrik Blenning Klaussen <bfg@blenning.no> parents: 47 diff changeset	184 * @return name(identity)
c6d0892f81ff Documentation. Tom Fredrik Blenning Klaussen <bfg@blenning.no> parents: 47 diff changeset	185 */
26 d8c7b328899e Removed globals, and introduced Options object for passing values Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: diff changeset	186 function getName()
d8c7b328899e Removed globals, and introduced Options object for passing values Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: diff changeset	187 {
d8c7b328899e Removed globals, and introduced Options object for passing values Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: diff changeset	188 return $this->name;
d8c7b328899e Removed globals, and introduced Options object for passing values Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: diff changeset	189 }
d8c7b328899e Removed globals, and introduced Options object for passing values Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: diff changeset	190
48 c6d0892f81ff Documentation. Tom Fredrik Blenning Klaussen <bfg@blenning.no> parents: 47 diff changeset	191 /**
c6d0892f81ff Documentation. Tom Fredrik Blenning Klaussen <bfg@blenning.no> parents: 47 diff changeset	192 * Sets a cache object
c6d0892f81ff Documentation. Tom Fredrik Blenning Klaussen <bfg@blenning.no> parents: 47 diff changeset	193 *
c6d0892f81ff Documentation. Tom Fredrik Blenning Klaussen <bfg@blenning.no> parents: 47 diff changeset	194 * @param $cache CacheTimeCheck object
c6d0892f81ff Documentation. Tom Fredrik Blenning Klaussen <bfg@blenning.no> parents: 47 diff changeset	195 */
32 7b19be62ea94 Remove yet another global, replace by CacheTimeCheck class. Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: 29 diff changeset	196 function setCache($cache)
7b19be62ea94 Remove yet another global, replace by CacheTimeCheck class. Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: 29 diff changeset	197 {
7b19be62ea94 Remove yet another global, replace by CacheTimeCheck class. Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: 29 diff changeset	198 $this->cache = $cache;
7b19be62ea94 Remove yet another global, replace by CacheTimeCheck class. Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: 29 diff changeset	199 }
7b19be62ea94 Remove yet another global, replace by CacheTimeCheck class. Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: 29 diff changeset	200
48 c6d0892f81ff Documentation. Tom Fredrik Blenning Klaussen <bfg@blenning.no> parents: 47 diff changeset	201 /**
c6d0892f81ff Documentation. Tom Fredrik Blenning Klaussen <bfg@blenning.no> parents: 47 diff changeset	202 * Gets the cache object
c6d0892f81ff Documentation. Tom Fredrik Blenning Klaussen <bfg@blenning.no> parents: 47 diff changeset	203 *
c6d0892f81ff Documentation. Tom Fredrik Blenning Klaussen <bfg@blenning.no> parents: 47 diff changeset	204 * @return cache object
c6d0892f81ff Documentation. Tom Fredrik Blenning Klaussen <bfg@blenning.no> parents: 47 diff changeset	205 */
32 7b19be62ea94 Remove yet another global, replace by CacheTimeCheck class. Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: 29 diff changeset	206 function getCache()
7b19be62ea94 Remove yet another global, replace by CacheTimeCheck class. Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: 29 diff changeset	207 {
7b19be62ea94 Remove yet another global, replace by CacheTimeCheck class. Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: 29 diff changeset	208 return $this->cache;
7b19be62ea94 Remove yet another global, replace by CacheTimeCheck class. Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: 29 diff changeset	209 }
7b19be62ea94 Remove yet another global, replace by CacheTimeCheck class. Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: 29 diff changeset	210
48 c6d0892f81ff Documentation. Tom Fredrik Blenning Klaussen <bfg@blenning.no> parents: 47 diff changeset	211 /**
c6d0892f81ff Documentation. Tom Fredrik Blenning Klaussen <bfg@blenning.no> parents: 47 diff changeset	212 * A list of languages which this configuration supports.
c6d0892f81ff Documentation. Tom Fredrik Blenning Klaussen <bfg@blenning.no> parents: 47 diff changeset	213 *
c6d0892f81ff Documentation. Tom Fredrik Blenning Klaussen <bfg@blenning.no> parents: 47 diff changeset	214 * @return array of two letter language codes
c6d0892f81ff Documentation. Tom Fredrik Blenning Klaussen <bfg@blenning.no> parents: 47 diff changeset	215 */
29 394b5df43d1a Fix some formatting. Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: 26 diff changeset	216 function getAcceptedLanguages()
394b5df43d1a Fix some formatting. Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: 26 diff changeset	217 {
394b5df43d1a Fix some formatting. Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: 26 diff changeset	218 return $this->acceptedLanguages;
394b5df43d1a Fix some formatting. Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: 26 diff changeset	219 }
394b5df43d1a Fix some formatting. Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: 26 diff changeset	220
48 c6d0892f81ff Documentation. Tom Fredrik Blenning Klaussen <bfg@blenning.no> parents: 47 diff changeset	221 /**
c6d0892f81ff Documentation. Tom Fredrik Blenning Klaussen <bfg@blenning.no> parents: 47 diff changeset	222 * Gets the default value associated whith the key
c6d0892f81ff Documentation. Tom Fredrik Blenning Klaussen <bfg@blenning.no> parents: 47 diff changeset	223 *
c6d0892f81ff Documentation. Tom Fredrik Blenning Klaussen <bfg@blenning.no> parents: 47 diff changeset	224 * @param $key as specified in master xml file.
c6d0892f81ff Documentation. Tom Fredrik Blenning Klaussen <bfg@blenning.no> parents: 47 diff changeset	225 * @return associated default
c6d0892f81ff Documentation. Tom Fredrik Blenning Klaussen <bfg@blenning.no> parents: 47 diff changeset	226 */
29 394b5df43d1a Fix some formatting. Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: 26 diff changeset	227 function getInputDefault($key)
394b5df43d1a Fix some formatting. Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: 26 diff changeset	228 {
394b5df43d1a Fix some formatting. Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: 26 diff changeset	229 return $this->inputDefaults[$key];
394b5df43d1a Fix some formatting. Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: 26 diff changeset	230 }
394b5df43d1a Fix some formatting. Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: 26 diff changeset	231
48 c6d0892f81ff Documentation. Tom Fredrik Blenning Klaussen <bfg@blenning.no> parents: 47 diff changeset	232 /**
c6d0892f81ff Documentation. Tom Fredrik Blenning Klaussen <bfg@blenning.no> parents: 47 diff changeset	233 * Constructs an options object
c6d0892f81ff Documentation. Tom Fredrik Blenning Klaussen <bfg@blenning.no> parents: 47 diff changeset	234 *
c6d0892f81ff Documentation. Tom Fredrik Blenning Klaussen <bfg@blenning.no> parents: 47 diff changeset	235 * This contstructor will consume any tag with the type option, and
c6d0892f81ff Documentation. Tom Fredrik Blenning Klaussen <bfg@blenning.no> parents: 47 diff changeset	236 * extract values from any tag with type input
c6d0892f81ff Documentation. Tom Fredrik Blenning Klaussen <bfg@blenning.no> parents: 47 diff changeset	237 *
c6d0892f81ff Documentation. Tom Fredrik Blenning Klaussen <bfg@blenning.no> parents: 47 diff changeset	238 * @include master.xml
c6d0892f81ff Documentation. Tom Fredrik Blenning Klaussen <bfg@blenning.no> parents: 47 diff changeset	239 *
c6d0892f81ff Documentation. Tom Fredrik Blenning Klaussen <bfg@blenning.no> parents: 47 diff changeset	240 * @param $baseDocument An open xml file
c6d0892f81ff Documentation. Tom Fredrik Blenning Klaussen <bfg@blenning.no> parents: 47 diff changeset	241 */
26 d8c7b328899e Removed globals, and introduced Options object for passing values Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: diff changeset	242 function __construct($baseDocument)
d8c7b328899e Removed globals, and introduced Options object for passing values Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: diff changeset	243 {
d8c7b328899e Removed globals, and introduced Options object for passing values Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: diff changeset	244 $params = $baseDocument->getElementsByTagName("param");
47 66382989353f Extract baseDir only once. Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: 39 diff changeset	245 $toRemove = array();
26 d8c7b328899e Removed globals, and introduced Options object for passing values Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: diff changeset	246 foreach ($params as $param) {
d8c7b328899e Removed globals, and introduced Options object for passing values Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: diff changeset	247 if ($param->getAttribute("type") == "option") {
d8c7b328899e Removed globals, and introduced Options object for passing values Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: diff changeset	248 $id = $param->getAttribute("id");
d8c7b328899e Removed globals, and introduced Options object for passing values Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: diff changeset	249 if ($id == "lang") {
d8c7b328899e Removed globals, and introduced Options object for passing values Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: diff changeset	250 $this->defaultLang = $param->getAttribute("default");
d8c7b328899e Removed globals, and introduced Options object for passing values Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: diff changeset	251 $accepts = $param->getElementsByTagName("accept_value");
d8c7b328899e Removed globals, and introduced Options object for passing values Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: diff changeset	252 foreach($accepts as $accept) {
d8c7b328899e Removed globals, and introduced Options object for passing values Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: diff changeset	253 foreach($accept->childNodes as $child) {
d8c7b328899e Removed globals, and introduced Options object for passing values Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: diff changeset	254 array_push($this->acceptedLanguages, $child->nodeValue);
d8c7b328899e Removed globals, and introduced Options object for passing values Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: diff changeset	255 }
d8c7b328899e Removed globals, and introduced Options object for passing values Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: diff changeset	256 }
d8c7b328899e Removed globals, and introduced Options object for passing values Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: diff changeset	257 }
47 66382989353f Extract baseDir only once. Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: 39 diff changeset	258 elseif ($id == "baseUrl") {
66382989353f Extract baseDir only once. Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: 39 diff changeset	259 $value = $param->getAttribute("value");
66382989353f Extract baseDir only once. Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: 39 diff changeset	260 if($value)
66382989353f Extract baseDir only once. Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: 39 diff changeset	261 $this->setBaseUrl($value);
26 d8c7b328899e Removed globals, and introduced Options object for passing values Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: diff changeset	262 }
47 66382989353f Extract baseDir only once. Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: 39 diff changeset	263 elseif ($id == "flagUrl") {
66382989353f Extract baseDir only once. Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: 39 diff changeset	264 $value = $param->getAttribute("value");
66382989353f Extract baseDir only once. Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: 39 diff changeset	265 if($value)
66382989353f Extract baseDir only once. Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: 39 diff changeset	266 $this->setFlagUrl($value);
66382989353f Extract baseDir only once. Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: 39 diff changeset	267 }
66382989353f Extract baseDir only once. Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: 39 diff changeset	268 else {
66382989353f Extract baseDir only once. Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: 39 diff changeset	269 warn("Invalid option: ${id}");
66382989353f Extract baseDir only once. Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: 39 diff changeset	270 }
66382989353f Extract baseDir only once. Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: 39 diff changeset	271 //We need to iterate in the opposite direction when removing,
66382989353f Extract baseDir only once. Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: 39 diff changeset	272 //so best shifting.
66382989353f Extract baseDir only once. Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: 39 diff changeset	273 array_unshift($toRemove, $param);
26 d8c7b328899e Removed globals, and introduced Options object for passing values Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: diff changeset	274 }
29 394b5df43d1a Fix some formatting. Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: 26 diff changeset	275 elseif ($param->getAttribute("type") == "input") {
394b5df43d1a Fix some formatting. Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: 26 diff changeset	276 $id = $param->getAttribute("id");
394b5df43d1a Fix some formatting. Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: 26 diff changeset	277 $default = $param->getAttribute("default");
394b5df43d1a Fix some formatting. Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: 26 diff changeset	278 $this->inputDefaults[$id] = $default;
394b5df43d1a Fix some formatting. Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: 26 diff changeset	279 }
26 d8c7b328899e Removed globals, and introduced Options object for passing values Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: diff changeset	280 }
47 66382989353f Extract baseDir only once. Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: 39 diff changeset	281 foreach($toRemove as $param) {
66382989353f Extract baseDir only once. Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: 39 diff changeset	282 $parent = $param->parentNode;
66382989353f Extract baseDir only once. Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: 39 diff changeset	283 $parent->removeChild($param);
66382989353f Extract baseDir only once. Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: 39 diff changeset	284 }
26 d8c7b328899e Removed globals, and introduced Options object for passing values Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: diff changeset	285 }
d8c7b328899e Removed globals, and introduced Options object for passing values Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: diff changeset	286 }
d8c7b328899e Removed globals, and introduced Options object for passing values Tom Fredrik "BFG" Klaussen <bfg@blenning.no> parents: diff changeset	287 ?>

Mercurial > SimpleWebPresenter

annotate Options.inc @ 62:b7efe2ecbc11