Test Setup Failed
Pull Request — developer (#294)
by Arkadiusz
34:52
created

View::preProcess()   A

Complexity

Conditions 4
Paths 4

Size

Total Lines 11

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
dl 0
loc 11
rs 9.9
c 0
b 0
f 0
cc 4
nc 4
nop 1
1
<?php
2
/**
3
 * Controller class for views.
4
 *
5
 * @package App
6
 *
7
 * @copyright YetiForce Sp. z o.o.
8
 * @license   YetiForce Public License 3.0 (licenses/LicenseEN.txt or yetiforce.com)
9
 * @author    Tomasz Kur <[email protected]>
10
 * @author    Mariusz Krzaczkowski <[email protected]>
11
 */
12
13
namespace App\Controller;
14
15
/**
16
 * Controller class for views.
17
 */
18
abstract class View extends Base
0 ignored issues
show
Coding Style introduced by
View does not seem to conform to the naming convention (^Abstract|Factory$).

This check examines a number of code elements and verifies that they conform to the given naming conventions.

You can set conventions for local variables, abstract classes, utility classes, constant, properties, methods, parameters, interfaces, classes, exceptions and special methods.

Loading history...
19
{
20
	/** @var \App\Viewer Viewer object. */
21
	protected $viewer;
22
23
	/** {@inheritdoc} */
24
	public function __construct(\App\Request $request)
25
	{
26
		parent::__construct($request);
27
		$this->loadJsConfig($request);
28
		$this->viewer = new \App\Viewer();
29
		$this->viewer->assign('MODULE_NAME', $this->getModuleNameFromRequest($this->request));
0 ignored issues
show
Unused Code introduced by
The call to View::getModuleNameFromRequest() has too many arguments starting with $this->request.

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
30
		$this->viewer->assign('VIEW', $this->request->getByType('view', \App\Purifier::ALNUM));
31
		$this->viewer->assign('LANGUAGE', \App\Language::getLanguage());
32
		$this->viewer->assign('LANG', \App\Language::getShortLanguageName());
33
		$this->viewer->assign('USER', \App\User::getUser());
34
		$this->viewer->assign('ACTION_NAME', $this->request->getAction());
35
	}
36
37
	/**
38
	 * Check permission.
39
	 *
40
	 * @throws \App\Exceptions\NoPermitted
41
	 *
42
	 * @return void
43
	 */
44
	public function checkPermission(): void
45
	{
46
		$this->getModuleNameFromRequest($this->request);
0 ignored issues
show
Unused Code introduced by
The call to View::getModuleNameFromRequest() has too many arguments starting with $this->request.

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
47
		if (!\App\User::getUser()->isPermitted($this->moduleName)) {
48
			throw new \App\Exceptions\AppException('ERR_MODULE_PERMISSION_DENIED');
49
		}
50
	}
51
52
	/** {@inheritdoc} */
53
	public function preProcess($display = true): void
54
	{
55
		if ($this->loginRequired()) {
56
			$this->viewer->assign('MENU', \YF\Modules\Base\Model\Menu::getInstance($this->viewer->getTemplateVars('MODULE_NAME'))->getMenu());
57
		}
58
		$this->viewer->assign('PAGE_TITLE', (\Conf\Config::$siteName ?: \App\Language::translate('LBL_CUSTOMER_PORTAL')) . ' ' . $this->getPageTitle());
59
		$this->viewer->assign('CSS_FILE', $this->getHeaderCss());
60
		if ($display) {
61
			$this->preProcessDisplay();
62
		}
63
	}
64
65
	/**
66
	 * Get page title.
67
	 *
68
	 * @return string
69
	 */
70
	public function getPageTitle(): string
71
	{
72
		$title = \App\Language::translateModule($this->moduleName);
73
		$pageTitle = $this->getBreadcrumbTitle();
74
		if (isset($this->pageTitle)) {
75
			$pageTitle = \App\Language::translate($this->pageTitle);
0 ignored issues
show
Bug introduced by
The property pageTitle does not exist. Did you maybe forget to declare it?

In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code:

class MyClass { }

$x = new MyClass();
$x->foo = true;

Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion:

class MyClass {
    public $foo;
}

$x = new MyClass();
$x->foo = true;
Loading history...
76
		}
77
		if ($pageTitle) {
78
			$title .= ' - ' . $pageTitle;
79
		}
80
		return $title;
81
	}
82
83
	/**
84
	 * Get breadcrumb title.
85
	 *
86
	 * @return string
87
	 */
88
	public function getBreadcrumbTitle(): string
89
	{
90
		if (!empty($this->pageTitle)) {
91
			return $this->pageTitle;
92
		}
93
		return '';
94
	}
95
96
	/**
97
	 * Convert scripts path.
98
	 *
99
	 * @param array  $files
100
	 * @param string $fileExtension
101
	 *
102
	 * @return array
103
	 */
104
	public function convertScripts(array $files, string $fileExtension): array
105
	{
106
		$scriptsInstances = [];
107
		foreach ($files as $file) {
108
			[$fileName, $isOptional] = array_pad($file, 2, false);
0 ignored issues
show
Bug introduced by
The variable $fileName does not exist. Did you forget to declare it?

This check marks access to variables or properties that have not been declared yet. While PHP has no explicit notion of declaring a variable, accessing it before a value is assigned to it is most likely a bug.

Loading history...
Bug introduced by
The variable $isOptional does not exist. Did you forget to declare it?

This check marks access to variables or properties that have not been declared yet. While PHP has no explicit notion of declaring a variable, accessing it before a value is assigned to it is most likely a bug.

Loading history...
109
			$path = ROOT_DIRECTORY . "/public_html/$fileName";
110
			$script = new \App\Script();
111
			$script->set('type', $fileExtension);
112
			$minFilePath = str_replace('.' . $fileExtension, '.min.' . $fileExtension, $fileName);
113
			if (\App\Config::$minScripts && file_exists(ROOT_DIRECTORY . "/public_html/$minFilePath")) {
114
				$scriptsInstances[] = $script->set('src', PUBLIC_DIRECTORY . $minFilePath . self::getTime($path));
115
			} elseif (file_exists($path)) {
116
				$scriptsInstances[] = $script->set('src', PUBLIC_DIRECTORY . $fileName . self::getTime($path));
117
			} elseif ($isOptional) {
118
				\App\Log::info('File not found: ' . $path);
119
			} else {
120
				\App\Log::warning('File not found: ' . $path);
121
			}
122
		}
123
		return $scriptsInstances;
124
	}
125
126
	/**
127
	 * Gets file modification time.
128
	 *
129
	 * @param string $path
130
	 *
131
	 * @return string
132
	 */
133
	public static function getTime(string $path): string
134
	{
135
		$url = '';
136
		if ($fs = filemtime($path)) {
137
			$url = '?s=' . $fs;
138
		}
139
		return $url;
140
	}
141
142
	/**
143
	 * Retrieves css styles that need to loaded in the page.
144
	 *
145
	 * @return \App\Script[]
146
	 */
147
	public function getHeaderCss(): array
148
	{
149
		return $this->convertScripts([
150
			['libraries/@fortawesome/fontawesome-free/css/all.css'],
151
			['libraries/@mdi/font/css/materialdesignicons.css'],
152
			['libraries/bootstrap/dist/css/bootstrap.css'],
153
			['libraries/chosen-js/chosen.css'],
154
			['libraries/bootstrap-chosen/bootstrap-chosen.css'],
155
			['libraries/jQuery-Validation-Engine/css/validationEngine.jquery.css'],
156
			['libraries/select2/dist/css/select2.css'],
157
			['libraries/select2-theme-bootstrap4/dist/select2-bootstrap.css'],
158
			['libraries/datatables.net-bs4/css/dataTables.bootstrap4.css'],
159
			['libraries/datatables.net-responsive-bs4/css/responsive.bootstrap4.css'],
160
			['libraries/bootstrap-datepicker/dist/css/bootstrap-datepicker3.css'],
161
			['libraries/bootstrap-daterangepicker/daterangepicker.css'],
162
			['libraries/clockpicker/dist/bootstrap4-clockpicker.css'],
163
			['libraries/jstree-bootstrap-theme/dist/themes/proton/style.css'],
164
			['libraries/jstree/dist/themes/default/style.css'],
165
			['libraries/@pnotify/core/dist/PNotify.css'],
166
			['libraries/@pnotify/confirm/dist/PNotifyConfirm.css'],
167
			['libraries/@pnotify/bootstrap4/dist/PNotifyBootstrap4.css'],
168
			['libraries/@pnotify/mobile/dist/PNotifyMobile.css'],
169
			['libraries/@pnotify/desktop/dist/PNotifyDesktop.css'],
170
			['layouts/resources/icons/additionalIcons.css'],
171
			['layouts/resources/icons/yfm.css'],
172
			['layouts/resources/icons/yfi.css'],
173
			['layouts/' . \App\Viewer::getLayoutName() . '/skins/basic/Main.css'],
174
		], 'css');
175
	}
176
177
	/**
178
	 * Pre process display.
179
	 *
180
	 * @return void
181
	 */
182
	protected function preProcessDisplay(): void
183
	{
184
		if (\App\Session::has('systemError')) {
185
			$this->viewer->assign('ERRORS', \App\Session::get('systemError'));
186
			\App\Session::unset('systemError');
187
		}
188
		$this->viewer->view($this->preProcessTplName(), $this->moduleName);
189
	}
190
191
	/**
192
	 * Get preprocess tpl name.
193
	 *
194
	 * @return string
195
	 */
196
	protected function preProcessTplName(): string
197
	{
198
		return 'Header.tpl';
199
	}
200
201
	/**
202
	 * Get process tpl name.
203
	 *
204
	 * @return string
205
	 */
206
	protected function processTplName(): string
207
	{
208
		return $this->request->getAction() . '/Index.tpl';
209
	}
210
211
	/** {@inheritdoc}  */
212
	protected function postProcessTplName(): string
213
	{
214
		return 'Footer.tpl';
215
	}
216
217
	/** {@inheritdoc} */
218
	public function postProcess(): void
219
	{
220
		if (null === $this->viewer->getTemplateVars('SHOW_FOOTER_BAR')) {
221
			$this->viewer->assign('SHOW_FOOTER_BAR', true);
222
		}
223
		$this->viewer->assign('JS_FILE', $this->getFooterScripts());
224
		if (\App\Config::$debugApi && \App\Session::has('debugApi') && \App\Session::get('debugApi')) {
225
			$this->viewer->assign('DEBUG_API', \App\Session::get('debugApi'));
226
			$this->viewer->view('DebugApi.tpl', $this->moduleName);
227
			\App\Session::set('debugApi', false);
228
		}
229
		$this->viewer->view($this->postProcessTplName(), $this->moduleName);
230
	}
231
232
	/**
233
	 * Scripts.
234
	 *
235
	 * @return \App\Script[]
236
	 */
237
	public function getFooterScripts(): array
238
	{
239
		$moduleName = $this->getModuleNameFromRequest();
240
		$action = $this->request->getAction();
241
		$languageHandlerShortName = \App\Language::getShortLanguageName();
242
		$fileName = ["libraries/jQuery-Validation-Engine/js/languages/jquery.validationEngine-$languageHandlerShortName.js"];
243
		if (!file_exists(PUBLIC_DIRECTORY . $fileName[0])) {
244
			$fileName = ['libraries/jQuery-Validation-Engine/js/languages/jquery.validationEngine-en.js'];
245
		}
246
		return $this->convertScripts([
247
			['libraries/jquery/dist/jquery.js'],
248
			['libraries/jquery.class.js/jquery.class.js'],
249
			['libraries/block-ui/jquery.blockUI.js'],
250
			['libraries/@pnotify/core/dist/PNotify.js'],
251
			['libraries/@pnotify/mobile/dist/PNotifyMobile.js'],
252
			['libraries/@pnotify/desktop/dist/PNotifyDesktop.js'],
253
			['libraries/@pnotify/confirm/dist/PNotifyConfirm.js'],
254
			['libraries/@pnotify/bootstrap4/dist/PNotifyBootstrap4.js'],
255
			['libraries/@pnotify/font-awesome5/dist/PNotifyFontAwesome5.js'],
256
			['libraries/popper.js/dist/umd/popper.js'],
257
			['vendor/ckeditor/ckeditor/ckeditor.js'],
258
			['vendor/ckeditor/ckeditor/adapters/jquery.js'],
259
			['libraries/bootstrap/dist/js/bootstrap.js'],
260
			['libraries/bootstrap-datepicker/dist/js/bootstrap-datepicker.js'],
261
			['libraries/bootstrap-daterangepicker/daterangepicker.js'],
262
			['libraries/bootbox/dist/bootbox.min.js'],
263
			['libraries/chosen-js/chosen.jquery.js'],
264
			['libraries/select2/dist/js/select2.full.js'],
265
			['libraries/moment/min/moment.min.js'],
266
			['libraries/inputmask/dist/jquery.inputmask.js'],
267
			['libraries/datatables.net/js/jquery.dataTables.js'],
268
			['libraries/datatables.net-bs4/js/dataTables.bootstrap4.js'],
269
			['libraries/datatables.net-responsive/js/dataTables.responsive.js'],
270
			['libraries/datatables.net-responsive-bs4/js/responsive.bootstrap4.js'],
271
			['libraries/jQuery-Validation-Engine/js/jquery.validationEngine.js'],
272
			$fileName,
273
			['libraries/jstree/dist/jstree.js'],
274
			['libraries/clockpicker/dist/bootstrap4-clockpicker.js'],
275
			['layouts/resources/validator/BaseValidator.js'],
276
			['layouts/resources/validator/FieldValidator.js'],
277
			['layouts/resources/helper.js'],
278
			['layouts/resources/Field.js'],
279
			['layouts/resources/Connector.js'],
280
			['layouts/resources/app.js'],
281
			['layouts/resources/Fields.js'],
282
			['layouts/resources/ProgressIndicator.js'],
283
			['layouts/' . \App\Viewer::getLayoutName() . '/modules/Base/resources/Header.js'],
284
			['layouts/' . \App\Viewer::getLayoutName() . "/modules/Base/resources/{$action}.js"],
285
			['layouts/' . \App\Viewer::getLayoutName() . "/modules/{$moduleName}/resources/{$action}.js", true],
286
		], 'js');
287
	}
288
289
	/** {@inheritdoc} */
290
	public function validateRequest()
291
	{
292
		$this->request->validateReadAccess();
293
	}
294
295
	/** {@inheritdoc} */
296
	public function postProcessAjax()
297
	{
298
	}
299
300
	/** {@inheritdoc} */
301
	public function preProcessAjax()
302
	{
303
	}
304
305
	/**
306
	 * Get module name from request.
307
	 *
308
	 * @return string
309
	 */
310
	private function getModuleNameFromRequest(): string
311
	{
312
		if (empty($this->moduleName)) {
313
			$this->moduleName = $this->request->getModule();
314
		}
315
		return $this->moduleName;
316
	}
317
318
	/**
319
	 * Load js config.
320
	 *
321
	 * @param \App\Request $request
322
	 */
323
	public function loadJsConfig(\App\Request $request): void
324
	{
325
		$jsEnv = [
326
			'siteUrl' => \App\Utils::getPublicUrl('', true),
327
			'langPrefix' => \App\Language::getLanguage(),
328
			'langKey' => \App\Language::getShortLanguageName(),
329
			'parentModule' => $request->getByType('parent', 2),
330
		];
331
		foreach ($jsEnv as $key => $value) {
332
			\App\Config::setJsEnv($key, $value);
333
		}
334
	}
335
}
336