Analysis of Coding Conventions for Magento
PHP_CodeSniffer, using a custom coding standard and report, was used to record various coding conventions across 197 PHP projects.
How to read this report
- The graphs for each coding convention show the percentage of each style variation used throughout the project.
- See an overview of the most popular methods for coding conventions in this project
- You can view the raw data used to generate this report, and use it in any way you want.
Conventions
- Adjacent assignments alignedMethod: noValue: 90.97%
- Array end commaMethod: yesValue: 66.41%
- Blank lines at end of control structureMethod: 0Value: 100%
- Blank lines at start of control structureMethod: 0Value: 99.99%
- Brackets around echoed stringsMethod: noValue: 100%
- CamelCase method nameMethod: yesValue: 99.9%
- Class defined in namespaceMethod: yesValue: 100%
- Class has doc commentMethod: noValue: 52.69%
- Class opening brace placementMethod: new lineValue: 100%
- Closure opening brace placementMethod: same lineValue: 100%
- Constant name caseMethod: upperValue: 100%
- Control structure defined inlineMethod: noValue: 100%
- Declarations and side effects mixedMethod: noValue: 99.98%
- EOL charMethod: \nValue: 100%
- File extension for class filesMethod: .phpValue: 100%
- File extension for non-class filesMethod: .phpValue: 100%
- File has doc commentMethod: yesValue: 99.98%
- Function has doc commentMethod: yesValue: 99.99%
- Function opening brace placementMethod: new lineValue: 89.25%
- Inline comment styleMethod: // ...Value: 70.03%
- Line indentMethod: spacesValue: 100%
- Line lengthMethod: 80 or lessValue: 93.91%
- Lowercase filenameMethod: noValue: 98.62%
- Multiple statements on same lineMethod: noValue: 100%
- Number of newlines at EOFMethod: 1Value: 100%
- One class per fileMethod: yesValue: 100%
- PHP closing tag at EOFMethod: noValue: 100%
- PHP constant caseMethod: lowerValue: 100%
- PHP keyword caseMethod: lowerValue: 100%
- PHP short open tag usedMethod: noValue: 100%
- PHP type caseMethod: lowerValue: 99.35%
- PascalCase class nameMethod: yesValue: 100%
- Private method prefixed with underscoreMethod: yesValue: 56.03%
- Short array syntax usedMethod: yesValue: 100%
- Space after operatorMethod: 1Value: 99.78%
- Space before operatorMethod: 1Value: 98.01%
- Spaces after control structure open parenthesisMethod: 0Value: 100%
- Spaces before control structure close parenthesisMethod: 0Value: 100%
- Spacing after cast statementMethod: 0Value: 92.25%
- Spacing after object operatorMethod: 0Value: 100%
- Spacing after string concatMethod: 1Value: 83.42%
- Spacing before object operatorMethod: 0Value: 97.85%
- Spacing before string concatMethod: 1Value: 97.46%
- Use of ELSE IF or ELSEIFMethod: elseifValue: 99.87%
Analysis of Coding Conventions for Magento
Back to topView project specific report
- Agora InvoicingA
- Anchor CMSA
- AsseticA
- Aura.AutoloadA+
- Aura.CliA+
- Aura.Cli_KernelA+
- Aura.DiA+
- Aura.DispatcherA+
- Aura.FilterA+
- Aura.HtmlA+
- Aura.InputA+
- Aura.IntlA+
- Aura.MarshalA+
- Aura.Project_KernelA+
- Aura.RouterA+
- Aura.SessionA+
- Aura.SignalA+
- Aura.SqlA+
- Aura.SqlQueryA+
- Aura.SqlSchemaA
- Aura.UriA+
- Aura.ViewA+
- Aura.WebA+
- Aura.Web_KernelA
- AWS SDK for PHPA
- BehatA+
- BotonomousA+
- BoxA+
- BuzzA
- CakePHPA+
- ChamiloA-
- ChirpA+
- CodeceptionA
- CodeIgniterA
- ComposerA
- concrete5A
- Contao Open Source CMSA-
- Doctrine 2 ORMA+
- Dropbox SDK for PHP 5.3+A
- DrupalA
- DSU Report APA
- eZ Publish 5.x KernelA
- Facebook PHP SDKA
- FakerA
- FastRouteA+
- Faveo Help-deskA
- Faveo ServicedeskA
- FlysystemA+
- FractalA+
- Google APIs Client LibraryA+
- GoutteA
- GuzzleA
- ImagineA+
- JackalopeA+
- Joomla! CMSA
- Klein.phpA+
- Laravel Framework (Kernel)A+
- LatteA
- lessphpA
- MagentoA+
- MediaWikiA
- MockeryA
- MonologA
- MoodleA
- Mustache.phpA+
- NEONA
- Nette Application MVCA
- Nette BootstrapA
- Nette CachingA+
- Nette Component ModelA+
- Nette DatabaseA
- Nette Dependency InjectionA
- Nette Finder: Files SearchingA+
- Nette Forms: greatly facilitates web formsA+
- Nette HTTP ComponentA
- Nette Mail: Sending E-mailsA
- Nette PHP GeneratorA
- Nette PHP ReflectionA
- Nette SafeStream: Atomic OperationsA
- Nette Security: Access ControlA+
- Nette Tester: enjoyable unit testingA
- Nette TokenizerA+
- Nette Utility ClassesA
- OAuth 2.0 ClientA+
- OpenEMRA-
- ownCloudA
- ParsedownA
- PEAR - The PEAR InstallerA
- PhingA+
- phpBBA
- PHP Binance ApiA-
- PHP Coding Standards FixerA+
- phpDocumentorA
- PHPExcelB+
- PHPMailerA+
- PHP MarkdownA-
- PhpMetricsA
- phpMyAdminA
- PHP OAuth 2.0 ServerA+
- PHP ParserB+
- PHPUnitA
- PHP_CodeCoverageA+
- PHP_CodeSnifferA+
- PhredA
- pimcoreA+
- PiwikA
- PPI FrameworkA
- PrestaShopA-
- PropelA+
- PuxA
- PyroCMSB+
- QuickAppsCMSA
- RadPHPA+
- RatchetA
- React.child-processA+
- React.dnsA
- React.event-loopA+
- React.httpA+
- React.http-clientA
- React.promiseA
- React.socketA+
- React.socket-clientA+
- React.streamA+
- Revive AdserverB+
- RoboTaskA+
- RobotLoader: comfortable autoloadingA+
- SabreDAVA
- Scabbia2 PHP Framework CodeA+
- SculpinA
- SilexA+
- SilverStripe FrameworkA-
- Slim FrameworkA+
- SnappyA+
- StashA+
- StringyA+
- SugarCRM CEB-
- Swift MailerA
- Symfony2A
- ThinkUpA-
- Tracy - PHP debuggerA
- TwigA
- TYPO3 CMSA
- WordPressA+
- Yii PHP Framework Version 2A+
- Yii Web Programming FrameworkB+
- Zend Framework.authenticationA+
- Zend Framework.barcodeA+
- Zend Framework.cacheA+
- Zend Framework.captchaA+
- Zend Framework.codeA+
- Zend Framework.configA+
- Zend Framework.consoleA+
- Zend Framework.cryptA+
- Zend Framework.dbA+
- Zend Framework.debugA+
- Zend Framework.diA
- Zend Framework.domA+
- Zend Framework.escaperA+
- Zend Framework.eventmanagerA+
- Zend Framework.feedA+
- Zend Framework.fileA+
- Zend Framework.filterA+
- Zend Framework.formA+
- Zend Framework.httpA+
- Zend Framework.i18nA+
- Zend Framework.i18n-resourcesA+
- Zend Framework.inputfilterA+
- Zend Framework.jsonA
- Zend Framework.loaderA+
- Zend Framework.logA+
- Zend Framework.mailA+
- Zend Framework.mathA+
- Zend Framework.memoryA+
- Zend Framework.mimeA+
- Zend Framework.modulemanagerA+
- Zend Framework.mvcA+
- Zend Framework.navigationA+
- Zend Framework.paginatorA+
- Zend Framework.permissions-aclA+
- Zend Framework.permissions-rbacA+
- Zend Framework.progressbarA+
- Zend Framework.serializerA+
- Zend Framework.serverA+
- Zend Framework.servicemanagerA+
- Zend Framework.sessionA+
- Zend Framework.soapA+
- Zend Framework.stdlibA+
- Zend Framework.tagA+
- Zend Framework.testA+
- Zend Framework.textA+
- Zend Framework.uriA+
- Zend Framework.validatorA+
- Zend Framework.versionA+
- Zend Framework.viewA+
- Zend Framework.xmlrpcA+
- Zend Framework.zendxmlA+
- ZikulaA
Class has doc comment
Does each class have a docblock comment to describe its purpose?
| Key | Method | Use |
|---|---|---|
| no - Most popular method | no | 52.69% |
| yes | yes | 47.31% |
Based on 5,354 classes
Private method prefixed with underscore
Are private methods prefixed with an underscore?
| Key | Method | Use |
|---|---|---|
| no | no | 43.97% |
| yes - Most popular method | yes | 56.03% |
Based on 141 private methods
Array end comma
Does the last item end with a comma in a multi-line array definition?
This project is using the popular method for this convention
| Key | Method | Use |
|---|---|---|
| no | no | 33.59% |
| yes - Most popular method | yes | 66.41% |
Based on 384 array definitions
Inline comment style
What comment style is used for non docblock comments?
This project is using the popular method for this convention
| Key | Method | Use |
|---|---|---|
| # ... | # ... | 0.51% |
| /* ... */ | /* ... */ | 29.46% |
| // ... - Most popular method | // ... | 70.03% |
Based on 3,343 inline comments
Spacing after string concat
How many spaces follow the string concatenation operator?
This project is using the popular method for this convention
| Key | Method | Use |
|---|---|---|
| 0 | 0 | 0.07% |
| 1 - Most popular method | 1 | 83.42% |
| 2 | 2 | 0.02% |
| newline | newline | 16.48% |
Based on 5,466 concat operators
Function opening brace placement
Is the opening brace of a function on the same line as the function keyword or the next line?
This project is using the popular method for this convention
| Key | Method | Use |
|---|---|---|
| new line - Most popular method | new line | 89.25% |
| same line | same line | 10.75% |
Based on 22,075 functions
Adjacent assignments aligned
For a block of assignments, are the assignment operators (equals, plus-equals etc.) aligned?
This project is using the popular method for this convention
| Key | Method | Use |
|---|---|---|
| no - Most popular method | no | 90.97% |
| yes | yes | 9.03% |
Based on 7,252 assignment blocks
Spacing after cast statement
How many spaces are there between a cast statement and the variable?
This project is using the popular method for this convention
| Key | Method | Use |
|---|---|---|
| 0 - Most popular method | 0 | 92.25% |
| 1 | 1 | 7.75% |
Based on 1,754 cast statements
Line length
Including whitespace and comments, how many characters are in non-empty code lines?
This project is using the popular method for this convention
| Key | Method | Use |
|---|---|---|
| 80 or less - Most popular method | 80 or less | 93.91% |
| 81-120 | 81-120 | 6.02% |
| 121-150 | 121-150 | 0.06% |
| 151 or more | 151 or more | 0.02% |
Based on 548,327 lines
Spacing before string concat
How many spaces precede the string concatenation operator?
This project is using the popular method for this convention
| Key | Method | Use |
|---|---|---|
| 0 | 0 | 0.09% |
| 1 - Most popular method | 1 | 97.46% |
| 3 | 3 | 0.02% |
| newline | newline | 2.43% |
Based on 5,466 concat operators
Spacing before object operator
How many spaces precede the object operator (->)?
This project is using the popular method for this convention
| Key | Method | Use |
|---|---|---|
| 0 - Most popular method | 0 | 97.85% |
| newline | newline | 2.15% |
Based on 143,586 object operators
Space before operator
How many spaces precede comparison, arithmetic and assignment operators?
This project is using the popular method for this convention
| Key | Method | Use |
|---|---|---|
| 0 | 0 | 0.02% |
| 1 - Most popular method | 1 | 98.01% |
| 2 | 2 | 0.01% |
| newline | newline | 1.96% |
Based on 9,828 operators
Lowercase filename
Are PHP filenames lowercase?
This project is using the popular method for this convention
| Key | Method | Use |
|---|---|---|
| no - Most popular method | no | 98.62% |
| yes | yes | 1.38% |
Based on 5,429 files
PHP type case
What case are PHP types (int, bool, string) written in?
This project is using the popular method for this convention
| Key | Method | Use |
|---|---|---|
| lower - Most popular method | lower | 99.35% |
| mixed | mixed | 0.65% |
Based on 3,385 PHP types
Space after operator
How many spaces follow comparison, arithmetic and assignment operators?
This project is using the popular method for this convention
| Key | Method | Use |
|---|---|---|
| 1 - Most popular method | 1 | 99.78% |
| Other | other | 0.22% |
Based on 80,753 operators
Use of ELSE IF or ELSEIF
Are elseif statements defined using elseif or else if?
This project is using the popular method for this convention
| Key | Method | Use |
|---|---|---|
| else if | else if | 0.13% |
| elseif - Most popular method | elseif | 99.87% |
Based on 757 elseif statements
CamelCase method name
Are class method names defined using CamelCase?
This project is using the popular method for this convention
| Key | Method | Use |
|---|---|---|
| no | no | 0.1% |
| yes - Most popular method | yes | 99.9% |
Based on 21,202 methods
Declarations and side effects mixed
Do files both declare symbols (classes, functions, constants, etc.) and cause side-effects (e.g. generate output, change .ini settings, etc.)?
This project is using the popular method for this convention
| Key | Method | Use |
|---|---|---|
| no - Most popular method | no | 99.98% |
| yes | yes | 0.02% |
Based on 5,429 files
File has doc comment
Does each PHP file have a docblock comment to describe its purpose?
This project is using the popular method for this convention
| Key | Method | Use |
|---|---|---|
| no | no | 0.02% |
| yes - Most popular method | yes | 99.98% |
Based on 5,429 files
Function has doc comment
Does each function have a docblock comment to describe its purpose?
This project is using the popular method for this convention
| Key | Method | Use |
|---|---|---|
| no | no | 0.01% |
| yes - Most popular method | yes | 99.99% |
Based on 23,917 functions
Blank lines at start of control structure
How many blank lines precede the body of a control structure?
This project is using the popular method for this convention
| Key | Method | Use |
|---|---|---|
| 0 - Most popular method | 0 | 99.99% |
| 1 | 1 | 0.01% |
Based on 24,095 control structures
Spaces after control structure open parenthesis
How many spaces follow the opening parenthesis of a control structure?
This project is using the popular method for this convention
| Key | Method | Use |
|---|---|---|
| 0 - Most popular method | 0 | 100% |
| newline | newline | < 0.01% |
Based on 20,921 control structures
Line indent
Are lines indented using spaces or tabs?
This project is using the popular method for this convention
| Key | Method | Use |
|---|---|---|
| spaces - Most popular method | spaces | 100% |
Based on 477,332 indented lines
Constant name case
What case are user-defined constants defined in?
This project is using the popular method for this convention
| Key | Method | Use |
|---|---|---|
| upper - Most popular method | upper | 100% |
Based on 2,629 constants
One class per file
Is each class defined in a file by itself?
This project is using the popular method for this convention
| Key | Method | Use |
|---|---|---|
| yes - Most popular method | yes | 100% |
Based on 5,354 classes
Number of newlines at EOF
How many newline characters appear at the end of the file?
This project is using the popular method for this convention
| Key | Method | Use |
|---|---|---|
| 1 - Most popular method | 1 | 100% |
Based on 5,429 files
Class opening brace placement
Is the opening brace of a class on the same line as the class keyword or the next line?
This project is using the popular method for this convention
| Key | Method | Use |
|---|---|---|
| new line - Most popular method | new line | 100% |
Based on 5,354 classes
Short array syntax used
Are arrays defined using the PHP 5.4+ short array syntax?
This project is using the popular method for this convention
| Key | Method | Use |
|---|---|---|
| yes - Most popular method | yes | 100% |
Based on 18,729 array definitions
File extension for class files
For files that contain classes, what extension does the file use?
This project is using the popular method for this convention
| Key | Method | Use |
|---|---|---|
| .php - Most popular method | .php | 100% |
Based on 5,354 class files
File extension for non-class files
For files that do not contain classes, what extension does the file use?
This project is using the popular method for this convention
| Key | Method | Use |
|---|---|---|
| .php - Most popular method | .php | 100% |
Based on 75 non-class files
Blank lines at end of control structure
How many blank lines follow the body of a control structure?
This project is using the popular method for this convention
| Key | Method | Use |
|---|---|---|
| 0 - Most popular method | 0 | 100% |
Based on 24,074 control structures
PHP short open tag used
Is the PHP short open tag syntax used?
This project is using the popular method for this convention
| Key | Method | Use |
|---|---|---|
| no - Most popular method | no | 100% |
Based on 5,429 open tags
PascalCase class name
Are class names defined using PascalCase?
This project is using the popular method for this convention
| Key | Method | Use |
|---|---|---|
| yes - Most popular method | yes | 100% |
Based on 5,354 classes
Control structure defined inline
Are control structures defined inline (without braces)?
This project is using the popular method for this convention
| Key | Method | Use |
|---|---|---|
| no - Most popular method | no | 100% |
Based on 22,283 control structures
PHP constant case
What case are PHP constants (true, false, null) written in?
This project is using the popular method for this convention
| Key | Method | Use |
|---|---|---|
| lower - Most popular method | lower | 100% |
Based on 15,734 PHP constants
PHP keyword case
What case are PHP keywords (function, echo, foreach etc.) written in?
This project is using the popular method for this convention
| Key | Method | Use |
|---|---|---|
| lower - Most popular method | lower | 100% |
Based on 144,759 keywords
Closure opening brace placement
Is the opening brace of a closure on the same line as the function keyword or the next line?
This project is using the popular method for this convention
| Key | Method | Use |
|---|---|---|
| same line - Most popular method | same line | 100% |
Based on 27 closures
PHP closing tag at EOF
Is there a PHP closing tag at the end of the file?
This project is using the popular method for this convention
| Key | Method | Use |
|---|---|---|
| no - Most popular method | no | 100% |
Based on 5,429 files
Spaces before control structure close parenthesis
How many spaces precede the closing parenthesis of a control structure?
This project is using the popular method for this convention
| Key | Method | Use |
|---|---|---|
| 0 - Most popular method | 0 | 100% |
Based on 20,921 control structures
Multiple statements on same line
Are multiple statements defined on the same line of code?
This project is using the popular method for this convention
| Key | Method | Use |
|---|---|---|
| no - Most popular method | no | 100% |
Based on 111,146 statements
Spacing after object operator
How many spaces follow the object operator (->)?
This project is using the popular method for this convention
| Key | Method | Use |
|---|---|---|
| 0 - Most popular method | 0 | 100% |
Based on 143,586 object operators
Class defined in namespace
Is each class defined in a namespace of at least 1 level?
This project is using the popular method for this convention
| Key | Method | Use |
|---|---|---|
| yes - Most popular method | yes | 100% |
Based on 5,354 classes
Brackets around echoed strings
Are parenthesis placed around echo'd strings?
This project is using the popular method for this convention
| Key | Method | Use |
|---|---|---|
| no - Most popular method | no | 100% |
Based on 18 echo statements
EOL char
What character is used for line breaks?
This project is using the popular method for this convention
| Key | Method | Use |
|---|---|---|
| \n - Most popular method | \n | 100% |
Based on 5,429 files