Naming Conventions

Classes

Classes should be given descriptive names. Avoid using abbreviations where possible. Class names should always begin with an uppercase letter. Component class names should start with the component name. Examples of good class names are:

class MyClass
 
class MyComponentClass

Constants

Constants should always be all-uppercase, with underscores to separate words. Prefix constant names with the uppercased name of the class/module they are used in.

Files

TODO: Decide what to do about file naming conventions.

Functions and Methods

Functions and methods should be named using the "studly caps" style (also referred to as "bumpy case" or "camel caps"). Functions should in addition have the package name as a prefix, to avoid name collisions between packages. The initial letter of the name (after the prefix) is lowercase, and each letter that starts a new "word" is capitalized. Some examples:

function connect()
 
function getData()
 
function buildSomeWidget()
 
function XML_RPC_serializeData()

Private class members (meaning class members that are intended to be used only from within the same class in which they are declared; PHP does not yet support truly-enforceable private namespaces) are preceded by a single underscore. For example:

function _sort()
 
function _initTree()
 
$this->_status()

Note: The following applies to PHP5.

Protected class members (meaning class members that are intended to be used only from within the same class in which they are declared or from subclasses that extend it) are not preceded by a single underscore. For example:

protected $somevar
 
protected function initTree()

Global Variables

TODO: Decide what to do about global variables, and naming conventions.