PHP_CodeSniffer standard enforcing:

• Consistent naming conventions for local variables and function/method parameters (configurable: snakeCase or camelCase)
• PHPUnit data provider naming conventions and organization

composer require --dev drevops/phpcs-standard

The standard is automatically registered via phpcodesniffer-composer-installer.

Verify: vendor/bin/phpcs -i (should list DrevOps)

# Check code vendor/bin/phpcs --standard=DrevOps path/to/code # Auto-fix vendor/bin/phpcbf --standard=DrevOps path/to/code

Create phpcs.xml:

<?xml version="1.0"?> <rulesetname="Project Standards"> <ruleref="DrevOps"/> <file>src</file> <file>tests</file> </ruleset>

Use individual sniffs:

<rulesetname="Custom Standards"> <!-- Naming Conventions --> <ruleref="DrevOps.NamingConventions.LocalVariableNaming"/> <ruleref="DrevOps.NamingConventions.ParameterNaming"/> <!-- Testing Practices --> <ruleref="DrevOps.TestingPractices.DataProviderPrefix"/> <ruleref="DrevOps.TestingPractices.DataProviderMatchesTestName"/> <ruleref="DrevOps.TestingPractices.DataProviderOrder"/> </ruleset>

By default, both sniffs enforce snakeCase. Configure to use camelCase:

<rulesetname="Custom Standards"> <ruleref="DrevOps.NamingConventions.LocalVariableNaming"> <properties> <propertyname="format"value="camelCase"/> </properties> </rule> <ruleref="DrevOps.NamingConventions.ParameterNaming"> <properties> <propertyname="format"value="camelCase"/> </properties> </rule> </ruleset>

Enforces consistent naming convention for local variables inside functions/methods.

With snakeCase (default):

functionprocessOrder(){$order_id = 1; // ✓ Valid$orderId = 1; // ✗ Error: NotSnakeCase }

With camelCase:

functionprocessOrder(){$orderId = 1; // ✓ Valid$order_id = 1; // ✗ Error: NotCamelCase }

Excludes:

• Function/method parameters (handled by ParameterNaming)
• Class properties (not enforced)
• Reserved variables ($this, $_GET, $_POST, etc.)

• DrevOps.NamingConventions.LocalVariableNaming.NotSnakeCase (when format="snakeCase")
• DrevOps.NamingConventions.LocalVariableNaming.NotCamelCase (when format="camelCase")

// phpcs:ignore DrevOps.NamingConventions.LocalVariableNaming.NotSnakeCase$myVariable = 'value';

Enforces consistent naming convention for function/method parameters.

With snakeCase (default):

function processOrder($order_id, $user_data){// ✓ Validfunction processOrder($orderId, $userData){// ✗ Error: NotSnakeCase

With camelCase:

function processOrder($orderId, $userData){// ✓ Validfunction processOrder($order_id, $user_data){// ✗ Error: NotCamelCase

Excludes:

• Parameters inherited from interfaces/parent classes
• Parameters in interface/abstract method declarations
• Class properties (including promoted constructor properties)

• DrevOps.NamingConventions.ParameterNaming.NotSnakeCase (when format="snakeCase")
• DrevOps.NamingConventions.ParameterNaming.NotCamelCase (when format="camelCase")

// phpcs:ignore DrevOps.NamingConventions.ParameterNaming.NotSnakeCasefunctionprocess($legacyParam){}

Enforces consistent naming prefix for PHPUnit data provider methods.

class MyTest extends TestCase{/** * @dataProvider dataProviderUserLogin */publicfunctiontestUserLogin($data){} publicfunctiondataProviderUserLogin(){// ✓ Validreturn []} publicfunctionproviderUserLogin(){// ✗ Error: InvalidPrefixreturn []} }

Customize the required prefix:

<ruleref="DrevOps.TestingPractices.DataProviderPrefix"> <properties> <propertyname="prefix"value="dataProvider"/> </properties> </rule>

DrevOps.TestingPractices.DataProviderPrefix.InvalidPrefix

// phpcs:ignore DrevOps.TestingPractices.DataProviderPrefix.InvalidPrefixpublicfunctionproviderCustom(){}

This sniff supports auto-fixing with phpcbf:

• Renames provider methods to use the correct prefix
• Updates all @dataProvider annotations to reference the new name

Ensures data provider method names match their test method names.

class MyTest extends TestCase{/** * @dataProvider dataProviderUserLogin */publicfunctiontestUserLogin($data){} publicfunctiondataProviderUserLogin(){// ✓ Valid - ends with "UserLogin"return []} publicfunctiondataProviderLogin(){// ✗ Error: InvalidProviderNamereturn []; // Expected: ends with "UserLogin" } }

Supported formats:

• @dataProvider annotations
• #[DataProvider('methodName')] attributes (PHP 8+)

Excludes:

• External providers (ClassName::methodName)
• Non-test methods
• Non-test classes

DrevOps.TestingPractices.DataProviderMatchesTestName.InvalidProviderName

// phpcs:ignore DrevOps.TestingPractices.DataProviderMatchesTestName.InvalidProviderNamepublicfunctiondataProviderCustomName(){}

Enforces structural organization of test and data provider methods.

class MyTest extends TestCase{// ✓ Valid - provider after test (default)/** * @dataProvider dataProviderUserLogin */publicfunctiontestUserLogin($data){} publicfunctiondataProviderUserLogin(){return []} }

Helper methods between tests and providers are allowed:

class MyTest extends TestCase{/** * @dataProvider dataProviderUserLogin */publicfunctiontestUserLogin($data){} privatefunctionhelperMethod(){} // ✓ AllowedpublicfunctiondataProviderUserLogin(){return []} }

Reverse the ordering (provider before test):

<ruleref="DrevOps.TestingPractices.DataProviderOrder"> <properties> <propertyname="providerPosition"value="before"/> </properties> </rule>

Options:

• after (default) - Providers must appear after their test methods
• before - Providers must appear before their test methods

• DrevOps.TestingPractices.DataProviderOrder.ProviderBeforeTest - Provider appears before test (when providerPosition="after")
• DrevOps.TestingPractices.DataProviderOrder.ProviderAfterTest - Provider appears after test (when providerPosition="before")

// phpcs:ignore DrevOps.TestingPractices.DataProviderOrder.ProviderBeforeTestpublicfunctiondataProviderUserLogin(){}

composer install # Install dependencies composer test# Run tests composer test-coverage # Run tests with coverage composer lint # Check code standards composer lint-fix # Fix code standards

GPL-3.0-or-later

This repository was created using the Scaffold project template