Functions with Object and Array arguments
— Data from the function parameters can be of different types: number, string, array, or even object. To check the parameters data type, you can use PHP specific functions, like: is_string(), is_array(), is_object() , etc.
There is also another option for objects and arrays, by specifying in the same declaration the parameter and the allowed data type.
function function_name(ClassName $parameter) < // function body >
function function_name(array $parameter, array $parameter2) < // function body >
— These formulas verify and ensure that the $parameter data to be an object instance of a certain class, specified in ClassName , or, at the other syntax, an Array.
— Example :
In the next example we set a class, named AClas, a function ( fObj() ) which only accepts an argument that is an object instance of the AClas, and another function ( fArr() ) with two parameters, the first argument must be an array.
> // this function accepts only an argument that is an object instance of the AClas function fObj(AClas $objPar) < echo $objPar->aMet(). '
'; // calls the aMet() method > // the first argument passed to this function must be an Array function fArr(array $arrPar1, $par2) < print_r($arrPar1); echo '
'. $par2; > // object instance of the AClas $obj = new AClas(); fObj($obj); // calls the fObj() with $obj argument $aray = array('php', 'mysql', 'javascript'); $str = 'https://coursesweb.net'; fArr($aray, $str); // calls the fArr() function ?>
As you can notice, the special defined parameters can be used togheter with normal parameter ( fArr(array $arrPar1, $par2) )
The code above will output:
If one of the fObj() or fArr functions is not called with the data type required in its definition, will cause an error. For example, if you call the fArr() function, and the first argument isn’t an array (i.g fArr(8, $str); ), the script will return an error like this:
Class methods with object and array arguments
If your class has methods which use object or array arguments, you can specify in the method definition the type of the allowed arguments.
— Example :
In the following example we define two classes (AClas and BClas). The BClas has two methods: bObj() is defined to accepts for its argument only instance of the AClas, and bArr() only accepts data type Array.
> // Define BClas class class BClas < // only uses object instance of AClas public function bObj(AClas $obj_par) < return $obj_par->aMet(); // cxalls the meethod aMet() of the AClas > // only accepts an array argument public function bArr(array $arr_par) < print_r($arr_par); >> // object instance of the AClas $objAC = new AClas(); // object instance of the BClas $objBC = new BClas(); // calls the methods of the BClas, with the correct arguments (AClas instance for bObj(), and an array for bArr() ) echo $objBC->bObj($objAC). '
'; echo $objBC->bArr( array('courses', 'tutorials') ); ?>
Аргументы функции
Функция может принимать информацию в виде списка аргументов, который является списком разделенных запятыми выражений. Аргументы вычисляются слева направо.
PHP поддерживает передачу аргументов по значению (по умолчанию), передачу аргументов по ссылке, и значения по умолчанию. Списки аргументов переменной длины также поддерживаются, смотрите также описания функций func_num_args() , func_get_arg() и func_get_args() для более детальной информации.
Пример #1 Передача массива в функцию
function takes_array ( $input )
echo » $input [ 0 ] + $input [ 1 ] = » , $input [ 0 ]+ $input [ 1 ];
>
?>
Передача аргументов по ссылке
По умолчанию аргументы в функцию передаются по значению (это означает, что если вы измените значение аргумента внутри функции, то вне ее значение все равно останется прежним). Если вы хотите разрешить функции модифицировать свои аргументы, вы должны передавать их по ссылке.
Если вы хотите, что бы аргумент всегда передавался по ссылке, вы можете указать амперсанд (&) перед именем аргумента в описании функции:
Пример #2 Передача аргументов по ссылке
function add_some_extra (& $string )
$string .= ‘и кое-что еще.’ ;
>
$str = ‘Это строка, ‘ ;
add_some_extra ( $str );
echo $str ; // выведет ‘Это строка, и кое-что еще.’
?>
Значения аргументов по умолчанию
Функция может определять значения по умолчанию в стиле C++ для скалярных аргументов, например:
Пример #3 Использование значений по умолчанию в определении функции
function makecoffee ( $type = «капуччино» )
return «Готовим чашку $type .\n» ;
>
echo makecoffee ();
echo makecoffee ( null );
echo makecoffee ( «эспрессо» );
?>
Результат выполнения данного примера:
Готовим чашку капуччино. Готовим чашку . Готовим чашку эспрессо.
PHP также позволяет использовать массивы ( array ) и специальный тип NULL в качестве значений по умолчанию, например:
Пример #4 Использование нескалярных типов в качестве значений по умолчанию
function makecoffee ( $types = array( «капуччино» ), $coffeeMaker = NULL )
$device = is_null ( $coffeeMaker ) ? «вручную» : $coffeeMaker ;
return «Готовлю чашку » . join ( «, » , $types ). » $device .\n» ;
>
echo makecoffee ();
echo makecoffee (array( «капуччино» , «лавацца» ), «в чайнике» );
?>
Значение по умолчанию должно быть константным выражением, а не (к примеру) переменной или вызовом функции/метода класса.
Обратите внимание, что все аргументы, для которых установлены значения по умолчанию, должны находиться правее аргументов, для которых значения по умолчанию не заданы, в противном случае ваш код может работать не так, как вы этого ожидаете. Рассмотрим следующий пример:
Пример #5 Некорректное использование значений по умолчанию
function makeyogurt ( $type = «ацидофил» , $flavour )
return «Готовим чашку из бактерий $type со вкусом $flavour .\n» ;
>
echo makeyogurt ( «малины» ); // Не будет работать так, как мы могли бы ожидать
?>
Результат выполнения данного примера:
Warning: Missing argument 2 in call to makeyogurt() in /usr/local/etc/httpd/htdocs/phptest/functest.html on line 41 Готовим чашку из бактерий малины со вкусом .
Теперь сравним его со следующим примером:
Пример #6 Корректное использование значений по умолчанию
function makeyogurt ( $flavour , $type = «ацидофил» )
return «Готовим чашку из бактерий $type со вкусом $flavour .\n» ;
>
echo makeyogurt ( «малины» ); // отрабатывает правильно
?>
Результат выполнения данного примера:
Готовим чашку из бактерий ацидофил со вкусом малины.
Замечание: Начиная с PHP 5, значения по умолчанию могут быть переданны по ссылке.
Объявление типов
Замечание:
Объявление типов также известно, как подсказки для типов в PHP 5.
Объявления типов позволяют функциям строго задавать тип передаваемых параметров. Передача в функцию значений несоответствующего типа будет приводить к ошибке: в PHP 5 это будет обрабатываемая фатальная ошибка, а в PHP 7 будет выбрасываться исключение TypeError.
Чтобы объявить тип агрумента, необходимо перед его именем добавить имя требуемого типа. Также можно объявить тип NULL , чтобы указать, что значением по умолчанию аргумента является NULL .
Valid types
| Тип | Описание | Минимальная версия PHP |
|---|---|---|
| Имя класса/интерфейса | Агрумент должен быть instanceof, что и имя класса или интерфейса. | PHP 5.0.0 |
| array | Аргумент должен быть типа array . | PHP 5.1.0 |
| callable | Аргумент должен быть корректным callable типом. | PHP 5.4.0 |
| bool | Аргумент должен быть типа boolean . | PHP 7.0.0 |
| float | Аргумент должен быть float типа. | PHP 7.0.0 |
| int | Аргумент должен быть типа integer . | PHP 7.0.0 |
| string | Аргумент должен иметь тип string . | PHP 7.0.0 |
Примеры
Пример #7 Основные объявления типов-классов
// Это не является расширением класса C.
class E <>
function f ( C $c ) echo get_class ( $c ). «\n» ;
>
f (new C );
f (new D );
f (new E );
?>
Результат выполнения данного примера:
C D Fatal error: Uncaught TypeError: Argument 1 passed to f() must be an instance of C, instance of E given, called in - on line 14 and defined in -:8 Stack trace: #0 -(14): f(Object(E)) #1 thrown in - on line 8
Пример #8 Основные объявления типов-интерфейсов
// Это не реализует интерфейс I.
class E <>
function f ( I $i ) echo get_class ( $i ). «\n» ;
>
Результат выполнения данного примера:
C Fatal error: Uncaught TypeError: Argument 1 passed to f() must implement interface I, instance of E given, called in - on line 13 and defined in -:8 Stack trace: #0 -(13): f(Object(E)) #1 thrown in - on line 8
Пример #9 Объявление типа Null
function f ( C $c = null ) var_dump ( $c );
>
Результат выполнения данного примера:
Строгая типизация
По умолчанию, PHP будет пытаться привести значения несоответствующих типов к скалярному типу, если это возможно. Например, если в функцию передается integer , а тип аргумента объявлен string , в итоге функция получит преобразованное string значение.
Для отдельных файлов можно включать режим строгой типизации. В этом режиме в функцию можно передавать значения только тех типов, которые объявлены для аргументов. В противном случае будет выбрасываться исключение TypeError. Есть лишь одно исключение — integer можно передать в функцию, которая ожидает значение типа float .
Для влючения режима строгой типизации используется выражение declare в объявлении strict_types:
Включение режима строгой типизации также повлияет на объявления типов возвращаемых значений.
Замечание:
Режим строгой типизации распространяется на вызовы функций совершенные из файла, в котором этот режим включен, а не на функции, которые в этом файле объявлены. Если файл без строгой типизации вызывает функцию, которая объявлена в файле с включенным режимом, значения аргументов будут приведены к нужным типам и ошибок не последует.
Замечание:
Строгая типизация применима только к скалярным типам и работает только в PHP 7.0.0 и выше. Равно как и сами объявления скалярных типов добавлены в этой версии.
Пример #10 Строгая типизация
function sum ( int $a , int $b ) return $a + $b ;
>
var_dump ( sum ( 1 , 2 ));
var_dump ( sum ( 1.5 , 2.5 ));
?>
Результат выполнения данного примера:
int(3) Fatal error: Uncaught TypeError: Argument 1 passed to sum() must be of the type integer, float given, called in - on line 9 and defined in -:4 Stack trace: #0 -(9): sum(1.5, 2.5) #1 thrown in - on line 4
Пример #11 Слабая типизация
function sum ( int $a , int $b ) return $a + $b ;
>
// These will be coerced to integers: note the output below!
var_dump ( sum ( 1.5 , 2.5 ));
?>
Результат выполнения данного примера:
Пример #12 Обработка исключения TypeError
function sum ( int $a , int $b ) return $a + $b ;
>
try var_dump ( sum ( 1 , 2 ));
var_dump ( sum ( 1.5 , 2.5 ));
> catch ( TypeError $e ) echo ‘Error: ‘ . $e -> getMessage ();
>
?>
Результат выполнения данного примера:
int(3) Error: Argument 1 passed to sum() must be of the type integer, float given, called in - on line 10
Списки аргументов переменной длины
PHP поддерживает списки аргументов переменной длины для функций, определяемых пользователем. Для версий PHP 5.6 и выше это делается добавлением многоточия (. ). Для версий 5.5 и старше используются функции func_num_args() , func_get_arg() и func_get_args() .
. в PHP 5.6+
В версиях PHP 5.6 и выше список аргументов может содержать многоточие . , чтобы показать, что функция принимает переменное количество аргументов. Аргументы в этом случае будут переданы в виде массива. Например:
Пример #13 Использование . для доступа к аргументам
function sum (. $numbers ) $acc = 0 ;
foreach ( $numbers as $n ) $acc += $n ;
>
return $acc ;
>
Результат выполнения данного примера:
Многоточие (. ) можно использовать при вызове функции, чтобы распаковать массив ( array ) или Traversable переменную в список аргументов:
Пример #14 Использование . для передачи аргументов
Результат выполнения данного примера:
Можно задать несколько аргументов в привычном виде, а затем добавить . . В этом случае . поместит в массив только те аргументы, которые не нашли соответствия указанным в объявлении функции.
Также можно добавить подсказку типа перед . . В этом случае PHP будет следить, чтобы все аргументы обработанные многоточием (. ) были того же типа, что указан в подсказке.
Пример #15 Аргументы с подсказкой типов
function total_intervals ( $unit , DateInterval . $intervals ) $time = 0 ;
foreach ( $intervals as $interval ) $time += $interval -> $unit ;
>
return $time ;
>
$a = new DateInterval ( ‘P1D’ );
$b = new DateInterval ( ‘P2D’ );
echo total_intervals ( ‘d’ , $a , $b ). ‘ days’ ;
// This will fail, since null isn’t a DateInterval object.
echo total_intervals ( ‘d’ , null );
?>
Результат выполнения данного примера:
3 days Catchable fatal error: Argument 2 passed to total_intervals() must be an instance of DateInterval, null given, called in - on line 14 and defined in - on line 2
В конце концов, можно передавать аргументы по ссылке. Для этого перед . нужно поставить амперсанд (&).
Предыдущие версии PHP
Для указания того, что функция принимает переменное число аргументов, никакой специальный синтаксис не используется. Для доступа к аргументам необходимо использовать функции func_num_args() , func_get_arg() и func_get_args() .
В первом примере выше было показано, как задать список аргументов переменной длины для версий PHP 5.5 и более ранних:
Пример #16 Доступ к аргументам в PHP 5.5 и ранних версий
function sum () $acc = 0 ;
foreach ( func_get_args () as $n ) $acc += $n ;
>
return $acc ;
>
Результат выполнения данного примера: