VSVverkeerskunde/gvq-api

View on GitHub
src/Quiz/Aggregate/QuizAggregate.php

Summary

Maintainability
A
2 hrs
Test Coverage

Method answerQuestion has 43 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    public function answerQuestion(
        \DateTimeImmutable $answeredOn,
        ?Answer $answer
    ): void {
        if ($this->askingQuestion) {
Severity: Minor
Found in src/Quiz/Aggregate/QuizAggregate.php - About 1 hr to fix

    Function answerQuestion has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring.
    Open

        public function answerQuestion(
            \DateTimeImmutable $answeredOn,
            ?Answer $answer
        ): void {
            if ($this->askingQuestion) {
    Severity: Minor
    Found in src/Quiz/Aggregate/QuizAggregate.php - About 45 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

    The class QuizAggregate has a coupling between objects value of 14. Consider to reduce the number of dependencies under 13.
    Open

    class QuizAggregate extends EventSourcedAggregateRoot
    {
        /**
         * @var Quiz
         */
    Severity: Minor
    Found in src/Quiz/Aggregate/QuizAggregate.php by phpmd

    CouplingBetweenObjects

    Since: 1.1.0

    A class with too many dependencies has negative impacts on several quality aspects of a class. This includes quality criteria like stability, maintainability and understandability

    Example

    class Foo {
        /**
         * @var \foo\bar\X
         */
        private $x = null;
    
        /**
         * @var \foo\bar\Y
         */
        private $y = null;
    
        /**
         * @var \foo\bar\Z
         */
        private $z = null;
    
        public function setFoo(\Foo $foo) {}
        public function setBar(\Bar $bar) {}
        public function setBaz(\Baz $baz) {}
    
        /**
         * @return \SplObjectStorage
         * @throws \OutOfRangeException
         * @throws \InvalidArgumentException
         * @throws \ErrorException
         */
        public function process(\Iterator $it) {}
    
        // ...
    }

    Source https://phpmd.org/rules/design.html#couplingbetweenobjects

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

                } else {
                    $this->apply(
                        new AnsweredCorrect(
                            $this->quiz->getId(),
                            $currentQuestion,
    Severity: Minor
    Found in src/Quiz/Aggregate/QuizAggregate.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

    Opening brace should be on a new line
    Open

        public function registerEmail(Email $email) {

    There are no issues that match your filters.

    Category
    Status