Sign upLogin

atk4/core

View on GitHub
Star
src/ConfigTrait.php

Summary

Maintainability
A
0 mins
Test Coverage

The method _lookupConfigElement has a boolean flag argument $createElements, which is a certain sign of a Single Responsibility Principle violation.
Open

    private function &_lookupConfigElement(string $path, bool $createElements = false)
Severity: Minor
Found in src/ConfigTrait.php by phpmd

BooleanArgumentFlag

Since: 1.4.0

A boolean flag argument is a reliable indicator for a violation of the Single Responsibility Principle (SRP). You can fix this problem by extracting the logic in the boolean flag into its own class or method.

Example

class Foo {
    public function bar($flag = true) {
    }
}

Source https://phpmd.org/rules/cleancode.html#booleanargumentflag

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

            } else {
                // otherwise just assign value
                $pos = $value;
            }
Severity: Minor
Found in src/ConfigTrait.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 '\Symfony\Component\Yaml\Yaml' in method 'readConfig'.
Open

                    $tempConfig = Yaml::parseFile($file);
Severity: Minor
Found in src/ConfigTrait.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

Line exceeds 120 characters; contains 124 characters
Open

     * @return mixed|false Pointer to element in $this->config or false is element don't exist and $createElements === false
Severity: Minor
Found in src/ConfigTrait.php by phpcodesniffer

The method _lookupConfigElement is not named in camelCase.
Open

    private function &_lookupConfigElement(string $path, bool $createElements = false)
    {
        $path = explode('/', $path);
        $pos = &$this->config;
        foreach ($path as $el) {
Severity: Minor
Found in src/ConfigTrait.php by phpmd

CamelCaseMethodName

Since: 0.2

It is considered best practice to use the camelCase notation to name methods.

Example

class ClassName {
    public function get_name() {
    }
}

Source

There are no issues that match your filters.

Category
Status