Coding Guidelines (English)

• You can validate that your code complies with these guidelines by running stuff/php-format.py validate.

• Spaces, no tabs.

• End of line should should be Unix style (\n), not Windows style (\r\n).

• Opening brackets goes in the same line as the last statement.

    if (condition) {
        stuff;
    }
  

• A space between keywords and parenthesis for: if, else, while, switch, catch, function.

• Function calls have no space before the parentheses.

• No spaces are left inside the parentheses.

• A space after each comma, but without space before.

• All binary operators must have one space before and one after.

• There should not be more than one contiguous blank line.

• There should be no empty comments.

• You should not use block comments / * ... * /, only line // ....

PHP

• The tests must be run before committing changes and all must pass 100%, with no exception.

• Changes in functionality must be accompanied by their respective new / modified tests.

• All functions must be commented with the style:

    /**
     * set
     *  
     * If cache is turned on, save the value in key the the given timeout
     *      
     * @param string $value
     * @param int $timeout   
     * @return boolean
     */
    public function set($value, $timeout){ ....
  

• Exceptions must be used to report erroneous states. The use of functions that return true / false is allowed when they are expected values.

• All APIs must report their results as associative arrays.

• Use [RAII] (http://en.wikipedia.org/wiki/Resource_Acquisition_Is_Initialization) when appropriate, mainly in the administration of resources (files, etc ...)