Function declarations follow the "BSD/Allman style":
<?php
function fooFunction($arg1, $arg2 = '')
{
if (condition) {
statement;
}
return $val;
}
?>
|
Arguments with default values go at the end of the argument list.
Always attempt to return a meaningful value from a function if one
is appropriate. Here is a slightly longer example:
<?php
function connect(&$dsn, $persistent = false)
{
if (is_array($dsn)) {
$dsninfo = &$dsn;
} else {
$dsninfo = DB::parseDSN($dsn);
}
if (!$dsninfo || !$dsninfo['phptype']) {
return $this->raiseError();
}
return true;
}
?>
|
|
Class Definitions (Previous)
|
(Next) Comments
|
|
|
Download Documentation
|
Last updated: Mon, 02 Jul 2007 |
|
Do you think that something on this page is wrong? Please file a bug report or add a note.
|
| User Notes: |
Note by: Mike
Note to previous post: the Allman style is not only used for functions but also for class definitions.
Note by: pear at alan hogan dot com
Allman style is defined here for those unfamiliar with it:
http://en.wikipedia.org/wiki/Indent_style
Please note that the PEAR coding standards *do not* follow Allman style for *control structures*, only for functions.
Note by: pear at alan hogan dot com
Again according to Wikipedia, it would seem that PEAR, in fact, advocates K&R style:
function foo ()
{
//do stuff();
}
while (true) {
if (true ) {
//x..
}
}
It should be noted that both Allman and K&R agree on how to format function definitions.
|
|
