Skip to content
This repository has been archived by the owner on Nov 1, 2020. It is now read-only.

Coding guidelines

Olivier Paroz edited this page Oct 2, 2015 · 10 revisions

In General

Make it easier to review

Naming

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

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");

Tips

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.

Rootfolder

If you get the root folder via server->getRootFolder(), you only have access to the local file system.

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.