Download the PHP package ongr/ongr-strict-standard without Composer
On this page you can find all versions of the php package ongr/ongr-strict-standard. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package ongr-strict-standard
ONGR Strict Coding Standard
This standard provides strict code style checking for whitespace, commenting style and PHPDoc. It is PSR-2 compatible, enforces good programming and documentation practices.
Example
Ever wanted to standardize your team's code style? This is a PSR-2 compliant code:
php
<?php namespace Project\MyClass ;
use Foo;
/* this class has method
*/
class MyClass {
public function foo($param) { $a = $param * 2; return $a+1;
}
}
..
No more code like this!
After Ongr Strict Standard validation:
bash
FOUND 10 ERRORS AFFECTING 8 LINES
brace; 1 found
PHPCBF CAN FIX THE 5 MARKED SNIFF VIOLATIONS AUTOMATICALLY
Time: 68ms; Memory: 5.75Mb
Features
- Standardizes whitespace almost everywhere. E.g. between methods, spaces around operators, indentation of statements, etc.
- Required class short description everywhere except for PHPUnit testing classes.
- Required method short descriptions except for setters / getters and some magic methods.
- Comments start with capital letter and ends with appropriate punctuation. This suggests proper documentation and reduces laziness.
- Short array syntax is required.
- Require type hinting in PHPDoc for all parameters. Require @return and @throws tags where necessary.
- Code must not be aligned in assignments and array definitions.
- Strings should be "double quoted" only with a reason ($variable interpolation inside, etc.)
Requirements
- PHP >=5.4
- CodeSniffer 2.x
Acknowledgement
Our work is based solely on Squiz Labs Squiz coding standard and opensky Symfony2 coding standard.
Installation
Composer:
json
{ "require-dev": { "ongr/ongr-strict-standard": "2.", "squizlabs/php_codesniffer": "2." } }
Or optionally you can install globally to all projects at ` /.composer/composer.json`.
Then: `composer global update`.
Warning: if you are planing on developing, then sources should be located in `Ongr` directory.
For example, when cloning add target directory:
bash
git clone [email protected]:<username>/ongr-strict-standard.git ONGR
Running
bash
vendor/bin/phpcs -p --standard=/home/<user>/.composer/vendor/ongr/ongr-strict-standard/Ongr --ignore=vendor/,Tests/app/,Resources/public/ ./
..
Note: Do not use ` ` for HOME parameter, as PHPCS will not expand it.
Note: IDEs also support running Code Sniffer and adding error annotations directly on editor's source code (e.g. PHPStorm). Please see your IDE's documentation on how to add standard from custom directory.
PHPStorm Helper
Configure PHPCS: http://www.jetbrains.com/phpstorm/webhelp/using-php-code-sniffer-tool.html
Configure this standard:
- Go to Settings > Inspections > PHP > PHP Code Sniffer Validation.
- Mark checkbox ON for "PHP Code Sniffer Validation".
- Select Custom standard.
- Locate `vendor/ongr/ongr-strict-standard/Ongr` standard directory, press OK.
Code should be validated automatically on each PHP file edit.
License
This bundle is under the MIT license. Please, see the complete license
in the bundle LICENSE file.
