New in Symplify 5: Public Method Order and External Final in CodingStandard

• 3 min
• Thu, Oct 4, 2018
• X comments

Don't you have this package installed yet?

composer require symplify/coding-standard --dev

Now enjoy the news ↓

1. Consistent Order of Public Methods

  Check the pull-request #1042

There is already a fixer, that takes care of public, protected and private order of class elements - OrderedClassElementsFixer.

Let's take this one step further - to order interface methods. Imagine you have an interface with 2 methods.

<?php

interface SomeInterface
{
    public function firstMethod();

    public function secondMethod();
}

<?php

final class SomeClass implements SomeInterface
{
    public function firstMethod()
    {
    }

    public function secondMethod()
    {
    }
}

All good! Then you implement more of these, and more:

<?php

final class SomeClass implements SomeInterface
{
    public function secondMethod()
    {
    }

    public function firstMethod()
    {
    }
}

When the class is small like this and you have 2 classes in the whole application, nobody cares. But if you implement e.g. PhpCsFixer\Fixer\FixerInterface that has 6 methods and you have 20 Fixer classes with 20 various orders of those methods, it can be really annoying to maintain them.

That's where MethodOrderByTypeFixer brings the order:

# ecs.yml
services:
    Symplify\CodingStandard\Fixer\Order\MethodOrderByTypeFixer:
        method_order_by_type:
            SomeInterfade:
                - 'firstMethod'
                - 'secondMethod'

2. Exclude Classes From ::class

  Check the pull-request #1038

ClassStringToClassConstantFixer takes care of old strings classes to ::class format:

-$this->assertInstanceOf('DateTime', $object);
+$this->assertInstanceOf(DateTime::class, $object);

But sometimes, you want these strings to be strings. Before, you had to exclude manually each such file:

# ecs.yml
parameters:
    skip:
        Symplify\CodingStandard\Fixer\Php\ClassStringToClassConstantFixer:
            - 'src/ThisFile.php'
            - 'src/ThatFile.php'
            - 'src/ThatFileToo.php'

Now you can just exclude this classes:

# ecs.yml
services:
    Symplify\CodingStandard\Fixer\Php\ClassStringToClassConstantFixer:
        allow_classes:
            - 'Error'
            - 'Symfony\Components\Console\*' # fnmatch() support!

3. Final for 3rd Party Classes

  Check the pull-request #1002

If you're strict enough to final or abstract everywhere, you'll love this. Sometimes 3rd party code is not final, but you'd love to never see that class in your code - Abstract Controller, Abstract Doctrine Repository or Abstract Object.

Those abstract classes are full of magic everyone has to remember. What if you could prevent that spreading to your code without constant code-reviews?

Let ForbiddenParentClassSniff do the job:

# ecs.yml
services:
    Symplify\CodingStandard\Sniffs\CleanCode\ForbiddenParentClassSniff:
        forbiddenParentClasses:
            - 'Doctrine\ORM\EntityRepository'

This will prevent over-inheritance and embrace composition - like in Repositories as Services approach:

<?php

use Doctrine\ORM\EntityRepository;

final class ProductRepository extends EntityRepository
{
}

<?php

use Doctrine\ORM\EntityRepository;

final class ProductRepository
{
    /**
     * @var EntityRepository
     */
    private $entityRepository;

    public function __construct(EntityRepository $entityRepository)
    {
        $this->entityRepository = $entityRepository;
    }
}

That's all folks. Happy sniffing!