modules/Vtiger/inventoryfields/Comment.php
The method getListViewDisplayValue has a boolean flag argument $rawText, which is a certain sign of a Single Responsibility Principle violation. Open
Open
public function getListViewDisplayValue($value, array $rowData = [], bool $rawText = false)- Read upRead up
- Exclude checks
BooleanArgumentFlag
Since: 1.4.0
A boolean flag argument is a reliable indicator for a violation of the Single Responsibility Principle (SRP). You can fix this problem by extracting the logic in the boolean flag into its own class or method.
Example
class Foo {
public function bar($flag = true) {
}
}Source https://phpmd.org/rules/cleancode.html#booleanargumentflag
The method getDisplayValue has a boolean flag argument $rawText, which is a certain sign of a Single Responsibility Principle violation. Open
Open
public function getDisplayValue($value, array $rowData = [], bool $rawText = false)- Read upRead up
- Exclude checks
BooleanArgumentFlag
Since: 1.4.0
A boolean flag argument is a reliable indicator for a violation of the Single Responsibility Principle (SRP). You can fix this problem by extracting the logic in the boolean flag into its own class or method.
Example
class Foo {
public function bar($flag = true) {
}
}Source https://phpmd.org/rules/cleancode.html#booleanargumentflag
Missing class import via use statement (line '95', column '14'). Open
Open
throw new \App\Exceptions\Security("ERR_ILLEGAL_FIELD_VALUE||$columnName||$value", 406);- Read upRead up
- Exclude checks
MissingImport
Since: 2.7.0
Importing all external classes in a file through use statements makes them clearly visible.
Example
function make() {
return new \stdClass();
}Source http://phpmd.org/rules/cleancode.html#MissingImport
Avoid using static access to class '\App\Purifier' in method 'getDBValue'. Open
Open
return \App\Utils\Completions::encodeAll(\App\Purifier::decodeHtml($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\Config' in method 'getDisplayValue'. Open
Open
$conf = App\Config::module($this->getModuleName(), 'inventoryCommentIframeContent', null);- 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 'getValue'. Open
Open
return \App\Utils\Completions::encode(\App\Purifier::decodeHtml($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\Utils\Completions' in method 'getListViewDisplayValue'. Open
Open
$value = \App\Utils\Completions::decode(\App\Purifier::purifyHtml($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\Purifier' in method 'getListViewDisplayValue'. Open
Open
$value = \App\Utils\Completions::decode(\App\Purifier::purifyHtml($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\Layout' in method 'getDisplayValue'. Open
Open
return \App\Layout::truncateHtml($value, 'mini', 300);- 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\Layout' in method 'getListViewDisplayValue'. Open
Open
return $rawText ? $value : \App\Layout::truncateHtml($value, 'mini', 50);- 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\Utils\Completions' in method 'getValue'. Open
Open
return \App\Utils\Completions::encode(\App\Purifier::decodeHtml($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\Layout' in method 'getDisplayValue'. Open
Open
return $rawText ? $value : \App\Layout::truncateHtml($value, 'full');- 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\Utils\Completions' in method 'getDBValue'. Open
Open
return \App\Utils\Completions::encodeAll(\App\Purifier::decodeHtml($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\Utils\Completions' in method 'getDisplayValue'. Open
Open
$value = \App\Utils\Completions::decode(\App\Purifier::purifyHtml($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\Purifier' in method 'getDisplayValue'. Open
Open
$value = \App\Utils\Completions::decode(\App\Purifier::purifyHtml($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
Call to method decode from undeclared class \App\Utils\Completions Open
Open
$value = \App\Utils\Completions::decode(\App\Purifier::purifyHtml($value));- Exclude checks
Call to method encodeAll from undeclared class \App\Utils\Completions Open
Open
return \App\Utils\Completions::encodeAll(\App\Purifier::decodeHtml($value));- Exclude checks
Call to method decode from undeclared class \App\Utils\Completions Open
Open
$value = \App\Utils\Completions::decode(\App\Purifier::purifyHtml($value));- Exclude checks
Argument 1 (string) is \type but \App\Purifier::decodeHtml() takes string defined at /code/app/Purifier.php:604 Open
Open
return \App\Utils\Completions::encode(\App\Purifier::decodeHtml($value));- Exclude checks
Call to method encode from undeclared class \App\Utils\Completions Open
Open
return \App\Utils\Completions::encode(\App\Purifier::decodeHtml($value));- Exclude checks
Each class must be in a namespace of at least one level (a top-level vendor name) Open
Open
class Vtiger_Comment_InventoryField extends Vtiger_Basic_InventoryField- Exclude checks
The class Vtiger_Comment_InventoryField is not named in CamelCase. Open
Open
class Vtiger_Comment_InventoryField extends Vtiger_Basic_InventoryField
{
/** {@inheritdoc} */
protected $type = 'Comment';
/** {@inheritdoc} */- 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
Open
/** {@inheritdoc} */- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
protected $onlyOne = 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
{- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
return $this->getParamsConfig()['height'] ?? 50;- 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
/** {@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
{- 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
public function getValue($value)- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
public function getEditTemplateName()- 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
$value = \App\Utils\Completions::decode(\App\Purifier::purifyHtml($value));- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
return $rawText ? $value : \App\Layout::truncateHtml($value, 'mini', 50);- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
public function getDBValue($value, ?string $name = '')- 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
return 'inventoryTypes/Comment.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
{- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
throw new \App\Exceptions\Security("ERR_ILLEGAL_FIELD_VALUE||$columnName||$value", 406);- 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
$value = $this->getDefaultValue();- 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
protected $dbType = 'text';- 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
public function getWidth(): int- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
if (!\is_string($value)) {- 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
$value = \App\Utils\Completions::decode(\App\Purifier::purifyHtml($value));- 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 \App\Utils\Completions::encode(\App\Purifier::decodeHtml($value));- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
protected $type = 'Comment';- 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
/** {@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
}- 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
* Get isOpened param.- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
public function isOpened(): bool- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
return \App\Layout::truncateHtml($value, 'mini', 300);- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
protected $columnName = 'comment';- 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
protected $params = ['width', 'height'];- 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
/** {@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
{- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
return $this->getParamsConfig()['isOpened'] ?? false;- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
protected $defaultLabel = 'LBL_COMMENT';- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
protected $colSpan = 0;- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
return $this->getParamsConfig()['width'] ?? 100;- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
return $rawText ? $value : \App\Layout::truncateHtml($value, 'full');- 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 function getHeight(): int- 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
$conf = App\Config::module($this->getModuleName(), 'inventoryCommentIframeContent', null);- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
if (!$rawText && false !== $conf) {- 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
/** {@inheritdoc} */- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
* Get width.- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
* @return int- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
* @return bool- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
public function getDisplayValue($value, array $rowData = [], bool $rawText = false)- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
public function getListViewDisplayValue($value, array $rowData = [], bool $rawText = false)- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
if ('' == $value) {- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
protected $blocks = [2];- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
protected $purifyType = \App\Purifier::HTML;- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
public function validate($value, string $columnName, bool $isUserFormat, $originalValue = null)- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
return \App\Utils\Completions::encodeAll(\App\Purifier::decodeHtml($value));- 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
* @return int- 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 $isVisible = false;- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
* Get height.- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
{- Exclude checks
Class name "Vtiger_Comment_InventoryField" is not in camel caps format Open
Open
class Vtiger_Comment_InventoryField extends Vtiger_Basic_InventoryField- Exclude checks