YetiForceCompany/YetiForceCRM

View on GitHub
modules/Contacts/handlers/DuplicateEmail.php

Summary

Maintainability
A
2 hrs
Test Coverage
F
47%

Function editViewPreSave has a Cognitive Complexity of 12 (exceeds 5 allowed). Consider refactoring.
Open

    public function editViewPreSave(App\EventHandler $eventHandler)
    {
        $recordModel = $eventHandler->getRecordModel();
        $response = ['result' => true];
        $values = [];
Severity: Minor
Found in modules/Contacts/handlers/DuplicateEmail.php - About 1 hr 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 editViewPreSave has 27 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    public function editViewPreSave(App\EventHandler $eventHandler)
    {
        $recordModel = $eventHandler->getRecordModel();
        $response = ['result' => true];
        $values = [];
Severity: Minor
Found in modules/Contacts/handlers/DuplicateEmail.php - About 1 hr to fix

    Missing class import via use statement (line '35', column '26').
    Open

                $queryGenerator = new \App\QueryGenerator($recordModel->getModuleName());

    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 assigning values to variables in if clauses and the like (line '30', column '9').
    Open

        public function editViewPreSave(App\EventHandler $eventHandler)
        {
            $recordModel = $eventHandler->getRecordModel();
            $response = ['result' => true];
            $values = [];

    IfStatementAssignment

    Since: 2.7.0

    Assignments in if clauses and the like are considered a code smell. Assignments in PHP return the right operand as their result. In many cases, this is an expected behavior, but can lead to many difficult to spot bugs, especially when the right operand could result in zero, null or an empty string and the like.

    Example

    class Foo
    {
        public function bar($flag)
        {
            if ($foo = 'bar') { // possible typo
                // ...
            }
            if ($baz = 0) { // always false
                // ...
            }
        }
    }

    Source http://phpmd.org/rules/cleancode.html#ifstatementassignment

    Avoid using static access to class 'App\Language' in method 'editViewPreSave'.
    Open

                        'message' => App\Language::translate('LBL_DUPLICATE_EMAIL_ADDRESS', $recordModel->getModuleName())

    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 setFields from undeclared class \App\QueryGenerator (Did you mean class \Tests\App\QueryGenerator)
    Open

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

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

                if ($queryGenerator->createQuery()->exists()) {

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

                $queryGenerator->setStateCondition('All');

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

                    $queryGenerator->addCondition('id', $recordModel->getId(), 'n', true);

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

                $queryGenerator = new \App\QueryGenerator($recordModel->getModuleName());

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

                    $queryGenerator->addCondition($fieldModel->getName(), $values, 'e', false);

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

    class Contacts_DuplicateEmail_Handler

    The class Contacts_DuplicateEmail_Handler is not named in CamelCase.
    Open

    class Contacts_DuplicateEmail_Handler
    {
        /**
         * EditViewPreSave handler function.
         *

    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

                }

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

         * @return array Example: ['result' => false, 'message' => 'LBL_MESSAGE']

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

            }

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

         * EditViewPreSave handler function.

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

         * @param App\EventHandler $eventHandler

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

            if ($fields && $values) {

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

                $queryGenerator = new \App\QueryGenerator($recordModel->getModuleName());

    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 ($recordModel->getId()) {

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

        public function editViewPreSave(App\EventHandler $eventHandler)

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

                    $values[] = $value;

    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->addCondition($fieldModel->getName(), $values, 'e', false);

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

            $fields = $recordModel->getModule()->getFieldsByType('email', true);

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

                    $queryGenerator->addCondition('id', $recordModel->getId(), 'n', true);

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

                if (($value = $recordModel->get($fieldModel->getName())) && $fieldModel->isViewable()) {

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

        {

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

            $values = [];

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

            foreach ($fields as $fieldModel) {

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

                $queryGenerator->setStateCondition('All');

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

                if ($queryGenerator->createQuery()->exists()) {

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

            $recordModel = $eventHandler->getRecordModel();

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

            $response = ['result' => true];

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

                    $response = [

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

                foreach ($fields as $fieldModel) {

    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

            }

    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->setFields(['id'])->permissions = 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

            return $response;

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

                    ];

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

                        'message' => App\Language::translate('LBL_DUPLICATE_EMAIL_ADDRESS', $recordModel->getModuleName())

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

        }

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

                        'result' => false,

    Class name "Contacts_DuplicateEmail_Handler" is not in camel caps format
    Open

    class Contacts_DuplicateEmail_Handler

    There are no issues that match your filters.

    Category
    Status