ischenko/yii2-jsloader-requirejs

View on GitHub
src/RequireJs.php

Summary

Maintainability
A
1 hr
Test Coverage

Function doRender has a Cognitive Complexity of 10 (exceeds 5 allowed). Consider refactoring.
Open

    protected function doRender(array $jsExpressions)
    {
        $resultJsCode = '';

        krsort($jsExpressions);
Severity: Minor
Found in src/RequireJs.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

Remove error control operator '@' on line 175.
Open

    private function writeFileContent($filePath, $content)
    {
        if (!file_exists($filePath)) {
            if (@file_put_contents($filePath, $content, LOCK_EX) === false) {
                throw new RuntimeException("Failed to write data into a file \"$filePath\"");
Severity: Minor
Found in src/RequireJs.php by phpmd

ErrorControlOperator

Error suppression should be avoided if possible as it doesn't just suppress the error, that you are trying to stop, but will also suppress errors that you didn't predict would ever occur. Consider changing error_reporting() level and/or setting up your own error handler.

Example

function foo($filePath) {
    $file = @fopen($filPath); // hides exceptions
    $key = @$array[$notExistingKey]; // assigns null to $key
}

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

Avoid using static access to class '\yii\helpers\Json' in method 'renderRequireConfig'.
Open

        $config = Json::encode((object)array_filter($config), $jsonOptions);
Severity: Minor
Found in src/RequireJs.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 assigning values to variables in if clauses and the like (line '194', column '19').
Open

    private function resolveMainScript($main, $code): string
    {
        if (is_callable($main)) {
            $main = call_user_func($main, $code, $this);
        }
Severity: Minor
Found in src/RequireJs.php by phpmd

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 '\yii\di\Instance' in method 'init'.
Open

        $this->renderer = Instance::ensure($this->renderer, JsRendererInterface::class);
Severity: Minor
Found in src/RequireJs.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 publishRequireJs uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them.
Open

        } else {
            $requireOptions['async'] = 'async';
            $requireOptions['defer'] = 'defer';

            $main = $this->resolveMainScript($this->main, "{$requireConfig};\n{$code}");
Severity: Minor
Found in src/RequireJs.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

Possibly zero references to protected method \ischenko\yii2\jsloader\RequireJs::doRender()
Open

    protected function doRender(array $jsExpressions)
Severity: Minor
Found in src/RequireJs.php by phan

Possibly zero write references to public property \ischenko\yii2\jsloader\RequireJs->libraryPath
Open

    public $libraryPath = '@bower/requirejs/require.js';
Severity: Minor
Found in src/RequireJs.php by phan

Possibly zero references to public method \ischenko\yii2\jsloader\RequireJs::init()
Open

    public function init()
Severity: Minor
Found in src/RequireJs.php by phan

Doc-block of getConfig contains declared return type \ischenko\yii2\jsloader\requirejs\Config which is incompatible with the return type \ischenko\yii2\jsloader\ConfigInterface declared in the signature
Open

     * @return Config
Severity: Minor
Found in src/RequireJs.php by phan

Possibly zero write references to public property \ischenko\yii2\jsloader\RequireJs->main
Open

    public $main;
Severity: Minor
Found in src/RequireJs.php by phan

There are no issues that match your filters.

Category
Status