keboola/php-utils

View on GitHub
src/Keboola/Utils/sanitizeColumnName.php

Summary

Maintainability
A
0 mins
Test Coverage

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

function sanitizeColumnName($s, $charlist = '_', $lower = false)

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

Avoid using static access to class '\Keboola\Utils\Sanitizer\ColumnNameSanitizer' in method 'sanitizeColumnName'.
Open

    return ColumnNameSanitizer::sanitize($s, $charlist, $lower);

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 variables with short names like $s. Configured minimum length is 3.
Open

function sanitizeColumnName($s, $charlist = '_', $lower = false)

ShortVariable

Since: 0.2

Detects when a field, local, or parameter has a very short name.

Example

class Something {
    private $q = 15; // VIOLATION - Field
    public static function main( array $as ) { // VIOLATION - Formal
        $r = 20 + $this->q; // VIOLATION - Local
        for (int $i = 0; $i < 10; $i++) { // Not a Violation (inside FOR)
            $r += $this->q;
        }
    }
}

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

There are no issues that match your filters.

Category
Status