articleStatisticsDisplay/ArticleStatisticsDisplaySettingsForm.inc.php at main · ojs-services/articleStatisticsDisplay · GitHub

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
<?php
/**
 * @file plugins/generic/articleStatisticsDisplay/ArticleStatisticsDisplaySettingsForm.inc.php
 *
 * Copyright (c) 2026 Kerim Sarıgül
 * Distributed under the GNU GPL v3.
 *
 * @class ArticleStatisticsDisplaySettingsForm
 * @brief Form for journal managers to modify Article Statistics Display plugin settings
 */

import('lib.pkp.classes.form.Form');

class ArticleStatisticsDisplaySettingsForm extends Form {

    /** @var ArticleStatisticsDisplayPlugin */
    private $_plugin;

    /** @var int */
    private $_contextId;

    /**
     * Constructor
     * @param $plugin ArticleStatisticsDisplayPlugin
     */
    public function __construct($plugin) {
        parent::__construct($plugin->getTemplateResource('settingsForm.tpl'));
        $this->_plugin = $plugin;
        $this->_contextId = Application::get()->getRequest()->getContext()->getId();

        $this->addCheck(new FormValidatorPost($this));
        $this->addCheck(new FormValidatorCSRF($this));
    }

    /**
     * Initialize form data
     */
    public function initData() {
        $plugin = $this->_plugin;
        $contextId = $this->_contextId;

        $this->setData('showInArticleDetail', $plugin->getSetting($contextId, 'showInArticleDetail'));
        $this->setData('showInIssueToc', $plugin->getSetting($contextId, 'showInIssueToc'));
        $this->setData('showInHomepage', $plugin->getSetting($contextId, 'showInHomepage'));
        $this->setData('showAbstractViews', $plugin->getSetting($contextId, 'showAbstractViews'));
        $this->setData('showGalleyDownloads', $plugin->getSetting($contextId, 'showGalleyDownloads'));
        $this->setData('displayStyle', $plugin->getSetting($contextId, 'displayStyle') ?: 'badge');
        $this->setData('articleDetailPosition', $plugin->getSetting($contextId, 'articleDetailPosition') ?: 'underTitle');
    }

    /**
     * Assign form data to user-submitted data
     */
    public function readInputData() {
        $this->readUserVars(array(
            'showInArticleDetail',
            'showInIssueToc',
            'showInHomepage',
            'showAbstractViews',
            'showGalleyDownloads',
            'displayStyle',
            'articleDetailPosition'
        ));
    }

    /**
     * Fetch the form
     * @param $request PKPRequest
     * @param $template string|null
     * @param $display bool
     * @return string
     */
    public function fetch($request, $template = null, $display = false) {
        $templateMgr = TemplateManager::getManager($request);
        $templateMgr->assign('pluginName', $this->_plugin->getName());

        // Only badge and inline styles
        $displayStyles = array(
            'badge' => __('plugins.generic.articleStatisticsDisplay.style.badge'),
            'inline' => __('plugins.generic.articleStatisticsDisplay.style.inline')
        );
        $templateMgr->assign('displayStyles', $displayStyles);

        // Three position options
        $articlePositions = array(
            'underTitle' => __('plugins.generic.articleStatisticsDisplay.position.underTitle'),
            'underAbstract' => __('plugins.generic.articleStatisticsDisplay.position.underAbstract'),
            'sidebar' => __('plugins.generic.articleStatisticsDisplay.position.sidebar')
        );
        $templateMgr->assign('articlePositions', $articlePositions);

        return parent::fetch($request, $template, $display);
    }

    /**
     * @copydoc Form::execute()
     */
    public function execute(...$functionArgs) {
        $plugin = $this->_plugin;
        $contextId = $this->_contextId;

        $plugin->updateSetting($contextId, 'showInArticleDetail', $this->getData('showInArticleDetail') ? true : false);
        $plugin->updateSetting($contextId, 'showInIssueToc', $this->getData('showInIssueToc') ? true : false);
        $plugin->updateSetting($contextId, 'showInHomepage', $this->getData('showInHomepage') ? true : false);
        $plugin->updateSetting($contextId, 'showAbstractViews', $this->getData('showAbstractViews') ? true : false);
        $plugin->updateSetting($contextId, 'showGalleyDownloads', $this->getData('showGalleyDownloads') ? true : false);
        $plugin->updateSetting($contextId, 'displayStyle', $this->getData('displayStyle'));
        $plugin->updateSetting($contextId, 'articleDetailPosition', $this->getData('articleDetailPosition'));

        parent::execute(...$functionArgs);
    }
}