Programming Style Guide

PHP

Function, class and variable nomenclature

• Functions are to be specified in camelCase
• Classes are to be specified in PascalCase
• Variables are to be specified in camelCase
• Constants and to be specified in all capital letters
• Routes are to be defined in lowercase as such: controller/functionality, eg. "item/add"

Spacing and identantion

The project will use Laravel Pint as an automatic code styler for PHP code. Laravel Pint will ensure there is proper spacing and identation. To execute laravel Pint run:

./vendor/bin/pint

If Pint has not been downloaded, run:

composer require laravel/pint --dev

Laravel Pint uses standard PSR-12 for style in PHP. If formatting is carried out manually, refer to the PSR-12 guide.

HTML

We will use Google's HTML/CSS Style Guide

CSS

References

• https://www.php-fig.org/psr/psr-12/
• https://google.github.io/styleguide/htmlcssguide.html