Mercurial > SimpleWebPresenter

annotate Flag.inc @ 129:16c3ee204330

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Fixes flag.
author Tom Fredrik Blenning <bfg@bfgconsult.no>
date Wed, 28 Dec 2022 11:20:19 +0100
parents 6f5939bf53c3
children
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
fae4322d6c29 Refactored Flag into a separate class.
Tom Fredrik "BFG" Klaussen <bfg@blenning.no>
parents:
diff changeset
7 include_once 'CacheTimeCheck.inc';
fae4322d6c29 Refactored Flag into a separate class.
Tom Fredrik "BFG" Klaussen <bfg@blenning.no>
parents:
diff changeset
8
77
9d766788f0bc Fix remaining documentation errors.
Tom Fredrik Blenning Klaussen <bfg@blenning.no>
parents: 76
diff changeset
9 /// @cond
76
fae4322d6c29 Refactored Flag into a separate class.
Tom Fredrik "BFG" Klaussen <bfg@blenning.no>
parents:
diff changeset
10 $scriptCache = ScriptIncludeCache::instance(__FILE__);
fae4322d6c29 Refactored Flag into a separate class.
Tom Fredrik "BFG" Klaussen <bfg@blenning.no>
parents:
diff changeset
11 $scriptCache->includeOnce('Language.inc');
fae4322d6c29 Refactored Flag into a separate class.
Tom Fredrik "BFG" Klaussen <bfg@blenning.no>
parents:
diff changeset
12 $scriptCache->includeOnce('common-functions.inc');
78
7c68015b211a Common source for all page generators.
Tom Fredrik "BFG" Klaussen <bfg@blenning.no>
parents: 76
diff changeset
13 $scriptCache->includeOnce('Page.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 */
78
7c68015b211a Common source for all page generators.
Tom Fredrik "BFG" Klaussen <bfg@blenning.no>
parents: 76
diff changeset
19 class Flag extends Page
7c68015b211a Common source for all page generators.
Tom Fredrik "BFG" Klaussen <bfg@blenning.no>
parents: 76
diff changeset
20 {
76
fae4322d6c29 Refactored Flag into a separate class.
Tom Fredrik "BFG" Klaussen <bfg@blenning.no>
parents:
diff changeset
21 private $active;
fae4322d6c29 Refactored Flag into a separate class.
Tom Fredrik "BFG" Klaussen <bfg@blenning.no>
parents:
diff changeset
22 private $lang;
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;
108
f2996720e6d6 Embed some flags, support for overriding.
Tom Fredrik "BFG" Klaussen <bfg@blenning.no>
parents: 99
diff changeset
47 foreach ( [ 'img', '../img' ] as $dir) {
f2996720e6d6 Embed some flags, support for overriding.
Tom Fredrik "BFG" Klaussen <bfg@blenning.no>
parents: 99
diff changeset
48 $this->name = "${dir}/flag-${lang}";
f2996720e6d6 Embed some flags, support for overriding.
Tom Fredrik "BFG" Klaussen <bfg@blenning.no>
parents: 99
diff changeset
49 if ($this->active)
f2996720e6d6 Embed some flags, support for overriding.
Tom Fredrik "BFG" Klaussen <bfg@blenning.no>
parents: 99
diff changeset
50 $this->name .= "-active";
f2996720e6d6 Embed some flags, support for overriding.
Tom Fredrik "BFG" Klaussen <bfg@blenning.no>
parents: 99
diff changeset
51 $this->name .= ".png";
f2996720e6d6 Embed some flags, support for overriding.
Tom Fredrik "BFG" Klaussen <bfg@blenning.no>
parents: 99
diff changeset
52 if (file_exists($this->name))
f2996720e6d6 Embed some flags, support for overriding.
Tom Fredrik "BFG" Klaussen <bfg@blenning.no>
parents: 99
diff changeset
53 break;
f2996720e6d6 Embed some flags, support for overriding.
Tom Fredrik "BFG" Klaussen <bfg@blenning.no>
parents: 99
diff changeset
54 }
76
fae4322d6c29 Refactored Flag into a separate class.
Tom Fredrik "BFG" Klaussen <bfg@blenning.no>
parents:
diff changeset
55
78
7c68015b211a Common source for all page generators.
Tom Fredrik "BFG" Klaussen <bfg@blenning.no>
parents: 76
diff changeset
56 $cache = new CacheTimeCheck($this->name);
110
6f5939bf53c3 Set flag cache expiry time to today + 30 days
Tom Fredrik "BFG" Klaussen <bfg@blenning.no>
parents: 108
diff changeset
57 $cache->setMaxAge(30*86400);
78
7c68015b211a Common source for all page generators.
Tom Fredrik "BFG" Klaussen <bfg@blenning.no>
parents: 76
diff changeset
58 $cache->addParent($masterCache);
7c68015b211a Common source for all page generators.
Tom Fredrik "BFG" Klaussen <bfg@blenning.no>
parents: 76
diff changeset
59 $this->setCache($cache);
76
fae4322d6c29 Refactored Flag into a separate class.
Tom Fredrik "BFG" Klaussen <bfg@blenning.no>
parents:
diff changeset
60 }
fae4322d6c29 Refactored Flag into a separate class.
Tom Fredrik "BFG" Klaussen <bfg@blenning.no>
parents:
diff changeset
61
78
7c68015b211a Common source for all page generators.
Tom Fredrik "BFG" Klaussen <bfg@blenning.no>
parents: 76
diff changeset
62 function cacheCheck()
76
fae4322d6c29 Refactored Flag into a separate class.
Tom Fredrik "BFG" Klaussen <bfg@blenning.no>
parents:
diff changeset
63 {
99
d98e315308cd Improved caching of flag and sitemap.
Tom Fredrik "BFG" Klaussen <bfg@blenning.no>
parents: 92
diff changeset
64 return Cacheable::YES;
78
7c68015b211a Common source for all page generators.
Tom Fredrik "BFG" Klaussen <bfg@blenning.no>
parents: 76
diff changeset
65 }
7c68015b211a Common source for all page generators.
Tom Fredrik "BFG" Klaussen <bfg@blenning.no>
parents: 76
diff changeset
66
7c68015b211a Common source for all page generators.
Tom Fredrik "BFG" Klaussen <bfg@blenning.no>
parents: 76
diff changeset
67 function mayCompress()
7c68015b211a Common source for all page generators.
Tom Fredrik "BFG" Klaussen <bfg@blenning.no>
parents: 76
diff changeset
68 {
7c68015b211a Common source for all page generators.
Tom Fredrik "BFG" Klaussen <bfg@blenning.no>
parents: 76
diff changeset
69 return false;
76
fae4322d6c29 Refactored Flag into a separate class.
Tom Fredrik "BFG" Klaussen <bfg@blenning.no>
parents:
diff changeset
70 }
fae4322d6c29 Refactored Flag into a separate class.
Tom Fredrik "BFG" Klaussen <bfg@blenning.no>
parents:
diff changeset
71
91
1d4c980f4255 Change the way headers are set.
Tom Fredrik "BFG" Klaussen <bfg@blenning.no>
parents: 86
diff changeset
72 function mayValidate()
1d4c980f4255 Change the way headers are set.
Tom Fredrik "BFG" Klaussen <bfg@blenning.no>
parents: 86
diff changeset
73 {
1d4c980f4255 Change the way headers are set.
Tom Fredrik "BFG" Klaussen <bfg@blenning.no>
parents: 86
diff changeset
74 return false;
1d4c980f4255 Change the way headers are set.
Tom Fredrik "BFG" Klaussen <bfg@blenning.no>
parents: 86
diff changeset
75 }
1d4c980f4255 Change the way headers are set.
Tom Fredrik "BFG" Klaussen <bfg@blenning.no>
parents: 86
diff changeset
76
77
9d766788f0bc Fix remaining documentation errors.
Tom Fredrik Blenning Klaussen <bfg@blenning.no>
parents: 76
diff changeset
77 /**
79
9b490aa11124 Branch merge.
Tom Fredrik "BFG" Klaussen <bfg@blenning.no>
parents: 78 77
diff changeset
78 * Produce the actual content
77
9d766788f0bc Fix remaining documentation errors.
Tom Fredrik Blenning Klaussen <bfg@blenning.no>
parents: 76
diff changeset
79 */
78
7c68015b211a Common source for all page generators.
Tom Fredrik "BFG" Klaussen <bfg@blenning.no>
parents: 76
diff changeset
80 function generateContent()
76
fae4322d6c29 Refactored Flag into a separate class.
Tom Fredrik "BFG" Klaussen <bfg@blenning.no>
parents:
diff changeset
81 {
fae4322d6c29 Refactored Flag into a separate class.
Tom Fredrik "BFG" Klaussen <bfg@blenning.no>
parents:
diff changeset
82 $flag = loadFile($this->name);
fae4322d6c29 Refactored Flag into a separate class.
Tom Fredrik "BFG" Klaussen <bfg@blenning.no>
parents:
diff changeset
83
fae4322d6c29 Refactored Flag into a separate class.
Tom Fredrik "BFG" Klaussen <bfg@blenning.no>
parents:
diff changeset
84 if (floatval($flag) < 0) {
fae4322d6c29 Refactored Flag into a separate class.
Tom Fredrik "BFG" Klaussen <bfg@blenning.no>
parents:
diff changeset
85 errorPage('Resource not found', 404);
fae4322d6c29 Refactored Flag into a separate class.
Tom Fredrik "BFG" Klaussen <bfg@blenning.no>
parents:
diff changeset
86 }
fae4322d6c29 Refactored Flag into a separate class.
Tom Fredrik "BFG" Klaussen <bfg@blenning.no>
parents:
diff changeset
87 else {
86
b9654b9c4a66 Make headers a part of the content, rather than setting them directly.
Tom Fredrik "BFG" Klaussen <bfg@blenning.no>
parents: 79
diff changeset
88 $flag = new PageContent($flag);
91
1d4c980f4255 Change the way headers are set.
Tom Fredrik "BFG" Klaussen <bfg@blenning.no>
parents: 86
diff changeset
89 $flag->setHeader('Content-Type', 'image/png');
76
fae4322d6c29 Refactored Flag into a separate class.
Tom Fredrik "BFG" Klaussen <bfg@blenning.no>
parents:
diff changeset
90 return $flag;
fae4322d6c29 Refactored Flag into a separate class.
Tom Fredrik "BFG" Klaussen <bfg@blenning.no>
parents:
diff changeset
91 }
fae4322d6c29 Refactored Flag into a separate class.
Tom Fredrik "BFG" Klaussen <bfg@blenning.no>
parents:
diff changeset
92 }
129
16c3ee204330 Fixes flag.
Tom Fredrik Blenning <bfg@bfgconsult.no>
parents: 110
diff changeset
93 }