soliantconsulting/SimpleFM

View on GitHub
src/Repository/Repository.php

Summary

Maintainability
A
35 mins
Test Coverage
A
100%

The class Repository has 12 public methods. Consider refactoring Repository to keep number of public methods under 10.
Open

final class Repository implements RepositoryInterface
{
    /**
     * @var ResultSetClientInterface
     */
Severity: Minor
Found in src/Repository/Repository.php by phpmd

TooManyPublicMethods

Since: 0.1

A class with too many public methods is probably a good suspect for refactoring, in order to reduce its complexity and find a way to have more fine grained objects.

By default it ignores methods starting with 'get' or 'set'.

Example

Source https://phpmd.org/rules/codesize.html#toomanypublicmethods

Method findBy has 5 arguments (exceeds 4 allowed). Consider refactoring.
Open

        array $search,
        array $sort = [],
        int $limit = null,
        int $offset = null,
        bool $autoQuoteSearch = true
Severity: Minor
Found in src/Repository/Repository.php - About 35 mins to fix

    The class Repository has a coupling between objects value of 15. Consider to reduce the number of dependencies under 13.
    Open

    final class Repository implements RepositoryInterface
    {
        /**
         * @var ResultSetClientInterface
         */
    Severity: Minor
    Found in src/Repository/Repository.php by phpmd

    CouplingBetweenObjects

    Since: 1.1.0

    A class with too many dependencies has negative impacts on several quality aspects of a class. This includes quality criteria like stability, maintainability and understandability

    Example

    class Foo {
        /**
         * @var \foo\bar\X
         */
        private $x = null;
    
        /**
         * @var \foo\bar\Y
         */
        private $y = null;
    
        /**
         * @var \foo\bar\Z
         */
        private $z = null;
    
        public function setFoo(\Foo $foo) {}
        public function setBar(\Bar $bar) {}
        public function setBaz(\Baz $baz) {}
    
        /**
         * @return \SplObjectStorage
         * @throws \OutOfRangeException
         * @throws \InvalidArgumentException
         * @throws \ErrorException
         */
        public function process(\Iterator $it) {}
    
        // ...
    }

    Source https://phpmd.org/rules/design.html#couplingbetweenobjects

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

        public function update($entity, bool $force = false)
    Severity: Minor
    Found in src/Repository/Repository.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 findOneBy has a boolean flag argument $autoQuoteSearch, which is a certain sign of a Single Responsibility Principle violation.
    Open

        public function findOneBy(array $search, bool $autoQuoteSearch = true)
    Severity: Minor
    Found in src/Repository/Repository.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 delete has a boolean flag argument $force, which is a certain sign of a Single Responsibility Principle violation.
    Open

        public function delete($entity, bool $force = false)
    Severity: Minor
    Found in src/Repository/Repository.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 findBy has a boolean flag argument $autoQuoteSearch, which is a certain sign of a Single Responsibility Principle violation.
    Open

            bool $autoQuoteSearch = true
    Severity: Minor
    Found in src/Repository/Repository.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

    Avoid using static access to class '\Soliant\SimpleFM\Repository\Exception\InvalidResultException' in method 'persist'.
    Open

                throw InvalidResultException::fromEmptyResultSet();
    Severity: Minor
    Found in src/Repository/Repository.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 createEntity uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them.
    Open

            } else {
                $entity = $this->hydration->hydrateNewEntity($record);
            }
    Severity: Minor
    Found in src/Repository/Repository.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 '\Soliant\SimpleFM\Repository\Exception\DomainException' in method 'createSortParameters'.
    Open

                throw DomainException::fromTooManySortParameters(9, $sort);
    Severity: Minor
    Found in src/Repository/Repository.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 using static access to class '\Soliant\SimpleFM\Repository\Exception\DomainException' in method 'delete'.
    Open

                throw DomainException::fromUnmanagedEntity($entity);
    Severity: Minor
    Found in src/Repository/Repository.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 using static access to class '\Soliant\SimpleFM\Repository\Exception\DomainException' in method 'update'.
    Open

                throw DomainException::fromUnmanagedEntity($entity);
    Severity: Minor
    Found in src/Repository/Repository.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

    There are no issues that match your filters.

    Category
    Status