Функции, определяемые пользователем

Предыдущая 9 10 11 12 13 14 151617 18 19 20 21 22 23 24 Следующая

Приведем пример синтаксиса, используемого для описания функций:

Пример 4.1.1:

function foo($arg_1, $arg_2, /* ..., */ $arg_n)

{

echo "Example function.\n";

return $retval;

}

Внутри функции можно использовать любой корректный PHP-код, в том числе другие функции и даже объявления классов.

В PHP 3 функции должны были быть определены прежде, чем они будут использованы. Начиная с PHP 4 такого ограничения нет, исключая тот случай, когда функции определяются условно, как это показано в двух последующих примерах.

В случае, когда функция определяется в зависимости от какого-либо условия, например, как это показано в двух приведенных ниже примерах, обработка описания функции должна предшествовать ее вызову.

Пример 4.1.2 (функции, зависящие от условий):

$makefoo = true;

/* Мы не можем вызвать функцию foo() в этом месте,

поскольку она еще не определена, но мы можем

обратиться к bar() */

bar();

if ($makefoo) {

function foo()

{

echo "I don't exist until program execution reaches me.\n";

}

/* Теперь мы благополучно можем вызывать foo(),

поскольку $makefoo была интерпретирована как true */

if ($makefoo) foo();

function bar()

{

echo "I exist immediately upon program start.\n";

}

Пример 4.1.3 (вложенные функции):

function foo()

{

function bar()

{

echo "I don't exist until foo() is called.\n";

}

/* Мы пока не можем обратиться к bar(),

поскольку она еще не определена. */

foo();

/* Теперь мы можем вызвать функцию bar(),

обработка foo() сделала ее доступной. */

bar();

PHP не поддерживает перегрузку функции, также отсутствует возможность переопределить или удалить объявленную ранее функцию.

Имена функций регистронезависимы, тем не менее, более предпочтительно вызывать функции так, как они были объявлены.

Аргументы функций

Функция может принимать информацию в виде списка аргументов, который является списком разделенных запятыми переменных и/или констант.

PHP поддерживает передачу аргументов по значению (по умолчанию), передачу аргументов по ссылке, и значения по умолчанию. Списки аргументов переменной длины поддерживаются, начиная с PHP 4.

Пример 4.2.1 (передача массива в функцию):

function takes_array($input)

{

echo "$input[0] + $input[1] = ", $input[0]+$input[1];

}

Передача аргументов по ссылке

По умолчанию аргументы в функцию передаются по значению (это означает, что если вы измените значение аргумента внутри функции, то вне ее значение все равно останется прежним). Если вы хотите разрешить функции модифицировать свои аргументы, вы должны передавать их по ссылке.

Если вы хотите, что бы аргумент всегда передавался по ссылке, вы можете указать амперсанд (&) перед именем аргумента в описании функции:

Пример 4.2.1.1 (передача аргументов по ссылке):

function add_some_extra(&$string)

{

$string .= 'and something extra.';

}

$str = 'This is a string, ';

add_some_extra($str);

echo $str; // Выведет 'This is a string, and something extra.'

Значения аргументов по умолчанию

Функция может определять значения по умолчанию в стиле C++ для скалярных аргументов.

Пример 4.2.2.1 (использование значений по умолчанию в определении функции):

function makecoffee($type = "cappuccino")

{

return "Making a cup of $type.\n";

}

echo makecoffee();

echo makecoffee("espresso");

Результат работы приведенного выше кода будет таким:

Making a cup of cappuccino.

Making a cup of espresso.

PHP также позволяет использовать массивы и специальный тип NULL в качестве значений по умолчанию, например:

Пример 4.2.2.2 (использование нескалярных типов в качестве значений по умолчанию):

function makecoffee($types = array("cappuccino"), $coffeeMaker = NULL)

{

$device = is_null($coffeeMaker) ? "hands" : $coffeeMaker;

return "Making a cup of ".join(", ", $types)." with $device.\n";

}

echo makecoffee();

echo makecoffee(array("cappuccino", "lavazza"), "teapot");

Значение по умолчанию должно быть константным выражением, а не (к примеру) переменной или вызовом функции/метода класса.

Обратите внимание, что все аргументы, для которых установлены значения по умолчанию, должны находится правее аргументов, для которых значения по умолчанию не заданы, в противном случае ваш код может работать не так, как вы этого ожидаете. Рассмотрим следующий пример:

Пример 4.2.2.3 (некорректное использование значений по умолчанию)

function makeyogurt($type = "acidophilus", $flavour)

{

return "Making a bowl of $type $flavour.\n";

}

echo makeyogurt("raspberry"); // Не будет работать так, как мы могли бы ожидать

Результат работы приведенного выше примера будет следующим:

Warning: Missing argument 2 in call to makeyogurt() in

/usr/local/etc/httpd/htdocs/php3test/functest.html on line 41

Making a bowl of raspberry .

Теперь сравним эго со следующим примером:

Пример 4.2.2.4 (корректное использование значений по умолчанию)

function makeyogurt($flavour, $type = "acidophilus")

{

return "Making a bowl of $type $flavour.\n";

}

echo makeyogurt("raspberry"); // отрабатывает правильно

Теперь результат работы примера будет выглядеть так:

Making a bowl of acidophilus raspberry.

Начиная с PHP 5, значения по умолчанию могут быть переданны по ссылке.

Списки аргументов переменной длины

PHP 4 и выше поддерживает списки аргументов переменной длины для функций, определяемых пользователем. Реализация этой возможности достаточно прозрачна и заключается в использовании функций func_num_args(), func_get_arg() и func_get_args().

Необходимости в специфическом синтаксисе нет, при этом список аргументов также может быть указан явно и будет обладать тем же поведением.

Int func_num_args ( void )

Возвращает количество аргументов, переданных текущей пользовательской функции. func_num_args() генерирует предупреждение при вызове вне определения функции.

Пример 4.2.3.1:

function foo()

{

$numargs = func_num_args();

echo "Number of arguments: $numargs\n";

}

foo(1, 2, 3); // Prints 'Number of arguments: 3'

Mixed func_get_arg ( int arg_num )

Возвращает arg_num-ый аргумент из списка аргументов пользовательской функции. Нумерация аргументов функции начинается с нуля. func_get_arg() генерирует предупреждение при вызове вне определения функции.

Если arg_num больше количества переданных аргументов, будет сгенерировано предупреждение и func_get_arg() вернет FALSE.

Пример 4.2.3.2:

function foo()

{

$numargs = func_num_args();

echo "Number of arguments: $numargs \n";

if ($numargs >= 2) {

echo "Second argument is: " . func_get_arg(1) . " \n";

}

foo (1, 2, 3);

Array func_get_args ( void )

Возвращает массив, в котором каждый элемент является соответствующим членом списка аргументов пользовательской функции. func_get_args() генерирует предупреждение при вызове вне определения функции.

Пример 4.2.3.3:

function foo()

{

$numargs = func_num_args();

echo "Number of arguments: $numargs \n";

if ($numargs >= 2) {

echo "Second argument is: " . func_get_arg(1) . " \n";

}

$arg_list = func_get_args();

for ($i = 0; $i < $numargs; $i++) {

echo "Argument $i is: " . $arg_list[$i] . " \n";

}

foo(1, 2, 3);

Возврат значений

Значения функций возвращаются при помощи необязательного оператора возврата return. Возвращаемые значения могут быть любого типа, в том числе это могут быть списки и объекты. Возврат приводит к завершению выполнения функции и передаче управления обратно к той строке кода, в которой данная функция была вызвана.

Пример 4.3.1:

function square($num)

{

return $num * $num;

}

echo square(4); // выводит '16'.

Функция не может возвращать несколько значений, но аналогичного результата можно добиться, возвращая массив.

Пример 4.3.2:

function small_numbers()

{

return array (0, 1, 2);

}

list ($zero, $one, $two) = small_numbers();

Предыдущая 9 10 11 12 13 14 151617 18 19 20 21 22 23 24 Следующая

Не нашли, что искали? Воспользуйтесь поиском по сайту: