-
Notifications
You must be signed in to change notification settings - Fork 0
/
AcademicFreeThemePlugin.inc.php
297 lines (247 loc) · 10.8 KB
/
AcademicFreeThemePlugin.inc.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
<?php
/**
* @file plugins/themes/academicFree/AcademicFreeThemePlugin.inc.php
*
* Copyright (c) 2024 openjournaltheme.com
* Distributed under the GNU GPL v3. For full terms see the file README.
* No warranty is provided.
*/
import('lib.pkp.classes.plugins.ThemePlugin');
class AcademicFreeThemePlugin extends ThemePlugin
{
public $pluginDir;
public function __construct()
{
$this->pluginDir = $this->getPluginPath();
}
function register($category, $path, $mainContextId = null)
{
if (!parent::register($category, $path, $mainContextId)) return false;
// Don't perform any futher operations if theme is not currently active
if (!$this->isActive()) {
return true;
}
HookRegistry::register('TemplateManager::display', array($this, 'loadTemplateData'));
HookRegistry::register('TemplateManager::display', [$this, 'addHeaderMeta']);
return true;
}
public function addHeaderMeta($hookName, $args)
{
$templateMgr = &$args[0];
$templateMgr->addHeader(
$this->getName(),
'<meta name="' . $this->getName() . '" content="' . $this->getDisplayName() . ' Version ' . $this->getPluginVersion() . ' by openjournaltheme.com">',
[
'contexts' => ['frontend'],
]
);
}
public function getPluginVersion()
{
import('lib.pkp.classes.site.VersionCheck');
$version = VersionCheck::parseVersionXML($this->getPluginVersionFile());
return $version['release'];
}
public function getPluginVersionFile()
{
return $this->getPluginPath() . '/version.xml';
}
/**
* Initialize the theme
*
* @return null
*/
public function init()
{
// Register option for bootstrap themes
$this->addOption('bootstrapTheme', 'radio', array(
'label' => 'plugins.themes.academic_free.options.academicFree.label',
'description' => 'plugins.themes.academic_free.options.academicFree.description',
'options' => array(
'yeti' => 'plugins.themes.academic_free.options.academicFree.yeti',
),
));
//header option
$this->addOption('headerTheme', 'radio', array(
'label' => 'plugins.themes.academic_free.headerTheme.name',
'description' => 'plugins.themes.academic_free.headerTheme.description',
'options' => array(
'red' => 'plugins.themes.academic_free.headerTheme.red',
'edu' => 'plugins.themes.academic_free.headerTheme.edu',
'dots' => 'plugins.themes.academic_free.headerTheme.dots',
'diamond' => 'plugins.themes.academic_free.headerTheme.diamond',
'blue' => 'plugins.themes.academic_free.headerTheme.blue',
),
));
//logo feature
// Show or hide the statistic
$this->addOption('logoStyleBig', 'FieldOptions', array(
'label' => __('plugins.themes.academic_free.logo_style') . "(Pro Version Only)",
'description' => __('plugins.themes.academic_free.logo_style_description'),
'options' => [
[
'value' => true,
'label' => __('plugins.themes.academic_pro.enable'),
],
],
));
// Add theme options
$this->addOption('baseColour', 'FieldColor', array(
'label' => __('plugins.themes.academic_free.theme_color') . "(Pro Version Only)",
'description' => __('plugins.themes.academic_free.theme_color_desc'),
'default' => '#8a0493',
));
// Show or hide the statistic
$this->addOption('statistics', 'FieldOptions', [
'label' => __('plugins.themes.academic_free.stat_label') . "(Pro Version Only)",
'description' => __('plugins.themes.academic_free.stat.desc'),
'options' => [
[
'value' => true,
'label' => __('plugins.themes.academic_free.enable'),
],
],
'default' => true,
]);
// Show or hide the article tracking date
$this->addOption('article_tracking_date', 'FieldOptions', [
'label' => __('plugins.themes.academic_free.article_tracking_date') . "(Pro Version Only)",
'description' => __('plugins.themes.academic_free.article_tracking_date.desc'),
'options' => [
[
'value' => true,
'label' => __('plugins.themes.academic_free.enable'),
],
],
'default' => true,
]);
// Show or hide the galley link on journal index
$this->addOption('galley_link_on_index', 'FieldOptions', [
'label' => __('plugins.themes.academic_free.galley_link_on_index') . "(Pro Version Only)",
'description' => __('plugins.themes.academic_free.galley_link_on_index_desc'),
'options' => [
[
'value' => true,
'label' => __('plugins.themes.academic_free.enable'),
],
],
'default' => false,
]);
// Show or hide dimension badge
$this->addOption('dimension_badge', 'FieldOptions', [
'label' => __('plugins.themes.academic_free.dimension_badge_label') . "(Pro Version Only)",
'description' => __('plugins.themes.academic_free.dimension_badge_desc'),
'options' => [
[
'value' => true,
'label' => __('plugins.themes.academic_free.enable'),
],
],
'default' => false,
]);
// Show or hide the galley link on journal index
$this->addOption('doi_on_index', 'FieldOptions', [
'label' => __('plugins.themes.academic_free.doi_on_index') . "(Pro Version Only)",
'description' => __('plugins.themes.academic_free.doi_on_index_desc'),
'options' => [
[
'value' => true,
'label' => __('plugins.themes.academic_free.enable'),
],
],
'default' => true,
]);
// Enable crossmark on article page
$this->addOption('crossmark_button', 'FieldOptions', [
'label' => __('plugins.themes.academic_free.crossmark_label') . "(Pro Version Only)",
'description' => __('plugins.themes.academic_free.crossmark_button_desc'),
'options' => [
[
'value' => true,
'label' => __('plugins.themes.academic_free.enable'),
],
],
'default' => false,
]);
$this->addOption('maintenance_mode', 'FieldOptions', [
'label' => __('plugins.themes.academic_free.maintenance_label') . "(Pro Version Only)",
'description' => __('plugins.themes.academic_free.maintenance_desc'),
'options' => [
[
'value' => true,
'label' => __('plugins.themes.academic_free.enable'),
],
],
'default' => false,
]);
// default style is paper
$bootstrapTheme = $this->getOption('bootstrapTheme');
$this->addStyle('bootstrap', 'styles/yeti.less', array('baseUrl' => $this->_getBaseUrl()));
$locale = AppLocale::getLocale();
if (AppLocale::getLocaleDirection($locale) === 'rtl') {
if (Config::getVar('general', 'enable_cdn')) {
$this->addStyle('bootstrap-rtl', '//cdn.rawgit.com/morteza/bootstrap-rtl/v3.3.4/dist/css/bootstrap-rtl.min.css', array('baseUrl' => ''));
} else {
$this->addStyle('bootstrap-rtl', 'styles/bootstrap-rtl.min.css');
}
}
$min = Config::getVar('general', 'enable_minified') ? '.min' : '';
$request = Application::get()->getRequest();
$jquery = $request->getBaseUrl() . '/lib/pkp/lib/vendor/components/jquery/jquery' . $min . '.js';
$jqueryUI = $request->getBaseUrl() . '/lib/pkp/lib/vendor/components/jqueryui/jquery-ui' . $min . '.js';
// Use an empty `baseUrl` argument to prevent the theme from looking for
// the files within the theme directory
$this->addScript('jQuery', $jquery, array('baseUrl' => ''));
$this->addScript('jQueryUI', $jqueryUI, array('baseUrl' => ''));
$this->addScript('jQueryTagIt', $request->getBaseUrl() . '/lib/pkp/js/lib/jquery/plugins/jquery.tag-it.js', array('baseUrl' => ''));
// Load Bootstrap
$this->addScript('bootstrap', 'bootstrap/js/bootstrap.min.js');
// Add navigation menu areas for this theme
$this->addMenuArea(array('primary', 'user'));
$this->addStyle('main', 'styles/academic_free.css');
$this->addStyle('classy', 'styles/responsive.css');
$headerTheme = $this->getOption('headerTheme');
$this->addStyle('headerTheme', 'styles/header/blue.css');
}
/**
* Get the display name of this plugin
* @return string
*/
public function getDisplayName()
{
return 'Academic Free Theme';
}
/**
* Get the description of this plugin
* @return string
*/
public function getDescription()
{
return __('plugins.themes.academic_free.description');
}
private function getVersionNumber()
{
$versionDao = DAORegistry::getDAO('VersionDAO');
$version = $versionDao->getCurrentVersion();
$data = $version->_data;
return $data['major'] . $data['minor'];
}
/**
* Fired when the `TemplateManager::display` hook is called.
*
* @param string $hookname
* @param array $args [$templateMgr, $template, $sendContentType, $charset, $output]
*/
public function loadTemplateData($hookName, $args)
{
// Retrieve the TemplateManager
$templateMgr = $args[0];
$baseUrl = Config::getVar('general', 'base_url');
// Attach a custom piece of data to the TemplateManager
$myCustomData = 'This is my custom data. It could be any PHP variable.';
$templateMgr->assign('journalVersion', $this->getVersionNumber());
$templateMgr->assign('pluginDir', $this->getPluginPath());
$templateMgr->assign('pluginImageDir', $baseUrl . '/' . $this->getPluginPath() . '/images/');
$templateMgr->assign('themeTag', '<small class="pull-right" style="margin-top: 20px"> Academic Free Theme <br> by <a href="https://openjournaltheme.com"> openjournaltheme.com </a> </small>');
}
}