phoneburner / coding-standard
PhoneBurner PHP Coding Standards
Installs: 7
Dependents: 3
Suggesters: 0
Security: 0
Stars: 0
Watchers: 2
Forks: 1
Open Issues: 0
Language:Makefile
Type:phpcodesniffer-standard
Requires
- php: ~8.3.0 || ~8.4.0 || ~8.5.0
- dealerdirect/phpcodesniffer-composer-installer: ^1.0
- slevomat/coding-standard: ^8.16
- squizlabs/php_codesniffer: ^3.10
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:
- 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.) - Methods and functions, except for class
__construct
and__destruct
methods, MUST have a defined return type. - Anonymous and arrow functions MUST have a defined parameter and return types.
- Parameters MUST have defined types, unless they are extending/implementing a third-party library method or function that does not allow it.
- Class properties MUST have defined types.
- Enum cases must be in PascalCase, unless they are less than 4 characters long, and do not conflict with class constants.