EditorButton.php
3.44 KB
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
<?php
/**
* @package Regular Labs Library
* @version 18.2.10140
*
* @author Peter van Westen <info@regularlabs.com>
* @link http://www.regularlabs.com
* @copyright Copyright © 2018 Regular Labs All Rights Reserved
* @license http://www.gnu.org/licenses/gpl-2.0.html GNU/GPL
*/
namespace RegularLabs\Library;
defined('_JEXEC') or die;
use JFactory;
use JPlugin;
use ReflectionClass;
/**
* Class EditorButton
* @package RegularLabs\Library
*/
class EditorButton
extends JPlugin
{
private $_init = false;
private $_helper = null;
var $main_type = 'plugin'; // The type of extension that holds the parameters
var $check_installed = null; // The types of extensions that need to be checked (will default to main_type)
var $require_core_auth = true; // Whether or not the core content create/edit permissions are required
var $folder = null; // The path to the original caller file
var $enable_on_acymailing = false; // Whether or not to enable the editor button on AcyMailing
/**
* Display the button
*
* @param string $editor_name
*
* @return JObject|null A button object
*/
function onDisplay($editor_name)
{
if ( ! $this->getHelper())
{
return null;
}
return $this->_helper->render($editor_name, $this->_subject);
}
/*
* Below methods are general functions used in most of the Regular Labs extensions
* The reason these are not placed in the Regular Labs Library files is that they also
* need to be used when the Regular Labs Library is not installed
*/
/**
* Create the helper object
*
* @return object|null The plugins helper object
*/
private function getHelper()
{
// Already initialized, so return
if ($this->_init)
{
return $this->_helper;
}
$this->_init = true;
if ( ! Extension::isFrameworkEnabled())
{
return null;
}
if ( ! Extension::isAuthorised($this->require_core_auth))
{
return null;
}
if ( ! $this->isInstalled())
{
return null;
}
if ( ! $this->enable_on_acymailing && JFactory::getApplication()->input->get('option') == 'com_acymailing')
{
return null;
}
$params = $this->getParams();
if ( ! Extension::isEnabledInComponent($params))
{
return null;
}
if ( ! Extension::isEnabledInArea($params))
{
return null;
}
if ( ! $this->extraChecks($params))
{
return null;
}
require_once $this->getDir() . '/helper.php';
$class_name = 'PlgButton' . ucfirst($this->_name) . 'Helper';
$this->_helper = new $class_name($this->_name, $params);
return $this->_helper;
}
public function extraChecks($params)
{
return true;
}
private function getDir()
{
$rc = new ReflectionClass(get_class($this));
return dirname($rc->getFileName());
}
private function getParams()
{
switch ($this->main_type)
{
case 'component':
if ( ! Protect::isComponentInstalled($this->_name))
{
return null;
}
// Load component parameters
return Parameters::getInstance()->getComponentParams($this->_name);
case 'plugin':
default:
if ( ! Protect::isSystemPluginInstalled($this->_name))
{
return null;
}
// Load plugin parameters
return Parameters::getInstance()->getPluginParams($this->_name);
}
}
private function isInstalled()
{
$extensions = ! is_null($this->check_installed)
? $this->check_installed
: [$this->main_type];
return Extension::areInstalled($this->_name, $extensions);
}
}