phoneburner/coding-standard

PhoneBurner PHP Coding Standards

Maintainers

Details

github.com/phoneburner/php-coding-standard

Source

Issues

Installs: 614

Dependents: 5

Suggesters: 0

Security: 0

Stars: 0

Watchers: 2

Forks: 1

Open Issues: 0

Language:Makefile

Type:phpcodesniffer-standard

pkg:composer/phoneburner/coding-standard

v1.0.1 2025-08-05 20:37 UTC

Requires

MIT ca5baa0acd59a554d06717e44225dc055ef8410a

This package is auto-updated.

Last update: 2025-10-05 20:57:29 UTC

README

Custom PHP_CodeSniffer rules for PhoneBurner projects based on the PER Coding Style 2.0 standard, and using customized rules from the Slevomat Coding Standard project.

Installation and Contributing

This is a dockerized project, with a Makefile to help with common tasks. To get started, clone the repository and run the following command to install the dependencies:

make

Standards:

  1. Variables should be in snake_case unless they are shadowing parameters defined in function or method from a third-party library. This caveat is intended to prevent problems with named parameters, and vendor compatibility.)
  2. Methods and functions, except for class __construct and __destruct methods, MUST have a defined return type.
  3. Anonymous and arrow functions MUST have a defined parameter and return types.
  4. Parameters MUST have defined types, unless they are extending/implementing a third-party library method or function that does not allow it.
  5. Class properties MUST have defined types.
  6. Enum cases must be in PascalCase, unless they are less than 4 characters long, and do not conflict with class constants.