Coding Standards

All code contributed to the ImageX base installation profile must adhere to the Drupal.org's Coding Standards and meet the specialized requirements below.

Requirements

• All module names will begin with imagex.
• As a result of the naming of modules, all user-defined functions will be prefixed with imagex.

Requirements - Type Hinting

• Type hinting should be used in all possible cases.

Requirements - Classes, Properties, Methods

The term "class" refers to all classes, interfaces and traits. In addition, Drupal.org's Coding Standards must be followed. Additional requirements and guidelines appended below must be followed.

As a result of Drupal requiring at least version 5.2 of PHP and not 5.3, these are the caveats of the Drupal's guideline that should be followed when working with classes due to namespaces not being supported in PHP 5.2.

• All user-defined classes will be prefixed using Imagex and not ImageX. Additionally, class names must not have separation tokens such as _.
• All user-defined interfaces will be fixed using Imagex and not ImageX. Defined interfaces will have a suffix of Interface.

Requirements - Portability

• All code contributed to the ImageX base installation profile must be written with a non-client or project specific implementation to allow for continuous reusability of it.

Resources

• Developer Environment Setup - PHP Code Sniffer