Code Style Guide

Welcome to the ThinkTank Code style guide. When submitting pull requests, please make sure that your changes conform to the styles below.

Styles loosely based upon Drupal’s coding standards, which are themselves loosely based on the PEAR coding standards.

This document is a work in progress. When in doubt, follow the same style as existing ThinkTank code.

All Code

Lines should have no trailing whitespace at their end.

All indentation should not use tabs; use 4 spaces instead.

Comments, class, and variable names should use US English spelling.

Each file should contain exactly one class or interface.

Prefix filenames with class. for classes, and interface. for interfaces. For example, the CrawlerPlugin interface file is named interface.CrawlerPlugin.php. The User class file is named class.User.php.

Require_once statements should use single quotes, no parentheses, ie, require_once 'init.php';

ThinkTank implements the Model-View-Controller design pattern. All new code should follow suit. Read more about ThinkTank’s MVC implementation.

Language Specifics

• Code Style Guide: CSS
• Code Style Guide: JavaScript
• Code Style Guide: HTML
• Code Style Guide: PHP
• Code Style Guide: Smarty Template Language