• Install now

Rule ordered_interfaces

Orders the interfaces in an implements or interface extends clause.

Configuration

case_sensitive

Whether the sorting should be case sensitive.

Allowed types: bool

Default value: false

direction

Which direction the interfaces should be ordered.

Allowed values: 'ascend' and 'descend'

Default value: 'ascend'

order

How the interfaces should be ordered.

Allowed values: 'alpha' and 'length'

Default value: 'alpha'

Examples

Example #1

Default configuration.

--- Original
+++ New
 <?php

-final class ExampleA implements Gamma, Alpha, Beta {}
+final class ExampleA implements Alpha, Beta, Gamma {}

-interface ExampleB extends Gamma, Alpha, Beta {}
+interface ExampleB extends Alpha, Beta, Gamma {}

Example #2

With configuration: ['direction' => 'descend'].

--- Original
+++ New
 <?php

-final class ExampleA implements Gamma, Alpha, Beta {}
+final class ExampleA implements Gamma, Beta, Alpha {}

-interface ExampleB extends Gamma, Alpha, Beta {}
+interface ExampleB extends Gamma, Beta, Alpha {}

Example #3

With configuration: ['order' => 'length'].

--- Original
+++ New
 <?php

-final class ExampleA implements MuchLonger, Short, Longer {}
+final class ExampleA implements Short, Longer, MuchLonger {}

-interface ExampleB extends MuchLonger, Short, Longer {}
+interface ExampleB extends Short, Longer, MuchLonger {}

Example #4

With configuration: ['order' => 'length', 'direction' => 'descend'].

--- Original
+++ New
 <?php

-final class ExampleA implements MuchLonger, Short, Longer {}
+final class ExampleA implements MuchLonger, Longer, Short {}

-interface ExampleB extends MuchLonger, Short, Longer {}
+interface ExampleB extends MuchLonger, Longer, Short {}

Example #5

With configuration: ['order' => 'alpha'].

--- Original
+++ New
 <?php

-final class ExampleA implements IgnorecaseB, IgNoReCaSeA, IgnoreCaseC {}
+final class ExampleA implements IgNoReCaSeA, IgnorecaseB, IgnoreCaseC {}

-interface ExampleB extends IgnorecaseB, IgNoReCaSeA, IgnoreCaseC {}
+interface ExampleB extends IgNoReCaSeA, IgnorecaseB, IgnoreCaseC {}

Example #6

With configuration: ['order' => 'alpha', 'case_sensitive' => true].

--- Original
+++ New
 <?php

-final class ExampleA implements Casesensitivea, CaseSensitiveA, CasesensitiveA {}
+final class ExampleA implements CaseSensitiveA, CasesensitiveA, Casesensitivea {}

-interface ExampleB extends Casesensitivea, CaseSensitiveA, CasesensitiveA {}
+interface ExampleB extends CaseSensitiveA, CasesensitiveA, Casesensitivea {}

References

• Fixer class: PhpCsFixer\Fixer\ClassNotation\OrderedInterfacesFixer

• Test class: PhpCsFixer\Tests\Fixer\ClassNotation\OrderedInterfacesFixerTest

The test class defines officially supported behaviour. Each test case is a part of our backward compatibility promise.