YetiForceCompany/YetiForceCRM

View on GitHub
modules/com_vtiger_workflow/tasks/VTEmailTemplateTask.php

Summary

Maintainability
C
1 day
Test Coverage
F
0%

Function doTask has a Cognitive Complexity of 39 (exceeds 5 allowed). Consider refactoring.
Open

    public function doTask($recordModel)
    {
        if (!empty($this->template)) {
            $mailerContent = [];
            if (!empty($this->smtp)) {
Severity: Minor
Found in modules/com_vtiger_workflow/tasks/VTEmailTemplateTask.php - About 5 hrs to fix

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 doTask has 63 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    public function doTask($recordModel)
    {
        if (!empty($this->template)) {
            $mailerContent = [];
            if (!empty($this->smtp)) {
Severity: Major
Found in modules/com_vtiger_workflow/tasks/VTEmailTemplateTask.php - About 2 hrs to fix

    The method doTask() has an NPath complexity of 23329. The configured NPath complexity threshold is 200.
    Open

        public function doTask($recordModel)
        {
            if (!empty($this->template)) {
                $mailerContent = [];
                if (!empty($this->smtp)) {

    NPathComplexity

    Since: 0.1

    The NPath complexity of a method is the number of acyclic execution paths through that method. A threshold of 200 is generally considered the point where measures should be taken to reduce complexity.

    Example

    class Foo {
        function bar() {
            // lots of complicated code
        }
    }

    Source https://phpmd.org/rules/codesize.html#npathcomplexity

    The method doTask() has a Cyclomatic Complexity of 21. The configured cyclomatic complexity threshold is 10.
    Open

        public function doTask($recordModel)
        {
            if (!empty($this->template)) {
                $mailerContent = [];
                if (!empty($this->smtp)) {

    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 45 to the 15 allowed.
    Open

        public function doTask($recordModel)

    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 'Vtiger_Record_Model' in method 'doTask'.
    Open

                            $relationListView = Vtiger_RelationListView_Model::getInstance(Vtiger_Record_Model::getInstanceById($recordModel->get($attachmentsInfo[1]), $attachmentsInfo[0]), 'Documents');

    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_RelationListView_Model' in method 'doTask'.
    Open

                    $relationListView = Vtiger_RelationListView_Model::getInstance($recordModel, $relatedModule);

    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\Record' in method 'doTask'.
    Open

                        if (!$recordModel->isEmpty($attachmentsInfo[1]) && App\Record::isExists($recordModel->get($attachmentsInfo[1]), $attachmentsInfo[0])) {

    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\Mailer' in method 'doTask'.
    Open

                \App\Mailer::sendFromTemplate($mailerContent);

    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_RelationListView_Model' in method 'doTask'.
    Open

                            $relationListView = Vtiger_RelationListView_Model::getInstance(Vtiger_Record_Model::getInstanceById($recordModel->get($attachmentsInfo[1]), $attachmentsInfo[0]), 'Documents');

    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_RelationListView_Model' in method 'doTask'.
    Open

                        $relationListView = Vtiger_RelationListView_Model::getInstance($recordModel, 'Documents');

    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\EmailParser' in method 'doTask'.
    Open

                $emailParser = \App\EmailParser::getInstanceByModel($recordModel);

    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 doTask uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them.
    Open

                    } else {
                        $relationListView = Vtiger_RelationListView_Model::getInstance($recordModel, 'Documents');
                    }

    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

    Call to method setFields from undeclared class \App\QueryGenerator (Did you mean class \Tests\App\QueryGenerator)
    Open

                        $queryGenerator->setFields(['id']);

    Reference to undeclared property \VTEmailTemplateTask->template
    Open

            if (!empty($this->template)) {

    Reference to undeclared property \VTEmailTemplateTask->smtp
    Open

                if (!empty($this->smtp)) {

    Static call to undeclared method \App\EmailParser::getInstanceByModel
    Open

                $emailParser = \App\EmailParser::getInstanceByModel($recordModel);

    Reference to undeclared property \VTEmailTemplateTask->address_emails
    Open

                if ($this->address_emails) {

    Reference to undeclared property \VTEmailTemplateTask->relations_email
    Open

                if ($this->relations_email && '-' !== $this->relations_email) {

    Reference to undeclared property \VTEmailTemplateTask->attachments
    Open

                if (!empty($this->attachments)) {

    Reference to undeclared property \VTEmailTemplateTask->email
    Open

                if ($this->email) {

    Reference to undeclared property \VTEmailTemplateTask->email
    Open

                    $email = \is_array($this->email) ? implode(',', $this->email) : $this->email;

    Reference to undeclared property \VTEmailTemplateTask->address_emails
    Open

                    $emails = $emailParser->setContent($this->address_emails)->getContent(true);

    Reference to undeclared property \VTEmailTemplateTask->copy_email
    Open

                if (!empty($this->copy_email)) {

    Reference to undeclared property \VTEmailTemplateTask->attachments
    Open

                    $attachmentsInfo = explode('::', $this->attachments);

    Call to method createQuery from undeclared class \App\QueryGenerator (Did you mean class \Tests\App\QueryGenerator)
    Open

                        $ids = $queryGenerator->createQuery()->column();

    Reference to undeclared property \VTEmailTemplateTask->emailoptout
    Open

                $emailParser->emailoptout = $this->emailoptout ? true : false;

    Call to method setLimit from undeclared class \App\QueryGenerator (Did you mean class \Tests\App\QueryGenerator)
    Open

                        $relationListView->getQueryGenerator()->setLimit(1);

    Reference to undeclared property \VTEmailTemplateTask->smtp
    Open

                    $mailerContent['smtp_id'] = $this->smtp;

    Reference to undeclared property \VTEmailTemplateTask->relations_email
    Open

                    [$relatedModule,$relatedFieldName,$onlyFirst] = array_pad(explode('::', $this->relations_email), 3, false);

    Reference to undeclared property \VTEmailTemplateTask->template
    Open

                $mailerContent['template'] = $this->template;

    Reference to undeclared property \VTEmailTemplateTask->copy_email
    Open

                    $mailerContent['bcc'] = $this->copy_email;

    Each class must be in a namespace of at least one level (a top-level vendor name)
    Open

    class VTEmailTemplateTask extends VTTask

    Spaces must be used to indent lines; tabs are not allowed
    Open

        /** @var bool Sending email takes more time, this should be handled via queue all the time. */

    Spaces must be used to indent lines; tabs are not allowed
    Open

            return ['template', 'email', 'relations_email', 'emailoptout', 'smtp', 'copy_email', 'address_emails', 'attachments'];

    Spaces must be used to indent lines; tabs are not allowed
    Open

                }

    Spaces must be used to indent lines; tabs are not allowed
    Open

                    $email = \is_array($this->email) ? implode(',', $this->email) : $this->email;

    Spaces must be used to indent lines; tabs are not allowed
    Open

                    $relationListView = Vtiger_RelationListView_Model::getInstance($recordModel, $relatedModule);

    Spaces must be used to indent lines; tabs are not allowed
    Open

                    $relationListView->set('search_key', $relatedFieldName);

    Spaces must be used to indent lines; tabs are not allowed
    Open

                    $relationListView->set('operator', 'ny');

    Spaces must be used to indent lines; tabs are not allowed
    Open

                if ('Contacts' === $recordModel->getModuleName() && !$recordModel->isEmpty('notifilanguage')) {

    Spaces must be used to indent lines; tabs are not allowed
    Open

                        }

    Spaces must be used to indent lines; tabs are not allowed
    Open

                \App\Mailer::sendFromTemplate($mailerContent);

    Spaces must be used to indent lines; tabs are not allowed
    Open

            }

    Spaces must be used to indent lines; tabs are not allowed
    Open

        }

    Spaces must be used to indent lines; tabs are not allowed
    Open

                    }

    Spaces must be used to indent lines; tabs are not allowed
    Open

                    [$relatedModule,$relatedFieldName,$onlyFirst] = array_pad(explode('::', $this->relations_email), 3, false);

    Spaces must be used to indent lines; tabs are not allowed
    Open

                        $relationListView = Vtiger_RelationListView_Model::getInstance($recordModel, 'Documents');

    Spaces must be used to indent lines; tabs are not allowed
    Open

         * Execute task.

    Line exceeds 120 characters; contains 155 characters
    Open

                        if (!$recordModel->isEmpty($attachmentsInfo[1]) && App\Record::isExists($recordModel->get($attachmentsInfo[1]), $attachmentsInfo[0])) {

    Spaces must be used to indent lines; tabs are not allowed
    Open

                    if ($relationListView) {

    Spaces must be used to indent lines; tabs are not allowed
    Open

                    }

    Spaces must be used to indent lines; tabs are not allowed
    Open

         *

    Spaces must be used to indent lines; tabs are not allowed
    Open

         *

    Spaces must be used to indent lines; tabs are not allowed
    Open

                if ($this->address_emails) {

    Spaces must be used to indent lines; tabs are not allowed
    Open

                        $mailerContent['to'][] = $email;

    Spaces must be used to indent lines; tabs are not allowed
    Open

         * @param Vtiger_Record_Model $recordModel

    Spaces must be used to indent lines; tabs are not allowed
    Open

                    foreach ($emails as $email) {

    Spaces must be used to indent lines; tabs are not allowed
    Open

                        $mailerContent['attachments'] = ['ids' => $ids];

    Spaces must be used to indent lines; tabs are not allowed
    Open

        /**

    Spaces must be used to indent lines; tabs are not allowed
    Open

        {

    Spaces must be used to indent lines; tabs are not allowed
    Open

                if (!empty($this->smtp)) {

    Spaces must be used to indent lines; tabs are not allowed
    Open

                unset($emailParser);

    Spaces must be used to indent lines; tabs are not allowed
    Open

                if (!empty($this->copy_email)) {

    Spaces must be used to indent lines; tabs are not allowed
    Open

                    $mailerContent['bcc'] = $this->copy_email;

    Spaces must be used to indent lines; tabs are not allowed
    Open

                    $attachmentsInfo = explode('::', $this->attachments);

    Spaces must be used to indent lines; tabs are not allowed
    Open

         */

    Spaces must be used to indent lines; tabs are not allowed
    Open

                    $mailerContent['smtp_id'] = $this->smtp;

    Spaces must be used to indent lines; tabs are not allowed
    Open

                }

    Spaces must be used to indent lines; tabs are not allowed
    Open

                if ($this->relations_email && '-' !== $this->relations_email) {

    Spaces must be used to indent lines; tabs are not allowed
    Open

                    }

    Spaces must be used to indent lines; tabs are not allowed
    Open

                }

    Spaces must be used to indent lines; tabs are not allowed
    Open

                if (empty($mailerContent['to'])) {

    Spaces must be used to indent lines; tabs are not allowed
    Open

                    $relationListView = null;

    Line exceeds 120 characters; contains 199 characters
    Open

                            $relationListView = Vtiger_RelationListView_Model::getInstance(Vtiger_Record_Model::getInstanceById($recordModel->get($attachmentsInfo[1]), $attachmentsInfo[0]), 'Documents');

    Spaces must be used to indent lines; tabs are not allowed
    Open

         * Get field names.

    Line exceeds 120 characters; contains 126 characters
    Open

            return ['template', 'email', 'relations_email', 'emailoptout', 'smtp', 'copy_email', 'address_emails', 'attachments'];

    Spaces must be used to indent lines; tabs are not allowed
    Open

            if (!empty($this->template)) {

    Spaces must be used to indent lines; tabs are not allowed
    Open

                $mailerContent['to'] = [];

    Spaces must be used to indent lines; tabs are not allowed
    Open

                $mailerContent['template'] = $this->template;

    Spaces must be used to indent lines; tabs are not allowed
    Open

                if (!empty($this->attachments)) {

    Spaces must be used to indent lines; tabs are not allowed
    Open

                        $queryGenerator->setFields(['id']);

    Spaces must be used to indent lines; tabs are not allowed
    Open

                }

    Spaces must be used to indent lines; tabs are not allowed
    Open

        /**

    Spaces must be used to indent lines; tabs are not allowed
    Open

                    foreach ($relationListView->getAllEntries() as $relatedRecordModel) {

    Spaces must be used to indent lines; tabs are not allowed
    Open

                }

    Spaces must be used to indent lines; tabs are not allowed
    Open

                        $ids = $queryGenerator->createQuery()->column();

    Spaces must be used to indent lines; tabs are not allowed
    Open

        public $executeImmediately = true;

    Spaces must be used to indent lines; tabs are not allowed
    Open

         * @return string[]

    Spaces must be used to indent lines; tabs are not allowed
    Open

        {

    Spaces must be used to indent lines; tabs are not allowed
    Open

                if ($this->email) {

    Spaces must be used to indent lines; tabs are not allowed
    Open

                }

    Spaces must be used to indent lines; tabs are not allowed
    Open

         */

    Line exceeds 120 characters; contains 123 characters
    Open

                    [$relatedModule,$relatedFieldName,$onlyFirst] = array_pad(explode('::', $this->relations_email), 3, false);

    Spaces must be used to indent lines; tabs are not allowed
    Open

                    if (\count($attachmentsInfo) > 1) {

    Spaces must be used to indent lines; tabs are not allowed
    Open

                    }

    Spaces must be used to indent lines; tabs are not allowed
    Open

                }

    Spaces must be used to indent lines; tabs are not allowed
    Open

                    $ids = [];

    Spaces must be used to indent lines; tabs are not allowed
    Open

                        if (!$recordModel->isEmpty($attachmentsInfo[1]) && App\Record::isExists($recordModel->get($attachmentsInfo[1]), $attachmentsInfo[0])) {

    Spaces must be used to indent lines; tabs are not allowed
    Open

        }

    Spaces must be used to indent lines; tabs are not allowed
    Open

                        $queryGenerator = $relationListView->getRelationQuery(true);

    Spaces must be used to indent lines; tabs are not allowed
    Open

        public function doTask($recordModel)

    Spaces must be used to indent lines; tabs are not allowed
    Open

                $emailParser = \App\EmailParser::getInstanceByModel($recordModel);

    Spaces must be used to indent lines; tabs are not allowed
    Open

                $emailParser->emailoptout = $this->emailoptout ? true : false;

    Spaces must be used to indent lines; tabs are not allowed
    Open

                }

    Spaces must be used to indent lines; tabs are not allowed
    Open

                    $relationListView->setFields(['id', $relatedFieldName]);

    Spaces must be used to indent lines; tabs are not allowed
    Open

                    return false;

    Spaces must be used to indent lines; tabs are not allowed
    Open

        public function getFieldNames()

    Spaces must be used to indent lines; tabs are not allowed
    Open

                    $mailerContent['to'] = $emailParser->setContent($email)->parse()->getContent(true);

    Spaces must be used to indent lines; tabs are not allowed
    Open

                        $mailerContent['to'][] = $relatedRecordModel->get($relatedFieldName);

    Spaces must be used to indent lines; tabs are not allowed
    Open

                            $relationListView = Vtiger_RelationListView_Model::getInstance(Vtiger_Record_Model::getInstanceById($recordModel->get($attachmentsInfo[1]), $attachmentsInfo[0]), 'Documents');

    Spaces must be used to indent lines; tabs are not allowed
    Open

                    } else {

    Spaces must be used to indent lines; tabs are not allowed
    Open

                $mailerContent = [];

    Spaces must be used to indent lines; tabs are not allowed
    Open

                    $emails = $emailParser->setContent($this->address_emails)->getContent(true);

    Spaces must be used to indent lines; tabs are not allowed
    Open

                $mailerContent['recordModel'] = $recordModel;

    Spaces must be used to indent lines; tabs are not allowed
    Open

                    if ($onlyFirst) {

    Spaces must be used to indent lines; tabs are not allowed
    Open

                        $relationListView->getQueryGenerator()->setLimit(1);

    Spaces must be used to indent lines; tabs are not allowed
    Open

                    $mailerContent['language'] = $recordModel->get('notifilanguage');

    Spaces must be used to indent lines; tabs are not allowed
    Open

                    }

    There are no issues that match your filters.

    Category
    Status