qcubed/framework

View on GitHub
assets/php/examples/communication/sample_translator.class.php

Summary

Maintainability
A
0 mins
Test Coverage

Missing class import via use statement (line '10', column '14').
Open

        return new QSampleTranslation($strLanguageCode, $strCountryCode);

MissingImport

Since: 2.7.0

Importing all external classes in a file through use statements makes them clearly visible.

Example

function make() {
    return new \stdClass();
}

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

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

        } else {
            // Otherwise, if no translation found, just return the original, untranslated term
            return $strToken;
        }

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

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

            } else {
                $strCode = $strLanguageCode;
            }

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

The method Load is not named in camelCase.
Open

    public static function Load($strLanguageCode = null, $strCountryCode = null) {
        return new QSampleTranslation($strLanguageCode, $strCountryCode);
    }

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

The method TranslateToken is not named in camelCase.
Open

    public function TranslateToken($strToken) {
        if (isset($this->strTranslationArray[$this->strCode]) &&
                isset($this->strTranslationArray[$this->strCode][$strToken])) {
             return $this->strTranslationArray[$this->strCode][$strToken];
        } else {

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

The method Initialize is not named in camelCase.
Open

    public static function Initialize() {
        return self::Load(QApplication::$LanguageCode, QApplication::$CountryCode);
    }

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