Coding guidelines

In General

Make it easier to review

• Keep method cyclomatic complexity below 5.
• Keep methods short, below 20 lines

IDE

We prefer to use PHPStorm. It's free for students and affordable for others. It lets you run the command you need to participate in this project and offers advanced features such as re-factoring.

Here is a sample code style config you can use: https://github.com/owncloud/gallery/wiki/PHPstorm-code-style-config

Naming

• Use meaningful method and variable names
• Keep referring to media types as mimetype, so that people woring on core understand what it means

PHP

You can use this tool to test the output of your PHP scripts: https://3v4l.org/

Short-circuit evaluation

PHP uses a short-circuit evaluation technique when looking at conditions

if (conditionA && conditionB)

If conditionA is false, conditionB will never be tested.

Cache

When searching in a storage's cache, you can't limit the scope to a specific path, the cache will look in the entire storage.

Javascript

Be very careful when working on the slideshow as the code and the CSS is being injected in the Files app and there could be side effects. Use the proper namespace and encapsulation.

Translations

Concatenated string cannot be processed by the l10n tools

Wrong

t('gallery',"This is my very long" +
" string, that I want to split");

Correct

t('gallery',"This is my very long string, that I want to split");