3. Функции в PHP

В лекции рассматриваются: понятие функции, функции, определяемые пользователем, аргументы функций, передача аргументов по значению и по ссылке, значение аргументов по умолчанию и значения, возвращаемые функцией (функция return()). Пример - создание web-интерфейса для генерации HTML-формы.

В этой лекции будут рассматриваться вопросы создания и использования функций в PHP. Говоря «функции», мы не имеем в виду все существующие в PHP функции, а лишь функции, определяемые пользователем. Мы рассмотрим способы задания таких функций, методы передачи аргументов, использование аргументов со значением по умолчанию и значения, возвращаемые функцией.

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

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

Для чего нужны функции? Чтобы ответить на этот вопрос, нужно понять, что вообще представляют собой функции. В программировании, как и в математике, функция есть отображение множества ее аргументов на множество ее значений. То есть функция для каждого набора значений аргумента возвращает какие-то значения, являющиеся результатом ее работы. Зачем нужны функции, попытаемся объяснить на примере. Классический пример функции в программировании - это функция, вычисляющая значение факториала числа. То есть мы задаем ей число, а она возвращает нам его факториал. При этом не нужно для каждого числа, факториал которого мы хотим получить, повторять 1 и тот же код - достаточно просто вызвать функцию с аргументом, равным этому числу.

Функция вычисления факториала натурального числа.

<?function fact($n){
if($n==0)return 1;
else return $fact=$n*fact($n-1);
}
echo fact(3);
//можно было бы написать echo(3*2), но если число большое,
echo fact(50)
//то удобнее пользоваться функцией, чем писать echo(50*49*48*.*3*2)
?>

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

Посмотрим, как в общем виде выглядит задание (объявление) функции. Функция может быть определена с помощью следующего синтаксиса:

function Имя_функции (параметр1, параметр2,
. параметрN){
Блок_действий
return "значение возвращаемое функцией";
}

Если прямо так написать в php-программе, то работать ничего не будет. Во-первых, Имя_функции и имена параметров функции (параметр1, параметр2 и т.д.) должны соответствовать правилам наименования в PHP (и русских символов в них лучше не использовать). Имена функций нечувствительны к регистру. Во-вторых, параметры функции - это переменные языка, поэтому перед названием каждого из них должен стоять знак $. Никаких многоточий ставить в списке параметров нельзя. В-третьих, вместо слов блок_действий в теле функции должен находиться любой правильный PHP-код (не обязательно зависящий от параметров). И наконец, после ключевого слова return должно идти корректное php-выражение (что-либо, что имеет значение). Кроме того, у функции может и не быть параметров, как и возвращаемого значения. Пример правильного объявления функции - функция вычисления факториала, приведенная выше.

Как происходит вызов функции? Указывается имя функции и в круглых скобках список значений ее параметров, если таковые имеются:

<?Имя_функции("значение_для_параметра1","значение_для_параметра2")
//пример вызова функции - вызов функции вычисления факториала приведен выше, там для вычисления факториала числа 3
//мы писали: fact(3);
//где fact - имя вызываемой функции,
//а 3 - значение ее параметра с именем $n
?>

Когда можно вызывать функцию? Казалось бы, странный вопрос. Функцию можно вызвать после ее определения, т.е. в любой строке программы ниже блока function f_name(){.}. В PHP3 это было действительно так. Но уже в PHP4 такого требования нет. Все дело в том, как интерпретатор обрабатывает получаемый код. Единственное исключение составляют функции, определяемые условно (внутри условных операторов или других функций). Когда функция определяется таким образом, ее определение должно предшествовать ее вызову.

<?$make=true;
/*здесь нельзя вызвать Make_event(); потому что она еще не существует, но можно вызвать Save_info()*/
Save_info("Вася","Иванов","Я выбрал курс по PHP");
if($make){
//определение функции Make_event()
function Make_event(){
echo"<p>Хочу изучать Python<p>";
}}
//теперь можно вызывать Make_event()
Make_event();
//определение функции Save_info
function Save_info($first,$last,$message){
echo"<p>$message<p>";
echo"Имя: ".$first." ".$last."<p>";
}
Save_info("Федя","Федоров","А я выбрал Lisp")
//Save_info можно вызывать и здесь
?>

<?php
/*нельзя сохранить данные, т.е. вызвать
функцию DataSave() до того, как выполнена
проверка их правильности, т.е. вызвана
функция DataCheck()*/
DataCheck();
DataSave();
function DataCheck(){
//проверка правильности данных
function DataSave(){
//сохраняем данные
}}
?>

<?//напишем функцию, которая бы добавляла к строке слово checked
function add_label(&$data_str){
$data_str.="checked";
}
$str="<input type=radio name=article ";
//пусть имеется такая строка
echo$str."><p>";
//выведет элемент формы - не отмеченную радио кнопку
add_label($str);
//вызовем функцию
echo$str."><p>"
//это выведет уже отмеченную радио кнопку
?>

<?function Message($sign="Оргкомитет."){
//здесь параметр sign имеет по умолчанию значение "Оргкомитет"
echo"Следующее собрание состоится завтра.<p>";
echo$sign."<p>";
}
Message();
//вызываем функцию без параметра. В этом случае подпись - это Оргкомитет
Message("С уважением, Вася")
//В этом случае подпись будет "С уважением, Вася."
?>

Следующее собрание состоится завтра.
Оргкомитет.
Следующее собрание состоится завтра.
С уважением, Вася.

<?function Add_article($title,$description,$author="Иванов Иван"){
echo"Заносим в каталог статью: $title,";
echo"автор $author";
echo"<p>Краткое описание: ";
echo"$description <hr>";
}
Add_article("Информатика и мы","Это статья про информатику","Петров Петр");
Add_article("Кто такие хакеры","Это статья про хакеров");
?>

Заносим в каталог статью: Информатика и мы,
автор Петров Петр.
Краткое описание:
Это статья про информатику.
Заносим в каталог статью: Кто такие хакеры,
автор Иванов Иван.
Краткое описание:
Это статья про хакеров.

<?function Add_article($author="Иванов Иван",$title,$description){
//действия как в предыдущем примере
}
Add_article("Кто такие хакеры","Это статья про хакеров")?>

Warning: Missing argument 3 for add_article() in c:\users\nina\tasks\func\def_bad.php on line 2

<?function DataCheck(){
$n=func_num_args();
echo"Число аргументов функции $n";
}
DataCheck();
//выведет строку "Число аргументов функции 0"
DataCheck(1,2,3)
//выведет строку "Число аргументов функции 3"
?>

<?function DataCheck(){
$check=true;
$n=func_num_args();
//число аргументов, переданных в функцию
/*проверяем, является ли 1-й переданный аргумент целым числом*/
if($n>=1) if(!is_int(func_get_arg(0)))
$check=false;
/*проверяем, является ли 2-й переданный аргумент строкой*/
if($n>=2)
if(!is_string(func_get_arg(1)))
$check=false;
return $check;
}
if(DataCheck(123,"text"))
echo"Проверка прошла успешно<p>";
else echo"Данные не удовлетворяют
условиям<p>";
if(DataCheck(324))
echo"Проверка прошла успешно<p>";
else echo"Данные не удовлетворяют условиям<p>";
?>

Проверка прошла успешно
Проверка прошла успешно

<?
function DataCheck(){
$check =true;
$n=func_num_args();
//число аргументов,
//переданных в функцию
$args=func_get_args();
//массив аргументов функции
for ($i=0;$i<$n;$i++){
$v=$args[$i];
if($i % 2 == 0){
if(!is_int($v)) $check=false;
//проверяем,
//является ли четный аргумент целым
}}
return $check;
}
if(DataCheck(array("text", 324)))
echo"Проверка прошла успешно<p>";
else echo"Данные не удовлетворяют
условиям<p>";
?>

<?
function DataCheck($params){
$check =true;
$n=count($params);
//число аргументов,
//переданных в функцию
for ($i=0;$i<$n;$i++){
$v=$params[$i];
if($i % 2 !== 0){
//проверяем, является ли нечетный
//аргумент целым
if(!is_int($v)) $check=false;
}}
return $check;
}
if(DataCheck(array("text", 324)))
echo"Проверка прошла успешно<p>";
else echo"Данные не удовлетворяют условиям<p>";
?>

global $var1, $var2;

<?$a=1;
function Test_g(){
global $a;
$a=$a*2;
echo'в результате работы функции $a=',$a;
}
echo'вне функции $a=',$a,', ';
Test_g();
echo"<p>";
echo 'вне функции $a=',$a,', ';
Test_g();
?>

вне функции $a=1, в результате работы
функции $a=2
вне функции $a=2, в результате работы
функции $a=4

$var1=&$GLOBALS["var1"];
$var2=&$GLOBALS["var2"];

static $var1, $var2;

<?
function Test_s(){
static $a=1;
//нельзя присваивать выражение или ссылку
$a=$a*2;
echo$a;
}
Test_s();//выведет 2
echo$a;//ничего не выведет, т.к. $a доступна только внутри функции
Test_s()//внутри функции $a=2, поэтому результатом работы функции будет число 4
?>

<?/*если 2-й параметр вычисляется как true, то он рассматривается как дата смерти,*/
function Age($birth,$is_dead){
if($is_dead)return $is_dead-$birth;
else return date("Y")-$birth;
}
echo Age(1971,false);//для 2009г. выведет 38
echo Age(1971,2001)//выведет 30
?>

$an_age=Age(1981, 2004);

<?php
function Full_age($b_day, $b_month, $b_year)
{
$y=date("Y");
$m=intval(date("m"));
$d=intval(date("d"));
$b_month=intval($b_month);
$b_day=intval($b_day);
$b_year=intval($b_year);
$day=($b_day > $d ? 30 - $b_day + $d : $d - $b_day);
$tmpMonth=($b_day > $d ? -1 : 0);
$month=($b_month > $m + $tmpMonth ? 12 - $b_month +
$tmpMonth + $m : $m+$tmpMonth - $b_month);
$tmpYear=($b_month > $m + $tmpMonth ? -1 : 0);
if($b_year > $y + $tmpYear)
{
$year=0; $month=0; $day=0;
}
else
{
$year=$y + $tmpYear - $b_year;
}
return array ($day,$month,$year);
}
$age=Full_age("29","06","1986");
echo"Вам $age[2] лет, $age[1] месяцев и $age[0] дней";
?>

<?
//задание функции Full_age()
list($day,$month,$year)=Full_age("07",
"08","1974");
echo"Вам $year лет, $month месяцев и
$day дней";
?>

<?
$arr=array("first","second");
list($a,$b)=$arr;
//переменной $a присваивается первое
//значение массива, $b - второе
echo $a," ",$b;
//выведет строку «first second»
?>

<?
$a=3; $b=2;
function & ref($par){
global $a, $b;
if($par % 2 == 0) return $b;
else return $a;
}
$var =& ref(4);
echo $var, " и ", $b,"<p>";
//выведет 2 и 2
$b=10;
echo $var, " и ", $b,"<p>";
//выведет 10 и 10
?>

<?
/*создадим 2 простые функции:
Add_sign - добавляет подпись к строке и
Show_text - выводит строку текста*/
function Add_sign($string,
$sign="С уважением, Петр"){
echo $string ." ".$sign;
}
function Show_text(){
echo"Отправить сообщение по почте<p>";
}
$func="Show_text";
//создаем переменную со значением,
//равным имени функции Show_text
$func();
//это вызовет функцию Show_text
$func="Add_sign";
//создаем переменную со значением,
//равным имени функции Add_sign
$func("Привет всем <p>");
//это вызовет функцию
//Add_sign с параметром "Привет всем"
?>

<?
$func="echo";
$func("TEXT");
?>

Fatal error: Call to undefined function:
echo() in
c:\users\nina\tasks\func\var_f.php on line 2

<form action=ask_names.php>
Создать элемент "строка ввода текста": <input
type=checkbox name=types[]
value=string><p>
Количество элементов: <input type=text
name=numbers[string]
size=3><p>
<p>
Создать элемент "текстовая область": <input
type=checkbox
name=types[] value=text><p>
Количество элементов: <input type=text
name=numbers[text]
size=3><p>
<input type=submit value="Создать">
</form>

<?
$file="task.php";
/*файл, который будет обрабатывать
сгенерированную этим скриптом форму*/
function Ask_names(){
//функция генерирует форму для
//ввода названий элементов ввода
global $file;
//объявляем, что хотим использовать эту
//переменную, заданную вне функции
if(isset($_GET["types"])){
$st='<form action="'.$file.'">';
foreach ($_GET["types"] as $k=>$type){
/*перебираем все типы элементов,
которые нужно создать*/
$num=$_GET["numbers"][$type];
//сколько элементов каждого типа нужно
for ($i=1;$i<=$num;$i++){
//создаем $num строк для ввода
$st.= "Введите имя $i-го элемента типа $type: ";
$st.= "<input type=text name=names[$type][]><p>";
}
//сохраняем тип и число необходимых
//элементов ввода этого типа
$st.= "<input type=hidden name=types[] value=$type>";
$st.= "<input type=hidden name=numbers[] value=$num><p>";
}
$st.="<input type=submit name=send value=send></form>";
return $st;
//в переменной $st содержится код формы
//для запроса имен
} else echo"Select type";
}
echo Ask_names();
//вызываем функцию и выводим
//результаты ее работы
?>

<?
$show_file="task_show.php";
/*файл, который будет обрабатывать данные созданной этим файлом формы*/
function Create_element($type,$name){
//функция создает элемент ввода по типу и названию
$str="";
switch($type){
case "string":
$str.="$name: <input type=text name=string[]><p>";
break;
case "text":
$str.="$name: <textarea name=text[]></textarea><p>";
break;
}
return $str;
}
function Create_form(){
//функция создает форму
//с нужными элементами
global $show_file;
$str='<form action="'.$show_file.'">';
foreach ($_GET["types"] as $k=>$type){
//перебираем типы элементов
$num=$_GET["numbers"][$k];
//число элементов этого типа
for ($i=1;$i<=$num;$i++){
$arr=$_GET["names"][$type][$i-1];
//имя создаваемого элемента
$str.=Create_element($type,$arr);
//вызываем функцию для
//создания элемента
}}
$str.="<input type=submit value=send></form>";
echo $str;
}
$crt="Create_form";
$crt();//вызываем функцию создания
//формы Create_form
?>