annotate Flag.inc @ 77:9d766788f0bc

Fix remaining documentation errors.
author Tom Fredrik Blenning Klaussen <bfg@blenning.no>
date Fri, 12 Oct 2012 01:59:21 +0200
parents fae4322d6c29
children 9b490aa11124
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
76
fae4322d6c29 Refactored Flag into a separate class.
Tom Fredrik "BFG" Klaussen <bfg@blenning.no>
parents:
diff changeset
1 <?php
fae4322d6c29 Refactored Flag into a separate class.
Tom Fredrik "BFG" Klaussen <bfg@blenning.no>
parents:
diff changeset
2 /**
fae4322d6c29 Refactored Flag into a separate class.
Tom Fredrik "BFG" Klaussen <bfg@blenning.no>
parents:
diff changeset
3 * @file
fae4322d6c29 Refactored Flag into a separate class.
Tom Fredrik "BFG" Klaussen <bfg@blenning.no>
parents:
diff changeset
4 * Displays a flag, in an active or disabled state, depending on parameters
fae4322d6c29 Refactored Flag into a separate class.
Tom Fredrik "BFG" Klaussen <bfg@blenning.no>
parents:
diff changeset
5 */
fae4322d6c29 Refactored Flag into a separate class.
Tom Fredrik "BFG" Klaussen <bfg@blenning.no>
parents:
diff changeset
6 define(DEBUG,0);
fae4322d6c29 Refactored Flag into a separate class.
Tom Fredrik "BFG" Klaussen <bfg@blenning.no>
parents:
diff changeset
7
fae4322d6c29 Refactored Flag into a separate class.
Tom Fredrik "BFG" Klaussen <bfg@blenning.no>
parents:
diff changeset
8 include_once 'CacheTimeCheck.inc';
fae4322d6c29 Refactored Flag into a separate class.
Tom Fredrik "BFG" Klaussen <bfg@blenning.no>
parents:
diff changeset
9
77
9d766788f0bc Fix remaining documentation errors.
Tom Fredrik Blenning Klaussen <bfg@blenning.no>
parents: 76
diff changeset
10 /// @cond
76
fae4322d6c29 Refactored Flag into a separate class.
Tom Fredrik "BFG" Klaussen <bfg@blenning.no>
parents:
diff changeset
11 $scriptCache = ScriptIncludeCache::instance(__FILE__);
fae4322d6c29 Refactored Flag into a separate class.
Tom Fredrik "BFG" Klaussen <bfg@blenning.no>
parents:
diff changeset
12 $scriptCache->includeOnce('Language.inc');
fae4322d6c29 Refactored Flag into a separate class.
Tom Fredrik "BFG" Klaussen <bfg@blenning.no>
parents:
diff changeset
13 $scriptCache->includeOnce('common-functions.inc');
77
9d766788f0bc Fix remaining documentation errors.
Tom Fredrik Blenning Klaussen <bfg@blenning.no>
parents: 76
diff changeset
14 /// @endcond
76
fae4322d6c29 Refactored Flag into a separate class.
Tom Fredrik "BFG" Klaussen <bfg@blenning.no>
parents:
diff changeset
15
77
9d766788f0bc Fix remaining documentation errors.
Tom Fredrik Blenning Klaussen <bfg@blenning.no>
parents: 76
diff changeset
16 /**
9d766788f0bc Fix remaining documentation errors.
Tom Fredrik Blenning Klaussen <bfg@blenning.no>
parents: 76
diff changeset
17 * Functionality for generating a flag based on state options
9d766788f0bc Fix remaining documentation errors.
Tom Fredrik Blenning Klaussen <bfg@blenning.no>
parents: 76
diff changeset
18 */
76
fae4322d6c29 Refactored Flag into a separate class.
Tom Fredrik "BFG" Klaussen <bfg@blenning.no>
parents:
diff changeset
19 class Flag {
fae4322d6c29 Refactored Flag into a separate class.
Tom Fredrik "BFG" Klaussen <bfg@blenning.no>
parents:
diff changeset
20 private $active;
fae4322d6c29 Refactored Flag into a separate class.
Tom Fredrik "BFG" Klaussen <bfg@blenning.no>
parents:
diff changeset
21 private $lang;
fae4322d6c29 Refactored Flag into a separate class.
Tom Fredrik "BFG" Klaussen <bfg@blenning.no>
parents:
diff changeset
22 private $cache;
fae4322d6c29 Refactored Flag into a separate class.
Tom Fredrik "BFG" Klaussen <bfg@blenning.no>
parents:
diff changeset
23
77
9d766788f0bc Fix remaining documentation errors.
Tom Fredrik Blenning Klaussen <bfg@blenning.no>
parents: 76
diff changeset
24 /**
9d766788f0bc Fix remaining documentation errors.
Tom Fredrik Blenning Klaussen <bfg@blenning.no>
parents: 76
diff changeset
25 * Constructs a flag object
9d766788f0bc Fix remaining documentation errors.
Tom Fredrik Blenning Klaussen <bfg@blenning.no>
parents: 76
diff changeset
26 *
9d766788f0bc Fix remaining documentation errors.
Tom Fredrik Blenning Klaussen <bfg@blenning.no>
parents: 76
diff changeset
27 * @param $masterCache link this objects cache to this masterCache
9d766788f0bc Fix remaining documentation errors.
Tom Fredrik Blenning Klaussen <bfg@blenning.no>
parents: 76
diff changeset
28 */
76
fae4322d6c29 Refactored Flag into a separate class.
Tom Fredrik "BFG" Klaussen <bfg@blenning.no>
parents:
diff changeset
29 function __construct($masterCache)
fae4322d6c29 Refactored Flag into a separate class.
Tom Fredrik "BFG" Klaussen <bfg@blenning.no>
parents:
diff changeset
30 {
fae4322d6c29 Refactored Flag into a separate class.
Tom Fredrik "BFG" Klaussen <bfg@blenning.no>
parents:
diff changeset
31 $this->active = $_GET['active'];
fae4322d6c29 Refactored Flag into a separate class.
Tom Fredrik "BFG" Klaussen <bfg@blenning.no>
parents:
diff changeset
32 $lang = $_GET['lang'];
fae4322d6c29 Refactored Flag into a separate class.
Tom Fredrik "BFG" Klaussen <bfg@blenning.no>
parents:
diff changeset
33
fae4322d6c29 Refactored Flag into a separate class.
Tom Fredrik "BFG" Klaussen <bfg@blenning.no>
parents:
diff changeset
34 if(!$lang) {
fae4322d6c29 Refactored Flag into a separate class.
Tom Fredrik "BFG" Klaussen <bfg@blenning.no>
parents:
diff changeset
35 $lang = "no";
fae4322d6c29 Refactored Flag into a separate class.
Tom Fredrik "BFG" Klaussen <bfg@blenning.no>
parents:
diff changeset
36 $langs = Language::accepted();
fae4322d6c29 Refactored Flag into a separate class.
Tom Fredrik "BFG" Klaussen <bfg@blenning.no>
parents:
diff changeset
37 foreach ($langs as $l => $val) {
fae4322d6c29 Refactored Flag into a separate class.
Tom Fredrik "BFG" Klaussen <bfg@blenning.no>
parents:
diff changeset
38 if (file_exists($l)) {
fae4322d6c29 Refactored Flag into a separate class.
Tom Fredrik "BFG" Klaussen <bfg@blenning.no>
parents:
diff changeset
39 $lang = $l;
fae4322d6c29 Refactored Flag into a separate class.
Tom Fredrik "BFG" Klaussen <bfg@blenning.no>
parents:
diff changeset
40 break;
fae4322d6c29 Refactored Flag into a separate class.
Tom Fredrik "BFG" Klaussen <bfg@blenning.no>
parents:
diff changeset
41 }
fae4322d6c29 Refactored Flag into a separate class.
Tom Fredrik "BFG" Klaussen <bfg@blenning.no>
parents:
diff changeset
42 }
fae4322d6c29 Refactored Flag into a separate class.
Tom Fredrik "BFG" Klaussen <bfg@blenning.no>
parents:
diff changeset
43 }
fae4322d6c29 Refactored Flag into a separate class.
Tom Fredrik "BFG" Klaussen <bfg@blenning.no>
parents:
diff changeset
44
fae4322d6c29 Refactored Flag into a separate class.
Tom Fredrik "BFG" Klaussen <bfg@blenning.no>
parents:
diff changeset
45
fae4322d6c29 Refactored Flag into a separate class.
Tom Fredrik "BFG" Klaussen <bfg@blenning.no>
parents:
diff changeset
46 $this->lang = $lang;
fae4322d6c29 Refactored Flag into a separate class.
Tom Fredrik "BFG" Klaussen <bfg@blenning.no>
parents:
diff changeset
47 $this->name = "../img/flag-${lang}";
fae4322d6c29 Refactored Flag into a separate class.
Tom Fredrik "BFG" Klaussen <bfg@blenning.no>
parents:
diff changeset
48 if ($this->active)
fae4322d6c29 Refactored Flag into a separate class.
Tom Fredrik "BFG" Klaussen <bfg@blenning.no>
parents:
diff changeset
49 $this->name .= "-active";
fae4322d6c29 Refactored Flag into a separate class.
Tom Fredrik "BFG" Klaussen <bfg@blenning.no>
parents:
diff changeset
50 $this->name .= ".png";
fae4322d6c29 Refactored Flag into a separate class.
Tom Fredrik "BFG" Klaussen <bfg@blenning.no>
parents:
diff changeset
51
fae4322d6c29 Refactored Flag into a separate class.
Tom Fredrik "BFG" Klaussen <bfg@blenning.no>
parents:
diff changeset
52 $this->cache = new CacheTimeCheck($this->name);
fae4322d6c29 Refactored Flag into a separate class.
Tom Fredrik "BFG" Klaussen <bfg@blenning.no>
parents:
diff changeset
53 $this->cache->addParent($masterCache);
fae4322d6c29 Refactored Flag into a separate class.
Tom Fredrik "BFG" Klaussen <bfg@blenning.no>
parents:
diff changeset
54 $this->cache->cache_time($this->name);
fae4322d6c29 Refactored Flag into a separate class.
Tom Fredrik "BFG" Klaussen <bfg@blenning.no>
parents:
diff changeset
55 }
fae4322d6c29 Refactored Flag into a separate class.
Tom Fredrik "BFG" Klaussen <bfg@blenning.no>
parents:
diff changeset
56
77
9d766788f0bc Fix remaining documentation errors.
Tom Fredrik Blenning Klaussen <bfg@blenning.no>
parents: 76
diff changeset
57 /**
9d766788f0bc Fix remaining documentation errors.
Tom Fredrik Blenning Klaussen <bfg@blenning.no>
parents: 76
diff changeset
58 * Produce an apropriate response, eg cached or the actual content
9d766788f0bc Fix remaining documentation errors.
Tom Fredrik Blenning Klaussen <bfg@blenning.no>
parents: 76
diff changeset
59 */
76
fae4322d6c29 Refactored Flag into a separate class.
Tom Fredrik "BFG" Klaussen <bfg@blenning.no>
parents:
diff changeset
60 function getPage()
fae4322d6c29 Refactored Flag into a separate class.
Tom Fredrik "BFG" Klaussen <bfg@blenning.no>
parents:
diff changeset
61 {
fae4322d6c29 Refactored Flag into a separate class.
Tom Fredrik "BFG" Klaussen <bfg@blenning.no>
parents:
diff changeset
62 $this->cache->CheckHttpModified();
fae4322d6c29 Refactored Flag into a separate class.
Tom Fredrik "BFG" Klaussen <bfg@blenning.no>
parents:
diff changeset
63
fae4322d6c29 Refactored Flag into a separate class.
Tom Fredrik "BFG" Klaussen <bfg@blenning.no>
parents:
diff changeset
64 $flag = loadFile($this->name);
fae4322d6c29 Refactored Flag into a separate class.
Tom Fredrik "BFG" Klaussen <bfg@blenning.no>
parents:
diff changeset
65
fae4322d6c29 Refactored Flag into a separate class.
Tom Fredrik "BFG" Klaussen <bfg@blenning.no>
parents:
diff changeset
66 if (floatval($flag) < 0) {
fae4322d6c29 Refactored Flag into a separate class.
Tom Fredrik "BFG" Klaussen <bfg@blenning.no>
parents:
diff changeset
67 errorPage('Resource not found', 404);
fae4322d6c29 Refactored Flag into a separate class.
Tom Fredrik "BFG" Klaussen <bfg@blenning.no>
parents:
diff changeset
68 }
fae4322d6c29 Refactored Flag into a separate class.
Tom Fredrik "BFG" Klaussen <bfg@blenning.no>
parents:
diff changeset
69 else {
fae4322d6c29 Refactored Flag into a separate class.
Tom Fredrik "BFG" Klaussen <bfg@blenning.no>
parents:
diff changeset
70 header("Content-Type: image/png");
fae4322d6c29 Refactored Flag into a separate class.
Tom Fredrik "BFG" Klaussen <bfg@blenning.no>
parents:
diff changeset
71 return $flag;
fae4322d6c29 Refactored Flag into a separate class.
Tom Fredrik "BFG" Klaussen <bfg@blenning.no>
parents:
diff changeset
72 }
fae4322d6c29 Refactored Flag into a separate class.
Tom Fredrik "BFG" Klaussen <bfg@blenning.no>
parents:
diff changeset
73 }
fae4322d6c29 Refactored Flag into a separate class.
Tom Fredrik "BFG" Klaussen <bfg@blenning.no>
parents:
diff changeset
74 }