Analysis of Coding Conventions for phpDocumentor
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: 55.64%
- Array end commaMethod: yesValue: 83.33%
- Array keyword caseMethod: lowerValue: 100%
- Blank lines at end of control structureMethod: 0Value: 100%
- Blank lines at start of control structureMethod: 0Value: 100%
- Brackets around echoed stringsMethod: noValue: 100%
- CamelCase method nameMethod: yesValue: 99.75%
- Class defined in namespaceMethod: yesValue: 100%
- Class has doc commentMethod: yesValue: 55.75%
- 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: 100%
- EOL charMethod: \nValue: 100%
- File extension for class filesMethod: .phpValue: 100%
- File extension for non-class filesMethod: .phpValue: 100%
- File has doc commentMethod: yesValue: 91.43%
- Function has doc commentMethod: yesValue: 83.81%
- Function opening brace placementMethod: new lineValue: 97.48%
- Inline comment styleMethod: // ...Value: 100%
- Line indentMethod: spacesValue: 100%
- Line lengthMethod: 80 or lessValue: 94.53%
- Lowercase filenameMethod: noValue: 100%
- Multiple statements on same lineMethod: noValue: 99.58%
- 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: 100%
- PascalCase class nameMethod: yesValue: 97.7%
- Private method prefixed with underscoreMethod: noValue: 100%
- Short array syntax usedMethod: yesValue: 62.87%
- Space after operatorMethod: 1Value: 99.87%
- Space before operatorMethod: 1Value: 77.29%
- Spaces after control structure open parenthesisMethod: 0Value: 100%
- Spaces before control structure close parenthesisMethod: 0Value: 100%
- Spacing after cast statementMethod: 1Value: 53.76%
- Spacing after object operatorMethod: 0Value: 100%
- Spacing after string concatMethod: 1Value: 80.5%
- Spacing before object operatorMethod: 0Value: 97.54%
- Spacing before string concatMethod: 1Value: 69.29%
- Use of ELSE IF or ELSEIFMethod: elseifValue: 100%
Analysis of Coding Conventions for phpDocumentor
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
Spacing after cast statement
How many spaces are there between a cast statement and the variable?
| Key | Method | Use |
|---|---|---|
| 0 | 0 | 46.24% |
| 1 - Most popular method | 1 | 53.76% |
Based on 93 cast statements
- 01 Mar 2015: there was a 3.46% swing from 1 to 0
- 01 Jun 2015: there was a 25.36% swing from 1 to 0
- 01 Jul 2015: there was a 11.37% swing from 1 to 0
- 01 Aug 2015: there was a 21.71% swing from 1 to 0
- 01 Nov 2015: there was a 43.7% swing from 0 to 1
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 | 55.64% |
| yes | yes | 44.36% |
Based on 133 assignment blocks
- 01 Jun 2015: there was a 4.72% swing from no to yes
- 01 Aug 2015: there was a 4.37% swing from no to yes
- 01 Mar 2016: there was a 7.4% swing from yes to no
Class has doc comment
Does each class have a docblock comment to describe its purpose?
This project is using the popular method for this convention
| Key | Method | Use |
|---|---|---|
| no | no | 44.25% |
| yes - Most popular method | yes | 55.75% |
Based on 174 classes
- 01 Aug 2015: there was a 10.37% swing from yes to no
- 01 Sep 2015: there was a 4.97% swing from yes to no
- 01 Jan 2016: there was a 6.67% swing from yes to no
- 01 Mar 2017: there was a 6.59% swing from yes to no
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 |
|---|---|---|
| no | no | 37.13% |
| yes - Most popular method | yes | 62.87% |
Based on 237 array definitions
- 01 Jun 2015: there was a 8.73% swing from no to yes
- 01 Jul 2015: there was a 5.62% swing from no to yes
- 01 Aug 2015: there was a 9.52% swing from no to yes
- 01 Nov 2015: there was a 20.76% swing from no to yes
- 01 Jan 2016: there was a 11.4% swing from no to yes
- 01 Mar 2017: there was a 4.2% swing from no to yes
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 | 13.69% |
| 1 - Most popular method | 1 | 69.29% |
| newline | newline | 17.01% |
Based on 241 concat 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% |
| 1 - Most popular method | 1 | 77.29% |
| newline | newline | 22.71% |
Based on 317 operators
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 | 19.5% |
| 1 - Most popular method | 1 | 80.5% |
Based on 241 concat operators
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 | 16.67% |
| yes - Most popular method | yes | 83.33% |
Based on 6 array definitions
- 01 Aug 2015: there was a 25% swing from no to yes
- 01 Nov 2015: there was a 8.33% swing from no to yes
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 | 16.19% |
| yes - Most popular method | yes | 83.81% |
Based on 556 functions
- 01 Aug 2015: there was a 6.39% swing from yes to no
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 | 8.57% |
| yes - Most popular method | yes | 91.43% |
Based on 175 files
- 01 Sep 2015: there was a 5.13% swing from yes to no
- 01 Jan 2016: there was a 3.18% swing from yes to no
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 | 94.53% |
| 81-120 | 81-120 | 5.47% |
Based on 12,805 lines
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 | 97.48% |
| same line | same line | 2.52% |
Based on 516 functions
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.54% |
| newline | newline | 2.46% |
Based on 2,394 object operators
PascalCase class name
Are class names defined using PascalCase?
This project is using the popular method for this convention
| Key | Method | Use |
|---|---|---|
| no | no | 2.3% |
| yes - Most popular method | yes | 97.7% |
Based on 174 classes
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 | 99.58% |
| yes | yes | 0.42% |
Based on 2,863 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.25% |
| yes - Most popular method | yes | 99.75% |
Based on 400 methods
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 |
|---|---|---|
| 0 | 0 | 0.06% |
| 1 - Most popular method | 1 | 99.87% |
| 2 | 2 | 0.06% |
Based on 1,563 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 |
|---|---|---|
| elseif - Most popular method | elseif | 100% |
Based on 10 elseif statements
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 174 classes
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 149 PHP constants
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 175 open tags
Lowercase filename
Are PHP filenames lowercase?
This project is using the popular method for this convention
| Key | Method | Use |
|---|---|---|
| no - Most popular method | no | 100% |
| yes | yes | 0% |
Based on 175 files
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 |
|---|---|---|
| 0 | 0 | 0% |
| 1 - Most popular method | 1 | 100% |
| 2 | 2 | 0% |
Based on 175 files
- 01 Jun 2015: there was a 3.83% swing from 1 to 0
- 01 Jan 2016: there was a 4.32% swing towards 1
- there was a 3.09% swing away from 0
Array keyword case
When defining an array, how is the array keyword written?
This project is using the popular method for this convention
| Key | Method | Use |
|---|---|---|
| lower - Most popular method | lower | 100% |
Based on 88 array definitions
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 | 100% |
Based on 153 PHP types
Private method prefixed with underscore
Are private methods prefixed with an underscore?
This project is using the popular method for this convention
| Key | Method | Use |
|---|---|---|
| no - Most popular method | no | 100% |
| yes | yes | 0% |
Based on 115 private methods
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 4,240 keywords
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 175 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 1 non-class files
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 2,394 object operators
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 174 classes
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 |
|---|---|---|
| // ... - Most popular method | // ... | 100% |
Based on 343 inline comments
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 459 control structures
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 174 class files
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% |
Based on 443 control structures
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 | 100% |
Based on 175 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 443 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 9,174 indented lines
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 | 100% |
Based on 473 control structures
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 41 closures
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 473 control structures
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 1 echo statements
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 174 classes
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 3 constants
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 175 files