iranianpep/code-jetter

View on GitHub
components/user/models/User.php

Summary

Maintainability
C
1 day
Test Coverage

User has 24 functions (exceeds 20 allowed). Consider refactoring.
Open

abstract class User extends BaseModel
{
    protected $name;
    protected $username;
    protected $email;
Severity: Minor
Found in components/user/models/User.php - About 2 hrs to fix

    Method checkTokenIsValidByEmail has 49 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

        public function checkTokenIsValidByEmail($email, $token)
        {
            $output = new Output();
    
            /**
    Severity: Minor
    Found in components/user/models/User.php - About 1 hr to fix

      Method login has 28 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

          public function login($key, $value, $password)
          {
              // determine which mapper should be called
              $mapperName = $this->getMapperName();
      
      
      Severity: Minor
      Found in components/user/models/User.php - About 1 hr to fix

        Method forgotPassword has 27 lines of code (exceeds 25 allowed). Consider refactoring.
        Open

            public function forgotPassword($email)
            {
                /**
                 * Start validating email.
                 */
        Severity: Minor
        Found in components/user/models/User.php - About 1 hr to fix

          Method resetPassword has 27 lines of code (exceeds 25 allowed). Consider refactoring.
          Open

              public function resetPassword($email, $resetPasswordToken, $password, $passwordConfirmation)
              {
                  /**
                   * Start validating email & token.
                   */
          Severity: Minor
          Found in components/user/models/User.php - About 1 hr to fix

            Function login has a Cognitive Complexity of 9 (exceeds 5 allowed). Consider refactoring.
            Open

                public function login($key, $value, $password)
                {
                    // determine which mapper should be called
                    $mapperName = $this->getMapperName();
            
            
            Severity: Minor
            Found in components/user/models/User.php - About 55 mins 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

            Function checkTokenIsValidByEmail has a Cognitive Complexity of 9 (exceeds 5 allowed). Consider refactoring.
            Open

                public function checkTokenIsValidByEmail($email, $token)
                {
                    $output = new Output();
            
                    /**
            Severity: Minor
            Found in components/user/models/User.php - About 55 mins 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

            Avoid too many return statements within this method.
            Open

                    return $output;
            Severity: Major
            Found in components/user/models/User.php - About 30 mins to fix

              Avoid too many return statements within this method.
              Open

                      return (new UserAuthentication())->forgetPassword($user);
              Severity: Major
              Found in components/user/models/User.php - About 30 mins to fix

                Avoid too many return statements within this method.
                Open

                        return (new UserAuthentication())->resetPassword($user, $resetPasswordToken, $password, $passwordConfirmation);
                Severity: Major
                Found in components/user/models/User.php - About 30 mins to fix

                  Avoid too many return statements within this method.
                  Open

                              return $output;
                  Severity: Major
                  Found in components/user/models/User.php - About 30 mins to fix

                    Missing class import via use statement (line '226', column '27').
                    Open

                                    throw new \Exception("key: {$key} is not a valid user property");
                    Severity: Minor
                    Found in components/user/models/User.php by phpmd

                    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

                    The method checkTokenIsValidByEmail uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them.
                    Open

                            } else {
                                $tokenExpired = true;
                            }
                    Severity: Minor
                    Found in components/user/models/User.php by phpmd

                    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

                    The method checkTokenIsValidByEmail uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them.
                    Open

                            } else {
                                $output->setSuccess(false);
                                $output->setMessage('Token is expired');
                            }
                    Severity: Minor
                    Found in components/user/models/User.php by phpmd

                    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

                    Identical blocks of code found in 2 locations. Consider refactoring.
                    Open

                            if ($user->getToken() === $token) {
                                // check token lifetime
                                $tokenGeneratedAt = $user->getTokenGeneratedAt();
                                $tokenLivedTime = time() - strtotime($tokenGeneratedAt);
                    
                    
                    Severity: Minor
                    Found in components/user/models/User.php and 1 other location - About 50 mins to fix
                    components/user/services/UserAuthentication.php on lines 322..331

                    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 97.

                    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

                    Further Reading

                    A file should declare new symbols (classes, functions, constants, etc.) and cause no other side effects, or it should execute logic with side effects, but should not do both. The first symbol is defined on line 27 and the first side effect is on line 21.
                    Open

                    <?php

                    There are no issues that match your filters.

                    Category
                    Status