rogervila/provably-fair

View on GitHub
src/ProvablyFair.php

Summary

Maintainability
A
0 mins
Test Coverage

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

    public function generate(int $amount, bool $include_original = false): array
Severity: Minor
Found in src/ProvablyFair.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 parameter $include_original is not named in camelCase.
Open

    public function generate(int $amount, bool $include_original = false): array
    {
        $serverSeed = $this->serverSeed;
        $results = $include_original
            ? [new Result(
Severity: Minor
Found in src/ProvablyFair.php by phpmd

CamelCaseParameterName

Since: 0.2

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

Example

class ClassName {
    public function doSomething($user_name) {
    }
}

Source

Line indented incorrectly; expected 4 spaces, found 8
Open

        public readonly SeedInterface $serverSeed,
Severity: Minor
Found in src/ProvablyFair.php by phpcodesniffer

Line indented incorrectly; expected 4 spaces, found 8
Open

        public readonly AlgorithmInterface $algorithm,
Severity: Minor
Found in src/ProvablyFair.php by phpcodesniffer

Line indented incorrectly; expected 4 spaces, found 8
Open

        public readonly SeedInterface $clientSeed,
Severity: Minor
Found in src/ProvablyFair.php by phpcodesniffer

The variable $include_original is not named in camelCase.
Open

    public function generate(int $amount, bool $include_original = false): array
    {
        $serverSeed = $this->serverSeed;
        $results = $include_original
            ? [new Result(
Severity: Minor
Found in src/ProvablyFair.php by phpmd

CamelCaseVariableName

Since: 0.2

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

Example

class ClassName {
    public function doSomething() {
        $data_module = new DataModule();
    }
}

Source

The variable $include_original is not named in camelCase.
Open

    public function generate(int $amount, bool $include_original = false): array
    {
        $serverSeed = $this->serverSeed;
        $results = $include_original
            ? [new Result(
Severity: Minor
Found in src/ProvablyFair.php by phpmd

CamelCaseVariableName

Since: 0.2

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

Example

class ClassName {
    public function doSomething() {
        $data_module = new DataModule();
    }
}

Source

There are no issues that match your filters.

Category
Status