These results are based on our legacy PHP analysis, consider migrating to our new PHP analysis engine instead. Learn more
1 | <?php |
||
0 ignored issues
–
show
|
|||
2 | /* |
||
3 | You may not change or alter any portion of this comment or credits |
||
4 | of supporting developers from this source code or any supporting source code |
||
5 | which is considered copyrighted (c) material of the original comment or credit authors. |
||
6 | |||
7 | This program is distributed in the hope that it will be useful, |
||
8 | but WITHOUT ANY WARRANTY; without even the implied warranty of |
||
9 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
||
10 | */ |
||
11 | /** |
||
12 | * contact module for xoops |
||
13 | * |
||
14 | * @copyright The XOOPS Project http://sourceforge.net/projects/xoops/ |
||
15 | * @license GPL 2.0 or later |
||
16 | * @package contact |
||
17 | * @since 1.0 |
||
18 | * @min_xoops 2.5.7 |
||
19 | * @author Goffy (xoops.wedega.com) - Email:<[email protected]> - Website:<http://xoops.wedega.com> |
||
20 | */ |
||
21 | defined('XOOPS_ROOT_PATH') || exit('Restricted access'); |
||
22 | |||
23 | /** |
||
24 | * Class ContactHelper |
||
25 | */ |
||
26 | class ContactHelper |
||
0 ignored issues
–
show
PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions.
You can fix this by adding a namespace to your class: namespace YourVendor;
class YourClass { }
When choosing a vendor namespace, try to pick something that is not too generic to avoid conflicts with other libraries.
Loading history...
|
|||
27 | { |
||
28 | /** |
||
29 | * @var string |
||
30 | */ |
||
31 | private $dirname; |
||
32 | /** |
||
33 | * @var string |
||
34 | */ |
||
35 | private $module; |
||
36 | /** |
||
37 | * @var string |
||
38 | */ |
||
39 | private $handler; |
||
40 | /** |
||
41 | * @var string |
||
42 | */ |
||
43 | private $config; |
||
44 | /** |
||
45 | * @var string |
||
46 | */ |
||
47 | private $debug; |
||
48 | /** |
||
49 | * @var array |
||
50 | */ |
||
51 | private $debugArray = array(); |
||
0 ignored issues
–
show
|
|||
52 | /* |
||
53 | * @protected function constructor class |
||
54 | * @param mixed $debug |
||
55 | */ |
||
56 | /** |
||
57 | * ContactHelper constructor. |
||
58 | * @param $debug |
||
59 | */ |
||
60 | protected function __construct($debug) |
||
61 | { |
||
62 | $this->debug = $debug; |
||
63 | $this->dirname = basename(dirname(__DIR__)); |
||
64 | } |
||
65 | /* |
||
66 | * @static function &getInstance |
||
67 | * @param mixed $debug |
||
68 | */ |
||
69 | /** |
||
70 | * @param bool $debug |
||
71 | * @return bool|ContactHelper |
||
72 | */ |
||
73 | public static function &getInstance($debug = false) |
||
74 | { |
||
75 | static $instance = false; |
||
76 | if (!$instance) { |
||
77 | $instance = new self($debug); |
||
78 | } |
||
79 | return $instance; |
||
80 | } |
||
81 | /* |
||
82 | * @static function getModule |
||
83 | * @param null |
||
84 | */ |
||
85 | /** |
||
86 | * @return string |
||
87 | */ |
||
88 | public function &getModule() |
||
89 | { |
||
90 | if ($this->module === null) { |
||
91 | $this->initModule(); |
||
92 | } |
||
93 | return $this->module; |
||
94 | } |
||
95 | /* |
||
96 | * @static function getConfig |
||
97 | * @param string $name |
||
98 | */ |
||
99 | /** |
||
100 | * @param null $name |
||
101 | * @return null|string |
||
102 | */ |
||
103 | public function getConfig($name = null) |
||
104 | { |
||
105 | if ($this->config === null) { |
||
106 | $this->initConfig(); |
||
107 | } |
||
108 | if (!$name) { |
||
109 | $this->addLog('Getting all config'); |
||
110 | return $this->config; |
||
111 | } |
||
112 | if (!isset($this->config[$name])) { |
||
113 | $this->addLog("ERROR :: CONFIG '{$name}' does not exist"); |
||
114 | return null; |
||
115 | } |
||
116 | $this->addLog("Getting config '{$name}' : " . $this->config[$name]); |
||
117 | return $this->config[$name]; |
||
118 | } |
||
119 | /* |
||
120 | * @static function setConfig |
||
121 | * @param string $name |
||
122 | * @param mixed $value |
||
123 | */ |
||
124 | /** |
||
125 | * @param null $name |
||
126 | * @param null $value |
||
127 | * @return mixed |
||
128 | */ |
||
129 | public function setConfig($name = null, $value = null) |
||
130 | { |
||
131 | if ($this->config === null) { |
||
132 | $this->initConfig(); |
||
133 | } |
||
134 | $this->config[$name] = $value; |
||
135 | $this->addLog("Setting config '{$name}' : " . $this->config[$name]); |
||
136 | return $this->config[$name]; |
||
137 | } |
||
138 | /* |
||
139 | * @static function getHandler |
||
140 | * @param string $name |
||
141 | */ |
||
142 | /** |
||
143 | * @param $name |
||
144 | * @return mixed |
||
145 | */ |
||
146 | public function &getHandler($name) |
||
147 | { |
||
148 | if (!isset($this->handler[$name . 'Handler'])) { |
||
149 | $this->initHandler($name); |
||
150 | } |
||
151 | $this->addLog("Getting handler '{$name}'"); |
||
152 | return $this->handler[$name . 'Handler']; |
||
153 | } |
||
154 | /* |
||
155 | * @static function initModule |
||
156 | * @param null |
||
157 | */ |
||
158 | public function initModule() |
||
159 | { |
||
160 | global $xoopsModule; |
||
0 ignored issues
–
show
Compatibility
Best Practice
introduced
by
Use of
global functionality is not recommended; it makes your code harder to test, and less reusable.
Instead of relying on 1. Pass all data via parametersfunction myFunction($a, $b) {
// Do something
}
2. Create a class that maintains your stateclass MyClass {
private $a;
private $b;
public function __construct($a, $b) {
$this->a = $a;
$this->b = $b;
}
public function myFunction() {
// Do something
}
}
Loading history...
|
|||
161 | if (isset($xoopsModule) && is_object($xoopsModule) && $xoopsModule->getVar('dirname') == $this->dirname) { |
||
162 | $this->module = $xoopsModule; |
||
0 ignored issues
–
show
It seems like
$xoopsModule of type object is incompatible with the declared type string of property $module .
Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property..
Loading history...
|
|||
163 | } else { |
||
164 | /** @var XoopsModule $hModule */ |
||
165 | $hModule = xoops_getHandler('module'); |
||
166 | $this->module = $hModule::getByDirname($this->dirname); |
||
167 | } |
||
168 | $this->addLog('INIT MODULE'); |
||
169 | } |
||
170 | /* |
||
171 | * @static function initConfig |
||
172 | * @param null |
||
173 | */ |
||
174 | public function initConfig() |
||
175 | { |
||
176 | $this->addLog('INIT CONFIG'); |
||
177 | /** @var XoopsConfigHandler $hModConfig */ |
||
178 | $hModConfig = xoops_getHandler('config'); |
||
179 | $this->config = $hModConfig->getConfigsByCat(0, $this->getModule()->getVar('mid')); |
||
0 ignored issues
–
show
|
|||
180 | } |
||
181 | /* |
||
182 | * @static function initHandler |
||
183 | * @param string $name |
||
184 | */ |
||
185 | /** |
||
186 | * @param $name |
||
187 | */ |
||
188 | public function initHandler($name) |
||
189 | { |
||
190 | $this->addLog('INIT ' . $name . ' HANDLER'); |
||
191 | $this->handler[$name . 'Handler'] = xoops_getModuleHandler($name, $this->dirname); |
||
192 | } |
||
193 | /* |
||
194 | * @static function addLog |
||
195 | * @param string $log |
||
196 | */ |
||
197 | /** |
||
198 | * @param $log |
||
199 | */ |
||
200 | public function addLog($log) |
||
0 ignored issues
–
show
addLog uses the super-global variable $GLOBALS which is generally not recommended.
Instead of super-globals, we recommend to explicitly inject the dependencies of your class. This makes your code less dependent on global state and it becomes generally more testable: // Bad
class Router
{
public function generate($path)
{
return $_SERVER['HOST'].$path;
}
}
// Better
class Router
{
private $host;
public function __construct($host)
{
$this->host = $host;
}
public function generate($path)
{
return $this->host.$path;
}
}
class Controller
{
public function myAction(Request $request)
{
// Instead of
$page = isset($_GET['page']) ? intval($_GET['page']) : 1;
// Better (assuming you use the Symfony2 request)
$page = $request->query->get('page', 1);
}
}
Loading history...
|
|||
201 | { |
||
202 | if ($this->debug) { |
||
203 | if (is_object($GLOBALS['xoopsLogger'])) { |
||
204 | $GLOBALS['xoopsLogger']->addExtra($this->module->name(), $log); |
||
0 ignored issues
–
show
|
|||
205 | } |
||
206 | } |
||
207 | } |
||
208 | } |
||
209 |
The PSR-1: Basic Coding Standard recommends that a file should either introduce new symbols, that is classes, functions, constants or similar, or have side effects. Side effects are anything that executes logic, like for example printing output, changing ini settings or writing to a file.
The idea behind this recommendation is that merely auto-loading a class should not change the state of an application. It also promotes a cleaner style of programming and makes your code less prone to errors, because the logic is not spread out all over the place.
To learn more about the PSR-1, please see the PHP-FIG site on the PSR-1.