app/Controller/Modal.php
The class Modal has 16 fields. Consider redesigning Modal to keep the number of fields under 15. Open
Open
abstract class Modal extends View\Base
{
/**
* Modal size.
*- Read upRead up
- Exclude checks
TooManyFields
Since: 0.1
Classes that have too many fields could be redesigned to have fewer fields, possibly through some nested object grouping of some of the information. For example, a class with city/state/zip fields could instead have one Address field.
Example
class Person {
protected $one;
private $two;
private $three;
[... many more fields ...]
}Source https://phpmd.org/rules/codesize.html#toomanyfields
Method preProcessAjax has 31 lines of code (exceeds 25 allowed). Consider refactoring. Open
Open
public function preProcessAjax(\App\Request $request)
{
$moduleName = $request->getModule(false);
$view = $request->getByType('view', 2);
if ($this->modalId) {Avoid unused parameters such as '$request'. Open
Open
protected function preProcessTplName(\App\Request $request)- Read upRead up
- Exclude checks
UnusedFormalParameter
Since: 0.2
Avoid passing parameters to methods or constructors and then not using those parameters.
Example
class Foo
{
private function bar($howdy)
{
// $howdy is not used
}
}Source https://phpmd.org/rules/unusedcode.html#unusedformalparameter
syntax error, unexpected 'bool' (T_STRING), expecting function (T_FUNCTION) or const (T_CONST) Open
Open
protected bool $blurBackground = false;- Exclude checks
Avoid using static access to class '\App\Language' in method 'getPageTitle'. Open
Open
$pageTitle = \App\Language::translate($moduleName, $moduleName);- Read upRead up
- Exclude checks
StaticAccess
Since: 1.4.0
Static access causes unexchangeable dependencies to other classes and leads to hard to test code. Avoid using static access at all costs and instead inject dependencies through the constructor. The only case when static access is acceptable is when used for factory methods.
Example
class Foo
{
public function bar()
{
Bar::baz();
}
}Source https://phpmd.org/rules/cleancode.html#staticaccess
Avoid using static access to class '\App\Language' in method 'getPageTitle'. Open
Open
$pageTitle = \App\Language::translate($this->pageTitle, $moduleName);- Read upRead up
- Exclude checks
StaticAccess
Since: 1.4.0
Static access causes unexchangeable dependencies to other classes and leads to hard to test code. Avoid using static access at all costs and instead inject dependencies through the constructor. The only case when static access is acceptable is when used for factory methods.
Example
class Foo
{
public function bar()
{
Bar::baz();
}
}Source https://phpmd.org/rules/cleancode.html#staticaccess
The method getPageTitle uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them. Open
Open
} else {
$pageTitle = \App\Language::translate($moduleName, $moduleName);
}- Read upRead up
- Exclude checks
ElseExpression
Since: 1.4.0
An if expression with an else branch is basically not necessary. You can rewrite the conditions in a way that the else clause is not necessary and the code becomes simpler to read. To achieve this, use early return statements, though you may need to split the code it several smaller methods. For very simple assignments you could also use the ternary operations.
Example
class Foo
{
public function bar($flag)
{
if ($flag) {
// one branch
} else {
// another branch
}
}
}Source https://phpmd.org/rules/cleancode.html#elseexpression
Spaces must be used to indent lines; tabs are not allowed Open
Open
public $headerClass = '';- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
/**- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
* @var string- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
* @var string[]- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
* Show modal header.- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
* @var string- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
*/- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
public $modalId = '';- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
* @var string- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
*- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
/**- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
* The name of the success button icon.- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
* @var string- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
* @var bool- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
* @var bool Auto register events- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
*/- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
* @var string- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
*/- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
*/- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
/**- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
* The name of the success button.- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
public $successBtn = 'LBL_SAVE';- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
$viewer->assign('VIEW', $view);- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
$viewer->assign('MODAL_CSS', $this->getModalCss($request));- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
$this->showHeader = false;- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
$this->showFooter = false;- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
}- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
return $this->showFooter;- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
*/- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
* The name of the danger button.- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
* @var string- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
public $dangerBtn = 'LBL_CANCEL';- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
*- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
public $autoRegisterEvents = true;- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
$moduleName = $request->getModule(false);- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
$this->modalData['mode'] = $request->getByType('mode', 'Alnum');- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
* @return \Vtiger_CssScript_Model[]- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
return 'Modals/Header.tpl';- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
*- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
* Modal icon.- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
/**- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
* Modal data.- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
* @var string- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
*/- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
*- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
*/- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
*/- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
*/- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
/** @var bool Blur background */- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
$viewer->assign('MODULE_NAME', $moduleName);- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
{- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
$viewer->assign('BTN_SUCCESS_ICON', $this->successBtnIcon);- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
$viewer->assign('BTN_DANGER', $this->dangerBtn);- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
*/- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
*- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
*- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
/**- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
/**- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
public $lockExit = false;- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
public $showFooter = true;- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
protected bool $draggable = true;- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
$viewer->assign('MODAL_TITLE', $this->getPageTitle($request));- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
$viewer->assign('MODAL_SCRIPTS', $this->getModalScripts($request));- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
}- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
* Get modal css files that need to loaded in the modal.- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
/** {@inheritdoc} */- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
*- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
/** {@inheritdoc} */- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
*- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
public $successBtnIcon = 'fas fa-check';- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
/**- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
* Block the window closing.- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
*- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
*/- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
protected $pageTitle;- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
}- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
if ($request->has('mode')) {- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
$viewer->assign('LOCK_EXIT', $this->lockExit);- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
$viewer->assign('REGISTER_EVENTS', $this->autoRegisterEvents);- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
}- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
}- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
* Get modal scripts files that need to loaded in the modal.- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
*- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
{- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
$viewName = $request->getByType('view', 2);- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
*- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
$moduleName = $request->getModule();- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
* Pre process template name.- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
protected function preProcessTplName(\App\Request $request)- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
*/- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
$viewer->assign('MODULE', $moduleName);- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
if ($this->showHeader) {- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
$viewer->view('Modals/Footer.tpl', $request->getModule());- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
*- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
return $this->checkAndConvertCssStyles([- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
]);- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
* Modal size.- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
* Header class.- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
*- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
$viewer->assign('MODAL_ID', $this->modalId);- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
$viewer->assign('BLUR_BACKGROUND', $this->blurBackground);- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
if ($this->showFooter()) {- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
$viewer = $this->getViewer($request);- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
{- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
$viewName = $request->getByType('view', 2);- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
"modules.{$request->getModule()}.$viewName",- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
/**- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
public $modalData = [];- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
* @var string- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
* The name of the footerClass.- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
/** @var bool Draggable */- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
if ($this->modalId) {- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
$viewer->assign('MODAL_VIEW', $this);- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
$viewer->view($this->preProcessTplName($request), $moduleName);- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
]);- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
*/- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
/**- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
* Modal ID.- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
*- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
{- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
/**- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
public function getPageTitle(\App\Request $request)- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
return $pageTitle;- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
* @return string- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
{- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
protected function showFooter()- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
public $modalIcon = '';- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
/** @var string Page title. */- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
public function preProcessAjax(\App\Request $request)- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
$this->modalData['view'] = $view;- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
$this->modalData['module'] = $moduleName;- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
$viewer = $this->getViewer($request);- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
if ($request->getBoolean('onlyBody')) {- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
$viewer->assign('BTN_SUCCESS', $this->successBtn);- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
*/- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
public function getModalCss(\App\Request $request)- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
if (isset($this->pageTitle)) {- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
}- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
* Show modal footer.- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
protected bool $blurBackground = false;- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
}- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
} else {- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
/**- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
}- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
{- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
$view = $request->getByType('view', 2);- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
$this->modalData['modalid'] = $this->modalId;- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
$viewer->assign('FOOTER_CLASS', $this->footerClass);- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
}- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
* @param \App\Request $request- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
*- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
}- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
$pageTitle = \App\Language::translate($this->pageTitle, $moduleName);- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
}- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
public $modalSize = 'modal-lg';- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
*/- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
*/- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
/**- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
public $showHeader = true;- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
/** {@inheritdoc} */- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
"modules.{$request->getModule()}.resources.$viewName",- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
{- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
*- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
$viewer->assign('PARENT_MODULE', $request->getByType('parent', 2));- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
public function postProcessAjax(\App\Request $request)- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
public function getModalScripts(\App\Request $request)- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
"modules.Vtiger.resources.$viewName",- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
/**- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
/**- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
* @var bool- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
/**- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
$viewer->assign('MODAL_DRAGGABLE', $this->draggable);- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
* @return \Vtiger_JsScript_Model[]- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
return $this->checkAndConvertJsScripts([- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
* @param \App\Request $request- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
$pageTitle = \App\Language::translate($moduleName, $moduleName);- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
* @param \App\Request $request- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
*- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
public $footerClass = '';- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
* @var bool- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
*- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
/** {@inheritdoc} */- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
}- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
/**- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
"modules.Vtiger.$viewName",- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
}- Exclude checks