Method save has 54 lines of code (exceeds 25 allowed). Consider refactoring. Open
public static function save(Vtiger_PDF_Model $pdfModel, $step = 1)
{
$db = \App\Db::getInstance('admin');
switch ($step) {Function save has a Cognitive Complexity of 16 (exceeds 5 allowed). Consider refactoring. Open
public static function save(Vtiger_PDF_Model $pdfModel, $step = 1)
{
$db = \App\Db::getInstance('admin');
switch ($step) {- Read upRead up
Cognitive Complexity
Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.
A method's cognitive complexity is based on a few simple rules:
- Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
- Code is considered more complex for each "break in the linear flow of the code"
- Code is considered more complex when "flow breaking structures are nested"
Further reading
Function transformAdvanceFilterToWorkFlowFilter has a Cognitive Complexity of 15 (exceeds 5 allowed). Consider refactoring. Open
public static function transformAdvanceFilterToWorkFlowFilter(Vtiger_PDF_Model &$pdfModel)
{
$conditions = $pdfModel->get('conditions');
$wfCondition = [];
if (!empty($conditions)) {- Read upRead up
Cognitive Complexity
Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.
A method's cognitive complexity is based on a few simple rules:
- Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
- Code is considered more complex for each "break in the linear flow of the code"
- Code is considered more complex when "flow breaking structures are nested"
Further reading
Method getRecordLinks has 26 lines of code (exceeds 25 allowed). Consider refactoring. Open
public function getRecordLinks(): array
{
$links = [];
$recordLinks = [The method save() has a Cyclomatic Complexity of 12. The configured cyclomatic complexity threshold is 10. Open
public static function save(Vtiger_PDF_Model $pdfModel, $step = 1)
{
$db = \App\Db::getInstance('admin');
switch ($step) {- Read upRead up
- Exclude checks
CyclomaticComplexity
Since: 0.1
Complexity is determined by the number of decision points in a method plus one for the method entry. The decision points are 'if', 'while', 'for', and 'case labels'. Generally, 1-4 is low complexity, 5-7 indicates moderate complexity, 8-10 is high complexity, and 11+ is very high complexity.
Example
// Cyclomatic Complexity = 11
class Foo {
1 public function example() {
2 if ($a == $b) {
3 if ($a1 == $b1) {
fiddle();
4 } elseif ($a2 == $b2) {
fiddle();
} else {
fiddle();
}
5 } elseif ($c == $d) {
6 while ($c == $d) {
fiddle();
}
7 } elseif ($e == $f) {
8 for ($n = 0; $n < $h; $n++) {
fiddle();
}
} else {
switch ($z) {
9 case 1:
fiddle();
break;
10 case 2:
fiddle();
break;
11 case 3:
fiddle();
break;
default:
fiddle();
break;
}
}
}
}Source https://phpmd.org/rules/codesize.html#cyclomaticcomplexity
Refactor this function to reduce its Cognitive Complexity from 22 to the 15 allowed. Open
public static function save(Vtiger_PDF_Model $pdfModel, $step = 1)- Read upRead up
- Exclude checks
Cognitive Complexity is a measure of how hard the control flow of a function is to understand. Functions with high Cognitive Complexity will be difficult to maintain.
See
Avoid using static access to class 'Settings_PDF_Module_Model' in method 'save'. Open
$stepFields = Settings_PDF_Module_Model::getFieldsByStep($step);- 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 save uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them. Open
} else {
$params = $pdfModel->get($field);
}- 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
Avoid using static access to class 'Settings_PDF_Module_Model' in method 'save'. Open
$stepFields = Settings_PDF_Module_Model::getFieldsByStep($step);- 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 save uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them. Open
} else {
foreach ($stepFields as $field) {
$fields[$field] = $pdfModel->get($field);
}
$db->createCommand()->update('a_#__pdf', $fields, ['pdfid' => $pdfModel->getId()])- 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
Avoid using static access to class '\App\Cache' in method 'save'. Open
\App\Cache::delete(\get_class($pdfModel), $pdfModel->getId());- 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\Pdf\Pdf' in method 'getDisplayValue'. Open
$value = \App\Pdf\Pdf::getDriverLabel($value);- 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\Db' in method 'save'. Open
$db = \App\Db::getInstance('admin');- 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\Cache' in method 'delete'. Open
\App\Cache::delete(\get_class($pdfModel), $pdfModel->getId());- 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\Cache' in method 'save'. Open
\App\Cache::delete(\get_class($pdfModel), $pdfModel->getId());- 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\Purifier' in method 'getDisplayValue'. Open
$value = \App\Purifier::encodeHtml($value);- 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 'Settings_PDF_Module_Model' in method 'getCleanInstance'. Open
$fields = Settings_PDF_Module_Model::getFieldsByStep();- 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 save uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them. Open
} else {
$params[$field] = $pdfModel->get($field);
}- 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
Avoid using static access to class '\App\Db' in method 'deleteWatermark'. Open
$db = \App\Db::getInstance('admin');- 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 'Vtiger_Module_Model' in method 'setModule'. Open
$this->module = Vtiger_Module_Model::getInstance($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 'Vtiger_Loader' in method 'getCleanInstance'. Open
$handlerClass = Vtiger_Loader::getComponentClassName('Model', 'PDF', $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 'Settings_PDF_Module_Model' in method 'save'. Open
$fields['type'] = Settings_PDF_Module_Model::getTemplateType($pdfModel);- 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 'Vtiger_Link_Model' in method 'getRecordLinks'. Open
$links[] = Vtiger_Link_Model::getInstanceFromValues($recordLink);- 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
Define a constant instead of duplicating this literal "groupid" 3 times. Open
'joincondition' => '', 'groupid' => '0', ];- Read upRead up
- Exclude checks
Duplicated string literals make the process of refactoring error-prone, since you must be sure to update all occurrences.
On the other hand, constants can be referenced from many places, but only need to be updated in a single place.
Noncompliant Code Example
With the default threshold of 3:
function run() {
prepare('action1'); // Non-Compliant - 'action1' is duplicated 3 times
execute('action1');
release('action1');
}
Compliant Solution
ACTION_1 = 'action1';
function run() {
prepare(ACTION_1);
execute(ACTION_1);
release(ACTION_1);
}
Exceptions
To prevent generating some false-positives, literals having less than 5 characters are excluded.
Define a constant instead of duplicating this literal "admin" 3 times. Open
$db = \App\Db::getInstance('admin');- Read upRead up
- Exclude checks
Duplicated string literals make the process of refactoring error-prone, since you must be sure to update all occurrences.
On the other hand, constants can be referenced from many places, but only need to be updated in a single place.
Noncompliant Code Example
With the default threshold of 3:
function run() {
prepare('action1'); // Non-Compliant - 'action1' is duplicated 3 times
execute('action1');
release('action1');
}
Compliant Solution
ACTION_1 = 'action1';
function run() {
prepare(ACTION_1);
execute(ACTION_1);
release(ACTION_1);
}
Exceptions
To prevent generating some false-positives, literals having less than 5 characters are excluded.
Define a constant instead of duplicating this literal "value" 3 times. Open
$wfCondition[] = ['fieldname' => '', 'operation' => '', 'value' => '', 'valuetype' => '',- Read upRead up
- Exclude checks
Duplicated string literals make the process of refactoring error-prone, since you must be sure to update all occurrences.
On the other hand, constants can be referenced from many places, but only need to be updated in a single place.
Noncompliant Code Example
With the default threshold of 3:
function run() {
prepare('action1'); // Non-Compliant - 'action1' is duplicated 3 times
execute('action1');
release('action1');
}
Compliant Solution
ACTION_1 = 'action1';
function run() {
prepare(ACTION_1);
execute(ACTION_1);
release(ACTION_1);
}
Exceptions
To prevent generating some false-positives, literals having less than 5 characters are excluded.
Define a constant instead of duplicating this literal "linklabel" 3 times. Open
'linklabel' => 'LBL_EDIT_RECORD',- Read upRead up
- Exclude checks
Duplicated string literals make the process of refactoring error-prone, since you must be sure to update all occurrences.
On the other hand, constants can be referenced from many places, but only need to be updated in a single place.
Noncompliant Code Example
With the default threshold of 3:
function run() {
prepare('action1'); // Non-Compliant - 'action1' is duplicated 3 times
execute('action1');
release('action1');
}
Compliant Solution
ACTION_1 = 'action1';
function run() {
prepare(ACTION_1);
execute(ACTION_1);
release(ACTION_1);
}
Exceptions
To prevent generating some false-positives, literals having less than 5 characters are excluded.
Define a constant instead of duplicating this literal "valuetype" 3 times. Open
$wfCondition[] = ['fieldname' => '', 'operation' => '', 'value' => '', 'valuetype' => '',- Read upRead up
- Exclude checks
Duplicated string literals make the process of refactoring error-prone, since you must be sure to update all occurrences.
On the other hand, constants can be referenced from many places, but only need to be updated in a single place.
Noncompliant Code Example
With the default threshold of 3:
function run() {
prepare('action1'); // Non-Compliant - 'action1' is duplicated 3 times
execute('action1');
release('action1');
}
Compliant Solution
ACTION_1 = 'action1';
function run() {
prepare(ACTION_1);
execute(ACTION_1);
release(ACTION_1);
}
Exceptions
To prevent generating some false-positives, literals having less than 5 characters are excluded.
Define a constant instead of duplicating this literal "conditions" 4 times. Open
if ('conditions' === $field) {- Read upRead up
- Exclude checks
Duplicated string literals make the process of refactoring error-prone, since you must be sure to update all occurrences.
On the other hand, constants can be referenced from many places, but only need to be updated in a single place.
Noncompliant Code Example
With the default threshold of 3:
function run() {
prepare('action1'); // Non-Compliant - 'action1' is duplicated 3 times
execute('action1');
release('action1');
}
Compliant Solution
ACTION_1 = 'action1';
function run() {
prepare(ACTION_1);
execute(ACTION_1);
release(ACTION_1);
}
Exceptions
To prevent generating some false-positives, literals having less than 5 characters are excluded.
Define a constant instead of duplicating this literal "a_#__pdf" 6 times. Open
->update('a_#__pdf', $fields, ['pdfid' => $pdfModel->getId()])- Read upRead up
- Exclude checks
Duplicated string literals make the process of refactoring error-prone, since you must be sure to update all occurrences.
On the other hand, constants can be referenced from many places, but only need to be updated in a single place.
Noncompliant Code Example
With the default threshold of 3:
function run() {
prepare('action1'); // Non-Compliant - 'action1' is duplicated 3 times
execute('action1');
release('action1');
}
Compliant Solution
ACTION_1 = 'action1';
function run() {
prepare(ACTION_1);
execute(ACTION_1);
release(ACTION_1);
}
Exceptions
To prevent generating some false-positives, literals having less than 5 characters are excluded.
Define a constant instead of duplicating this literal "linkicon" 3 times. Open
'linkicon' => 'yfi yfi-full-editing-view',- Read upRead up
- Exclude checks
Duplicated string literals make the process of refactoring error-prone, since you must be sure to update all occurrences.
On the other hand, constants can be referenced from many places, but only need to be updated in a single place.
Noncompliant Code Example
With the default threshold of 3:
function run() {
prepare('action1'); // Non-Compliant - 'action1' is duplicated 3 times
execute('action1');
release('action1');
}
Compliant Solution
ACTION_1 = 'action1';
function run() {
prepare(ACTION_1);
execute(ACTION_1);
release(ACTION_1);
}
Exceptions
To prevent generating some false-positives, literals having less than 5 characters are excluded.
Define a constant instead of duplicating this literal "pdfid" 9 times. Open
return $this->get('pdfid');- Read upRead up
- Exclude checks
Duplicated string literals make the process of refactoring error-prone, since you must be sure to update all occurrences.
On the other hand, constants can be referenced from many places, but only need to be updated in a single place.
Noncompliant Code Example
With the default threshold of 3:
function run() {
prepare('action1'); // Non-Compliant - 'action1' is duplicated 3 times
execute('action1');
release('action1');
}
Compliant Solution
ACTION_1 = 'action1';
function run() {
prepare(ACTION_1);
execute(ACTION_1);
release(ACTION_1);
}
Exceptions
To prevent generating some false-positives, literals having less than 5 characters are excluded.
Define a constant instead of duplicating this literal "LISTVIEWRECORD" 3 times. Open
'linktype' => 'LISTVIEWRECORD',- Read upRead up
- Exclude checks
Duplicated string literals make the process of refactoring error-prone, since you must be sure to update all occurrences.
On the other hand, constants can be referenced from many places, but only need to be updated in a single place.
Noncompliant Code Example
With the default threshold of 3:
function run() {
prepare('action1'); // Non-Compliant - 'action1' is duplicated 3 times
execute('action1');
release('action1');
}
Compliant Solution
ACTION_1 = 'action1';
function run() {
prepare(ACTION_1);
execute(ACTION_1);
release(ACTION_1);
}
Exceptions
To prevent generating some false-positives, literals having less than 5 characters are excluded.
Define a constant instead of duplicating this literal "linkurl" 3 times. Open
'linkurl' => $this->getEditViewUrl(),- Read upRead up
- Exclude checks
Duplicated string literals make the process of refactoring error-prone, since you must be sure to update all occurrences.
On the other hand, constants can be referenced from many places, but only need to be updated in a single place.
Noncompliant Code Example
With the default threshold of 3:
function run() {
prepare('action1'); // Non-Compliant - 'action1' is duplicated 3 times
execute('action1');
release('action1');
}
Compliant Solution
ACTION_1 = 'action1';
function run() {
prepare(ACTION_1);
execute(ACTION_1);
release(ACTION_1);
}
Exceptions
To prevent generating some false-positives, literals having less than 5 characters are excluded.
Define a constant instead of duplicating this literal "linktype" 3 times. Open
'linktype' => 'LISTVIEWRECORD',- Read upRead up
- Exclude checks
Duplicated string literals make the process of refactoring error-prone, since you must be sure to update all occurrences.
On the other hand, constants can be referenced from many places, but only need to be updated in a single place.
Noncompliant Code Example
With the default threshold of 3:
function run() {
prepare('action1'); // Non-Compliant - 'action1' is duplicated 3 times
execute('action1');
release('action1');
}
Compliant Solution
ACTION_1 = 'action1';
function run() {
prepare(ACTION_1);
execute(ACTION_1);
release(ACTION_1);
}
Exceptions
To prevent generating some false-positives, literals having less than 5 characters are excluded.
Call to undeclared method \App\Db::createCommand Open
$db->createCommand()- Exclude checks
Call to undeclared method \App\Db::createCommand Open
$db->createCommand()->insert('a_#__pdf', $params)->execute();- Exclude checks
Reference to undeclared property \Settings_PDF_Record_Model->module Open
$this->module = Vtiger_Module_Model::getInstance($moduleName);- Exclude checks
Call to undeclared method \App\Db::createCommand Open
return App\Db::getInstance('admin')->createCommand()- Exclude checks
Call to undeclared method \App\Db::createCommand Open
$db->createCommand()->insert('a_#__pdf', $fields)->execute();- Exclude checks
Saw unextractable annotation for comment '* @return <number> - Record Id'</number> Open
* @return <Number> - Record Id- Exclude checks
Reference to undeclared property \Settings_PDF_Record_Model->module Open
return $this->module;- Exclude checks
Call to undeclared method \App\Db::createCommand Open
$db->createCommand()->update('a_#__pdf', $fields, ['pdfid' => $pdfModel->getId()])- Exclude checks
@throws type of deleteWatermark has undeclared type \yii\db\Exception (Did you mean class \Exception) Open
public static function deleteWatermark(Vtiger_PDF_Model $pdfModel)- Exclude checks
Call to undeclared method \App\Db::createCommand Open
$db->createCommand()- Exclude checks
Identical blocks of code found in 2 locations. Consider refactoring. Open
if (!empty($conditions)) {
foreach ($conditions as $index => $condition) {
$columns = $condition['columns'];
if ('1' == $index && empty($columns)) {
$wfCondition[] = ['fieldname' => '', 'operation' => '', 'value' => '', 'valuetype' => '',- Read upRead up
Duplicated Code
Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:
Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.
When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).
Tuning
This issue has a mass of 178.
We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.
The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.
If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.
See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.
Refactorings
- Extract Method
- Extract Class
- Form Template Method
- Introduce Null Object
- Pull Up Method
- Pull Up Field
- Substitute Algorithm
Further Reading
- Don't Repeat Yourself on the C2 Wiki
- Duplicated Code on SourceMaking
- Refactoring: Improving the Design of Existing Code by Martin Fowler. Duplicated Code, p76
Each class must be in a namespace of at least one level (a top-level vendor name) Open
class Settings_PDF_Record_Model extends Settings_Vtiger_Record_Model- Exclude checks
Avoid variables with short names like $db. Configured minimum length is 3. Open
$db = \App\Db::getInstance('admin');- Read upRead up
- Exclude checks
ShortVariable
Since: 0.2
Detects when a field, local, or parameter has a very short name.
Example
class Something {
private $q = 15; // VIOLATION - Field
public static function main( array $as ) { // VIOLATION - Formal
$r = 20 + $this->q; // VIOLATION - Local
for (int $i = 0; $i < 10; $i++) { // Not a Violation (inside FOR)
$r += $this->q;
}
}
}Source https://phpmd.org/rules/naming.html#shortvariable
Avoid variables with short names like $db. Configured minimum length is 3. Open
$db = \App\Db::getInstance('admin');- Read upRead up
- Exclude checks
ShortVariable
Since: 0.2
Detects when a field, local, or parameter has a very short name.
Example
class Something {
private $q = 15; // VIOLATION - Field
public static function main( array $as ) { // VIOLATION - Formal
$r = 20 + $this->q; // VIOLATION - Local
for (int $i = 0; $i < 10; $i++) { // Not a Violation (inside FOR)
$r += $this->q;
}
}
}Source https://phpmd.org/rules/naming.html#shortvariable
The class Settings_PDF_Record_Model is not named in CamelCase. Open
class Settings_PDF_Record_Model extends Settings_Vtiger_Record_Model
{
protected $recordCache = [];
protected $fieldsCache = [];
protected $moduleRecordId;- Read upRead up
- Exclude checks
CamelCaseClassName
Since: 0.2
It is considered best practice to use the CamelCase notation to name classes.
Example
class class_name {
}Source
Spaces must be used to indent lines; tabs are not allowed Open
return $this->get('pdfid');- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$links = [];- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
{- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
/**- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
* Function to get the id of the record.- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
* @return <Number> - Record Id- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
{- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
'linkicon' => 'yfi yfi-full-editing-view',- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
}- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$recordLinks = [- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
protected $recordCache = [];- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
return 'index.php?module=PDF&parent=Settings&view=Edit&record=' . $this->getId();- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
return $this->module;- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
public function setModule($moduleName)- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
/** {@inheritdoc} */- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$pdfModel->set('pdfid', $db->getLastInsertID('a_#__pdf_pdfid_seq'));- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
->execute();- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
default:- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
}- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
{- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
],- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
}- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
public function getEditViewUrl()- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
return $this;- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
{- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
'linktype' => 'LISTVIEWRECORD',- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
*/- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
public function getId()- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
{- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
{- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$db = \App\Db::getInstance('admin');- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
}- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$fields[$field] = $pdfModel->get($field);- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
}- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$params = [];- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$db->createCommand()- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
->execute();- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
if ('1' == $index && empty($columns)) {- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$wfCondition[] = ['fieldname' => $column['columnname'], 'operation' => $column['comparator'],- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
}- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
*/- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$this->module = Vtiger_Module_Model::getInstance($moduleName);- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
protected $fieldsCache = [];- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
protected $moduleRecordId;- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
*- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
'linkurl' => $this->getEditViewUrl(),- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
'class' => 'js-edit',- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$pdf->setData($data);- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
case 'import':- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
return $pdfModel->get('pdfid');- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
break;- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
* Delete watermark.- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
* @return bool- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
}- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
public function getName()- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
}- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
public function getModule()- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
'linklabel' => 'LBL_EDIT_RECORD',- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
}- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
'linkicon' => 'fas fa-upload',- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
'linktype' => 'LISTVIEWRECORD',- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$data = [];- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$data[$field] = '';- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
}- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
foreach ($stepFields as $field) {- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
return $pdfModel->get('pdfid');- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$pdfModel->set('pdfid', $db->getLastInsertID('a_#__pdf_pdfid_seq'));- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
->execute();- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
}- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
public static function delete(Vtiger_PDF_Model $pdfModel)- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
->delete('a_#__pdf', ['pdfid' => $pdfModel->getId()])- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
* @param string $key- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
public function getRecordLinks(): array- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
switch ($step) {- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
}- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
case 1:- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$fields = [];- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
* @throws \yii\db\Exception- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
foreach ($columns as $column) {- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
return $this->get('primary_name');- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
{- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
[- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$links[] = Vtiger_Link_Model::getInstanceFromValues($recordLink);- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$params[$field] = json_encode($pdfModel->get($field));- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
}- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
{- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
}- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$wfCondition = [];- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
'linktype' => 'LISTVIEWRECORD',- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
],- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
];- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
return $links;- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$params[$field] = $pdfModel->get($field);- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$db->createCommand()->insert('a_#__pdf', $params)->execute();- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
}- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
/**- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
* @param Vtiger_PDF_Model $pdfModel- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
foreach ($recordLinks as $recordLink) {- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
foreach ($stepFields as $field) {- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$db->createCommand()->insert('a_#__pdf', $fields)->execute();- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
}- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
}- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
/**- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
*/- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
public static function transformAdvanceFilterToWorkFlowFilter(Vtiger_PDF_Model &$pdfModel)- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
foreach ($conditions as $index => $condition) {- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
'value' => $column['value'] ?? '', 'valuetype' => $column['valuetype'], 'joincondition' => $column['column_condition'],- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
/**- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
* Function to get the Display Value, for the current field type with given DB Insert Value.- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
*- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
* @return string- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
break;- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
'linkicon' => 'fas fa-trash-alt',- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
}- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
} else {- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
if (!$pdfModel->getId()) {- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
foreach ($stepFields as $field) {- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
* @param Vtiger_PDF_Model $pdfModel- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
\App\Cache::delete(\get_class($pdfModel), $pdfModel->getId());- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$wfCondition[] = ['fieldname' => '', 'operation' => '', 'value' => '', 'valuetype' => '',- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
}- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
}- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$value = $value ? 'LBL_YES' : 'LBL_NO';- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
'linkurl' => 'index.php?module=PDF&parent=Settings&action=ExportTemplate&id=' . $this->getId(),- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
[- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
'linklabel' => 'LBL_DELETE_RECORD',- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
}- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
case 3:- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$params = json_encode($pdfModel->get($field));- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$params = $pdfModel->get($field);- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$fields[$field] = $params;- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
->execute();- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
return $pdfModel->getId();- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
}- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
*- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$watermarkImage = $pdfModel->get('watermark_image');- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
return unlink($watermarkImage);- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
return App\Db::getInstance('admin')->createCommand()- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
'groupjoin' => $condition['condition'], 'groupid' => $column['groupid'], ];- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$stepFields = Settings_PDF_Module_Model::getFieldsByStep($step);- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
if ('conditions' === $field) {- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$allFields = Settings_PDF_Module_Model::$allFields;- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
*- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
*/- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
->update('a_#__pdf', ['watermark_image' => ''], ['pdfid' => $pdfModel->getId()])- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
}- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
{- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$conditions = $pdfModel->get('conditions');- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
}- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$value = $this->get($key);- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
public static function getCleanInstance($moduleName = 'Vtiger')- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$handlerClass = Vtiger_Loader::getComponentClassName('Model', 'PDF', $moduleName);- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$fields = Settings_PDF_Module_Model::getFieldsByStep();- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
case 2:- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
foreach ($allFields as $field) {- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
if (!empty($conditions)) {- Exclude checks
Line exceeds 120 characters; contains 147 characters Open
'value' => $column['value'] ?? '', 'valuetype' => $column['valuetype'], 'joincondition' => $column['column_condition'],- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
default:- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$value = \App\Purifier::encodeHtml($value);- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
return $value;- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
return $pdf;- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
\App\Cache::delete(\get_class($pdfModel), $pdfModel->getId());- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
if ('conditions' === $field) {- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
public static function deleteWatermark(Vtiger_PDF_Model $pdfModel)- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
if (file_exists($watermarkImage)) {- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
'joincondition' => '', 'groupid' => '0', ];- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
case 'default':- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
}- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
case 'generator':- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
}- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
[- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
'linklabel' => 'LBL_EXPORT_RECORD',- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
'linkurl' => '#',- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
}- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
public static function save(Vtiger_PDF_Model $pdfModel, $step = 1)- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$fields[$field] = $pdfModel->get($field);- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
} else {- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
{- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
* Function transforms Advance filter to workflow conditions.- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$pdfModel->set('conditions', $wfCondition);- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
*- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
break;- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
foreach ($fields as $field) {- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
{- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$fields['type'] = Settings_PDF_Module_Model::getTemplateType($pdfModel);- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
\App\Cache::delete(\get_class($pdfModel), $pdfModel->getId());- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
}- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
} else {- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
*- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$columns = $condition['columns'];- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
if (!empty($columns) && \is_array($columns)) {- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
case 'status':- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$value = $value ? 'FL_ACTIVE' : 'FL_INACTIVE';- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
break;- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
],- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$pdf = new $handlerClass();- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$fields = [];- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$db->createCommand()- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
->update('a_#__pdf', $fields, ['pdfid' => $pdfModel->getId()])- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$stepFields = Settings_PDF_Module_Model::getFieldsByStep($step);- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$db->createCommand()->update('a_#__pdf', $fields, ['pdfid' => $pdfModel->getId()])- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
*- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$db = \App\Db::getInstance('admin');- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
return false;- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
}- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
public function getDisplayValue(string $key)- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
{- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
$value = \App\Pdf\Pdf::getDriverLabel($value);- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
break;- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
switch ($key) {- Exclude checks
Class name "Settings_PDF_Record_Model" is not in camel caps format Open
class Settings_PDF_Record_Model extends Settings_Vtiger_Record_Model- Exclude checks