Sign upLogin

jon48/webtrees-lib

View on GitHub
Star
app/Module/AdminTasks/Http/RequestHandlers/TaskEditAction.php

Summary

Maintainability
A
3 hrs
Test Coverage

Method updateGeneralSettings has 38 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    private function updateGeneralSettings(TaskSchedule $task_schedule, ServerRequestInterface $request): bool
    {
        if ($this->module === null) {
            return false;
        }
Severity: Minor
Found in app/Module/AdminTasks/Http/RequestHandlers/TaskEditAction.php - About 1 hr to fix

    Method handle has 26 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

        public function handle(ServerRequestInterface $request): ResponseInterface
    {
        if ($this->module === null) {
            FlashMessages::addMessage(
                I18N::translate('The attached module could not be found.'),
    Severity: Minor
    Found in app/Module/AdminTasks/Http/RequestHandlers/TaskEditAction.php - About 1 hr to fix

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

          private function updateGeneralSettings(TaskSchedule $task_schedule, ServerRequestInterface $request): bool
    {
        if ($this->module === null) {
            return false;
        }
      Severity: Minor
      Found in app/Module/AdminTasks/Http/RequestHandlers/TaskEditAction.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

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

      class TaskEditAction implements RequestHandlerInterface
{
    private ?AdminTasksModule $module;
    private TaskScheduleService $taskschedules_service;
      Severity: Minor
      Found in app/Module/AdminTasks/Http/RequestHandlers/TaskEditAction.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 updateGeneralSettings uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them.
      Open

              } else {
            $task_schedule->setRemainingOccurrences(0);
        }
      Severity: Minor
      Found in app/Module/AdminTasks/Http/RequestHandlers/TaskEditAction.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

      Avoid using static access to class '\Fisharebest\Webtrees\I18N' in method 'updateGeneralSettings'.
      Open

              FlashMessages::addMessage(I18N::translate('An error occured while updating the scheduled task.'), 'danger');
      Severity: Minor
      Found in app/Module/AdminTasks/Http/RequestHandlers/TaskEditAction.php by phpmd

      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 '\Fisharebest\Webtrees\FlashMessages' in method 'updateGeneralSettings'.
      Open

                  FlashMessages::addMessage(I18N::translate('The frequency is not in a valid format.'), 'danger');
      Severity: Minor
      Found in app/Module/AdminTasks/Http/RequestHandlers/TaskEditAction.php by phpmd

      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 '\Fisharebest\Webtrees\FlashMessages' in method 'updateGeneralSettings'.
      Open

                      FlashMessages::addMessage(
                    I18N::translate('The number of remaining occurrences is not in a valid format.'),
                    'danger'
                );
      Severity: Minor
      Found in app/Module/AdminTasks/Http/RequestHandlers/TaskEditAction.php by phpmd

      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 '\Fisharebest\Webtrees\FlashMessages' in method 'updateSpecificSettings'.
      Open

                  FlashMessages::addMessage(
                I18N::translate(
                    'An error occured while updating the specific settings of administrative task “%s”.',
                    $task->name()
                ),
      Severity: Minor
      Found in app/Module/AdminTasks/Http/RequestHandlers/TaskEditAction.php by phpmd

      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 '\Fisharebest\Webtrees\Log' in method 'handle'.
      Open

                  Log::addConfigurationLog('Module ' . $this->module->title() . ' : Task Schedule “' . $task_schedule->id() . '” has been updated.');
      Severity: Minor
      Found in app/Module/AdminTasks/Http/RequestHandlers/TaskEditAction.php by phpmd

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

              } else {
            FlashMessages::addMessage(I18N::translate('The frequency is not in a valid format.'), 'danger');
        }
      Severity: Minor
      Found in app/Module/AdminTasks/Http/RequestHandlers/TaskEditAction.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

      Avoid using static access to class '\Fisharebest\Webtrees\Log' in method 'updateSpecificSettings'.
      Open

                  Log::addConfigurationLog('Module ' . $this->module->title() . ' : AdminTask “' . $task->name() . '” specific settings could not be updated. See error log.');
      Severity: Minor
      Found in app/Module/AdminTasks/Http/RequestHandlers/TaskEditAction.php by phpmd

      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 '\Fisharebest\Webtrees\I18N' in method 'handle'.
      Open

                      I18N::translate('The task shedule with ID “%s” does not exist.', I18N::number($task_sched_id)),
      Severity: Minor
      Found in app/Module/AdminTasks/Http/RequestHandlers/TaskEditAction.php by phpmd

      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 '\Fisharebest\Webtrees\I18N' in method 'updateGeneralSettings'.
      Open

                  FlashMessages::addMessage(I18N::translate('The frequency is not in a valid format.'), 'danger');
      Severity: Minor
      Found in app/Module/AdminTasks/Http/RequestHandlers/TaskEditAction.php by phpmd

      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 '\Fisharebest\Webtrees\Log' in method 'updateGeneralSettings'.
      Open

                  Log::addErrorLog(
                sprintf(
                    'Error while updating the Task Schedule "%s". Exception: %s',
                    $task_schedule->id(),
                    $ex->getMessage()
      Severity: Minor
      Found in app/Module/AdminTasks/Http/RequestHandlers/TaskEditAction.php by phpmd

      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 '\Fisharebest\Webtrees\I18N' in method 'handle'.
      Open

                      I18N::translate('The task shedule with ID “%s” does not exist.', I18N::number($task_sched_id)),
      Severity: Minor
      Found in app/Module/AdminTasks/Http/RequestHandlers/TaskEditAction.php by phpmd

      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 '\Fisharebest\Webtrees\FlashMessages' in method 'handle'.
      Open

                  FlashMessages::addMessage(
                I18N::translate('The scheduled task has been successfully updated.'),
                'success'
            );
      Severity: Minor
      Found in app/Module/AdminTasks/Http/RequestHandlers/TaskEditAction.php by phpmd

      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 '\Fisharebest\Webtrees\Log' in method 'updateGeneralSettings'.
      Open

              Log::addConfigurationLog('Module ' . $this->module->title() . ' : Task Schedule “' . $task_schedule->id() . '” could not be updated. See error log.');
      Severity: Minor
      Found in app/Module/AdminTasks/Http/RequestHandlers/TaskEditAction.php by phpmd

      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 '\Fisharebest\Webtrees\I18N' in method 'handle'.
      Open

                      I18N::translate('The attached module could not be found.'),
      Severity: Minor
      Found in app/Module/AdminTasks/Http/RequestHandlers/TaskEditAction.php by phpmd

      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 '\Fisharebest\Webtrees\FlashMessages' in method 'handle'.
      Open

                  FlashMessages::addMessage(
                I18N::translate('The task shedule with ID “%s” does not exist.', I18N::number($task_sched_id)),
                'danger'
            );
      Severity: Minor
      Found in app/Module/AdminTasks/Http/RequestHandlers/TaskEditAction.php by phpmd

      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 '\Fisharebest\Webtrees\I18N' in method 'updateGeneralSettings'.
      Open

                          I18N::translate('The number of remaining occurrences is not in a valid format.'),
      Severity: Minor
      Found in app/Module/AdminTasks/Http/RequestHandlers/TaskEditAction.php by phpmd

      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 '\Fisharebest\Webtrees\FlashMessages' in method 'updateGeneralSettings'.
      Open

              FlashMessages::addMessage(I18N::translate('An error occured while updating the scheduled task.'), 'danger');
      Severity: Minor
      Found in app/Module/AdminTasks/Http/RequestHandlers/TaskEditAction.php by phpmd

      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 '\Fisharebest\Webtrees\FlashMessages' in method 'handle'.
      Open

                  FlashMessages::addMessage(
                I18N::translate('The attached module could not be found.'),
                'danger'
            );
      Severity: Minor
      Found in app/Module/AdminTasks/Http/RequestHandlers/TaskEditAction.php by phpmd

      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 '\Fisharebest\Webtrees\I18N' in method 'handle'.
      Open

                      I18N::translate('The scheduled task has been successfully updated.'),
      Severity: Minor
      Found in app/Module/AdminTasks/Http/RequestHandlers/TaskEditAction.php by phpmd

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

                  } else {
                FlashMessages::addMessage(
                    I18N::translate('The number of remaining occurrences is not in a valid format.'),
                    'danger'
                );
      Severity: Minor
      Found in app/Module/AdminTasks/Http/RequestHandlers/TaskEditAction.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

      Avoid using static access to class '\Fisharebest\Webtrees\I18N' in method 'updateSpecificSettings'.
      Open

                      I18N::translate(
                    'An error occured while updating the specific settings of administrative task “%s”.',
                    $task->name()
                ),
      Severity: Minor
      Found in app/Module/AdminTasks/Http/RequestHandlers/TaskEditAction.php by phpmd

      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 excessively long variable names like $taskschedules_service. Keep variable name length under 20.
      Open

          private TaskScheduleService $taskschedules_service;
      Severity: Minor
      Found in app/Module/AdminTasks/Http/RequestHandlers/TaskEditAction.php by phpmd

      LongVariable

      Since: 0.2

      Detects when a field, formal or local variable is declared with a long name.

      Example

      class Something {
    protected $reallyLongIntName = -3; // VIOLATION - Field
    public static function main( array $interestingArgumentsList[] ) { // VIOLATION - Formal
        $otherReallyLongName = -5; // VIOLATION - Local
        for ($interestingIntIndex = 0; // VIOLATION - For
             $interestingIntIndex < 10;
             $interestingIntIndex++ ) {
        }
    }
}

      Source https://phpmd.org/rules/naming.html#longvariable

      Avoid excessively long variable names like $taskschedules_service. Keep variable name length under 20.
      Open

          public function __construct(ModuleService $module_service, TaskScheduleService $taskschedules_service)
      Severity: Minor
      Found in app/Module/AdminTasks/Http/RequestHandlers/TaskEditAction.php by phpmd

      LongVariable

      Since: 0.2

      Detects when a field, formal or local variable is declared with a long name.

      Example

      class Something {
    protected $reallyLongIntName = -3; // VIOLATION - Field
    public static function main( array $interestingArgumentsList[] ) { // VIOLATION - Formal
        $otherReallyLongName = -5; // VIOLATION - Local
        for ($interestingIntIndex = 0; // VIOLATION - For
             $interestingIntIndex < 10;
             $interestingIntIndex++ ) {
        }
    }
}

      Source https://phpmd.org/rules/naming.html#longvariable

      There are no issues that match your filters.

      Category
      Status