modules/OSSMailView/relations/GetAttachments.php
Call to undeclared method \App\Db::createCommand Open
Open
return (bool) \App\Db::getInstance()->createCommand()->update(self::TABLE_NAME,- Exclude checks
Call to undeclared method \App\Db::createCommand Open
Open
return (bool) App\Db::getInstance()->createCommand()->delete(self::TABLE_NAME, [- Exclude checks
Call to method addJoin from undeclared class \App\QueryGenerator (Did you mean class \Tests\App\QueryGenerator) Open
Open
$this->relationModel->getQueryGenerator()- Exclude checks
Define a constant instead of duplicating this literal "ossmailviewid" 3 times. Open
Open
'ossmailviewid' => $sourceRecordId,- 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 "LEFT JOIN" 3 times. Open
Open
->addJoin(['LEFT JOIN', 'vtiger_seattachmentsrel', 'vtiger_seattachmentsrel.crmid = vtiger_notes.notesid'])- 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.
Each class must be in a namespace of at least one level (a top-level vendor name) Open
Open
class OSSMailView_GetAttachments_Relation extends \App\Relation\RelationAbstraction- Exclude checks
The class OSSMailView_GetAttachments_Relation is not named in CamelCase. Open
Open
class OSSMailView_GetAttachments_Relation extends \App\Relation\RelationAbstraction
{
/**
* @var string Name of the table that stores relations.
*/- 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
Only one argument is allowed per line in a multi-line function call Open
Open
['ossmailviewid' => $toRecordId], ['ossmailviewid' => $fromRecordId, 'documentsid' => $relatedRecordId])->execute();- 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
'ossmailviewid' => $sourceRecordId,- 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 Vtiger_Relation_Model::RELATION_M2M;- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
$this->relationModel->getQueryGenerator()- 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 const TABLE_NAME = 'vtiger_ossmailview_files';- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
public function getQuery()- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
->addJoin(['LEFT JOIN', self::TABLE_NAME, self::TABLE_NAME . '.documentsid = vtiger_notes.notesid'])- 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
->addJoin(['LEFT JOIN', 'vtiger_seattachmentsrel', 'vtiger_seattachmentsrel.crmid = vtiger_notes.notesid'])- 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 false;- Exclude checks
Line exceeds 120 characters; contains 126 characters Open
Open
->addNativeCondition([self::TABLE_NAME . '.ossmailviewid' => $this->relationModel->get('parentRecord')->getId()]);- 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 getRelationType(): 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
public function create(int $sourceRecordId, int $destinationRecordId): bool- 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 delete(int $sourceRecordId, int $destinationRecordId): bool- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
['ossmailviewid' => $toRecordId], ['ossmailviewid' => $fromRecordId, 'documentsid' => $relatedRecordId])->execute();- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
* @var string Name of the table that stores relations.- 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
'documentsid' => $destinationRecordId,- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
public function transfer(int $relatedRecordId, int $fromRecordId, int $toRecordId): bool- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
->addNativeCondition([self::TABLE_NAME . '.ossmailviewid' => $this->relationModel->get('parentRecord')->getId()]);- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
{- Exclude checks
Line exceeds 120 characters; contains 124 characters Open
Open
['ossmailviewid' => $toRecordId], ['ossmailviewid' => $fromRecordId, 'documentsid' => $relatedRecordId])->execute();- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
{- Exclude checks
Line exceeds 120 characters; contains 134 characters Open
Open
->addJoin(['LEFT JOIN', 'vtiger_attachments', 'vtiger_seattachmentsrel.attachmentsid = vtiger_attachments.attachmentsid'])- 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 (bool) App\Db::getInstance()->createCommand()->delete(self::TABLE_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
/** {@inheritdoc} */- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
return (bool) \App\Db::getInstance()->createCommand()->update(self::TABLE_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
])->execute();- Exclude checks
Spaces must be used to indent lines; tabs are not allowed Open
Open
->addJoin(['LEFT JOIN', 'vtiger_attachments', 'vtiger_seattachmentsrel.attachmentsid = vtiger_attachments.attachmentsid'])- Exclude checks
Opening parenthesis of a multi-line function call must be the last content on the line Open
Open
return (bool) \App\Db::getInstance()->createCommand()->update(self::TABLE_NAME,- Exclude checks
Closing parenthesis of a multi-line function call must be on a line by itself Open
Open
['ossmailviewid' => $toRecordId], ['ossmailviewid' => $fromRecordId, 'documentsid' => $relatedRecordId])->execute();- Exclude checks
Class name "OSSMailView_GetAttachments_Relation" is not in camel caps format Open
Open
class OSSMailView_GetAttachments_Relation extends \App\Relation\RelationAbstraction- Exclude checks