Coding Standards
- File types & encoding
- PHP tags
- Indentation
- Spacing
- Whitespace
- New lines
- File naming
- Class & method naming
- Helper naming
- PHP variable naming
- User defined constants
- PHP constants
- HTML / CSS rules
- PHP CS Fixer
- PHPStan
All PHP files with the exception of view/template files have the extension .php
All view/template files have the extension .twig
Line feeds are handled automatically by Git, the repo is managed using LF. When cloning all line feeds will be converted automatically to your native environment (CRLF for Windows, LF for Mac/Linux).
Short PHP opening tags and ASP tags are not supported. The characters should be lowercase.
<?php
All PHP files must include a closing tag for versions before 2.0. PHP files in and after 2.0 will no longer have a closing tag.
?>
PHP files must be indented using the TAB character. 4 space tabs are not supported.
HTML in template files (.twig) must be indented using 2 spaces, not 4 spaces or TABS. JavaScript must be indented using the TAB character.
IF, WHILE, FOR etc should have a space before and after the brackets.
if () {
if(){
ELSE etc should have a space after and before the curly braces
} else {
}else{
Type casting does NOT have a space before the variable
(int)$var
(int) $var
Setting a variable should always have a space before and after the equals sign
$var = 1;
$var=1;
After any code, but before a new line - there should be no white space. The same is true for an empty line.
After the closing PHP tag it is extremely important to remove any white space.
Opening curly braces do not go onto a new line, they will always have a space before and be on the same line.
1 True Brace Style (1TBS) (WIKI)
if ($my_example == 1) {
class ModelExampleExample extends Model {
public function addExample() {
} else {
if ($my_example == 1)
{
class ModelExampleExample extends Model
{
public function addExample()
{
}
else
{
All files should be in lower case and words separated by an underscore.
Class names and method names should be camel case.
class ModelExampleExample extends Model
public function addExample()
class model_exampleexample extends Model
public function add_example()
A method scope should always be cast.
public function addExample()
function addExample()
Helper function names should be lower case and an underscore used to separate words.
PHP variables should be lower case and an underscore used to separate words.
$var = 123;
$new_var = 12345;
$Var = 123;
$newVar = 12345;
User defined constants are set as upper case.
define('MY_VAR', 'My constant string value');
define('my_var', 'My constant string value');
These types of constant (true,false,null) are set as lower case
$my_var = true;
$my_var = TRUE;
Class names and id's should be hyphenated and not use an underscore
class="my-class"
class="my_class"
Ensure your code adheres to the project's standards effortlessly by utilizing PHP Coding Standards Fixer. The provided configuration allows for automatic code formatting.
If your IDE doesn't already integrate with php-cs-fixer, run it as a standalone tool:
Use the following command to apply code adjustments and align it with the project's Code Standard:
php tools/php-cs-fixer.phar fix -v
Integrating php-cs-fixer into your workflow ensures consistent code formatting, streamlining collaboration and maintaining a clean, standardized codebase.
To preempt common coding mistakes, the code undergoes thorough analysis with the PHPStan code analyzer. If your IDE does not have native integration with PHPStan, you can use it as a standalone tool:
Initiate the following command to analyze your code changes and identify any potential issues:
php tools/phpstan.phar
Leveraging PHPStan enhances code quality by detecting errors and inconsistencies early in the development process. This proactive approach aids in maintaining a robust and error-free codebase.
OpenCart homepage | OpenCart forums | OpenCart blog | How to documents | Newsletter
OpenCart is created under the GNU General Public License version 3 (GPLv3)