-
Notifications
You must be signed in to change notification settings - Fork 6
/
MostViewedPlugin.php
145 lines (126 loc) · 4.32 KB
/
MostViewedPlugin.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
<?php
/**
* @file MostViewedPlugin.php
*
* Copyright (c) 2014-2023 Simon Fraser University
* Copyright (c) 2003-2023 John Willinsky
* Copyright (c) 2020 Ronny Bölter, Leibniz Institute for Psychology (ZPID)
*
* Distributed under the GNU GPL v3. For full terms see the file LICENSE.
*
* @class MostViewedPlugin
*
* @ingroup plugins_generic_mostViewed
*
* @brief Class for plugin and handler registration
*/
namespace APP\plugins\generic\mostViewed;
use APP\core\Application;
use APP\template\TemplateManager;
use PKP\core\JSONMessage;
use PKP\linkAction\LinkAction;
use PKP\linkAction\request\AjaxModal;
use PKP\plugins\GenericPlugin;
use PKP\plugins\Hook;
class MostViewedPlugin extends GenericPlugin
{
/**
* @copydoc Plugin::getDisplayName()
*/
public function getDisplayName(): string
{
return __('plugins.generic.most.viewed.title');
}
/**
* @copydoc Plugin::getDescription()
*/
public function getDescription(): string
{
return __('plugins.generic.most.viewed.desc');
}
/**
* @copydoc Plugin::register()
*
* @param null|mixed $mainContextId
*/
public function register($category, $path, $mainContextId = null): bool
{
if (!parent::register($category, $path)) {
return false;
}
if (Application::isUnderMaintenance() || !$this->getEnabled($mainContextId)) {
return true;
}
Hook::add('AcronPlugin::parseCronTab', [$this, 'callbackParseCronTab']);
Hook::add('Templates::Index::journal', [$this, 'mostViewedContent']);
$request = Application::get()->getRequest();
$templateMgr = TemplateManager::getManager($request);
$templateMgr->addStyleSheet(
'mostViewedArticles',
"{$request->getBaseUrl()}/{$this->getPluginPath()}/css/mostViewed.css"
);
return true;
}
/**
* Append most viewed Content to indexJournal.tpl
*/
public function mostViewedContent(string $hookName, array $args): bool
{
/** @var TemplateManager $smarty */
[, $smarty, &$output] = $args;
$request = Application::get()->getRequest();
$context = $request->getContext();
$contextId = ($context && $context->getId()) ? $context->getId() : Application::CONTEXT_SITE;
$settings = json_decode($this->getSetting($contextId, 'settings'), true);
$smarty->assign([
'mostReadArticles' => json_decode($this->getSetting($contextId, 'articles'), true),
'mostReadHeadline' => $settings['title'] ?? null,
'mostReadPosition' => $settings['position'] ?? null
]);
$output .= $smarty->fetch($this->getTemplateResource('mostViewed.tpl'));
return Hook::CONTINUE;
}
/**
* @copydoc Plugin::getActions()
*/
public function getActions($request, $verb): array
{
$actions = parent::getActions($request, $verb);
if (!$this->getEnabled()) {
return $actions;
}
$router = $request->getRouter();
$url = $router->url($request, null, null, 'manage', null, ['verb' => 'settings', 'plugin' => $this->getName(), 'category' => 'generic']);
array_unshift($actions, new LinkAction('settings', new AjaxModal($url, $this->getDisplayName()), __('manager.plugins.settings')));
return $actions;
}
/**
* @copydoc Plugin::manage()
*/
public function manage($args, $request): JSONMessage
{
if ($request->getUserVar('verb') !== 'settings') {
return parent::manage($args, $request);
}
$form = new MostViewedSettingsForm($this);
if (!$request->getUserVar('save')) {
$form->initData();
return new JSONMessage(true, $form->fetch($request));
}
$form->readInputData();
if ($form->validate()) {
$form->execute();
return new JSONMessage(true);
}
return parent::manage($args, $request);
}
/**
* Acron Plugin Auto Stage: It is needed if server has no configured cron jobs.
*/
public function callbackParseCronTab(string $hookName, array $args): bool
{
$taskFilesPath = & $args[0]; // Reference needed.
$taskFilesPath[] = "{$this->getPluginPath()}/scheduledTasksAutoStage.xml";
return Hook::CONTINUE;
}
}