elgg/elgg-coding-standards

Elgg coding standards for PHP_CodeSniffer

Elgg coding standards for PHP_CodeSniffer

This contains sniffs to be used with phpcs (PHP_CodeSniffer).

Installation and Usage

• Install composer
• Install dependencies with composer install
• Use the coding standard with vendor/bin/phpcs --standard=src/Elgg.
• Get a summary report on the engine with vendor/bin/phpcs --standard=src/Elgg -l --report=summary <Elgg engine lib directory>

elgg-coding-standards's Issues

Packagist not updating

Could someone make sure packagist is updated with new branches/tags. @ewinslow can you add me as collaborator on packagist?

Missing ruleset.xml prevents Eclipse integration

If someone is trying to use these sniffs within Eclipse (using this plugin: http://www.phpsrc.org/projects/pti-php-codesniffer), Eclipse will not recognize the Elgg coding standars, and will throw an error like "coding standard is not installed".
Easy fix: create a ruleset.xml in the same directory as the ElggCodingStandard.php file, and paste this into it:

Elgg Coding Standard.

This should fix the error message. Happy sniffing!
T

Update for CS 2

Could be useful: https://gist.github.com/gsherwood/9d22f634c57f990a7c64

Does not throw an error on line ending issues

Add detection of trailing whitechars

if/endif style control structures always violate standard

Would be nice to do:

if ($condition):
    //stuff
endif;

Unless we really mean to restrict control statements to only using the brace-style. In that case, making that rule explicit would be helpful :)

Add detection of upper case NULL/TRUE/FALSE

Trailing White Space

Following discussion about patches I provide to Elgg, and after reading again the Elgg Coding Standard, it appears that there's no policy for handling trailing white space, especially for empty lines.

My editor always removes white space, unless I'm writing text (i.e. not code), and I find it clean like that. Other editors will leave, or even add a white space or three on an empty line (usually depending on the context: commented line will "get" one space, indented line might get n tabs or spaces, etc.)

It would be nice before I try to figure out how to "fix" that, to have an official policy for trailing white space. (My opinion is: _remove it entirely_.)

Detect Elgg deprecated function usage

get_defined_functions() will come in handy for this. Also something using this:

$rf = new ReflectionFunction('extend_view');
var_dump(strpos($rf->getFileName(), "engine/lib/deprecated"));
var_dump(strpos($rf->getDocComment(), "@deprecated"));

Take a look at https://github.com/squizlabs/PHP_CodeSniffer/blob/master/CodeSniffer/Standards/Generic/Sniffs/PHP/DeprecatedFunctionsSniff.php

elgg_view parameters style

I generally like doing this:

echo elgg_view('input/text', array(
    'internalname' => 'name',
    'internalid' => 'name',
    'value' => $course->name,
    'placeholder' => "EXPL101",
    'required' => TRUE,
));

But CodeSniffer complains: Spaces not allowed in 'array' after opening parenthesis.

Does not handle passing by reference

It thinks the variable is named &$var and says the documentation does not match the real variable name.