Public Member Functions

enum_ml ($domain=null, $order_by=array('domain', 'list'))

here we put a full long description of the function's behavior, in english

this description may span multiple lines

Detailed Description

Definition at line 41 of file CODING_CONVENTION.php.

Member Function Documentation

enum_ml	(	$domain = `null`,
		$order_by = `array('domain', 'list')`
	)

here we put a full long description of the function's behavior, in english

this description may span multiple lines

Parameters

$domain	string ## each param has its
line,followed	by the param name ($domain) type (string) and description ##

Returns: array ## a; line is added when the function returns anything, followed by the returned type and description ##

Definition at line 53 of file CODING_CONVENTION.php.

References $cuid, $db, and $err.

                                                                        {
## function which consist of more than one word are separated by _ ##
## private functions are prefixed by "private" and their name starts by "_" ##
    global $err,$db,$cuid;
## use the globals for $db (database mapper), $cuid (uid of current alternc's user) $err (error/log mapper) 
    $err->log("mailman","enum_ml");
## when calling an important function, log it that way ##
## when raising an error, use the following syntax ##
    $err->raise("classname",_("text in english"));
  }

The documentation for this class was generated from the following file:

/home/alban/code/alternc/CODING_CONVENTION.php