Аргументы функции
Функция может принимать информацию в виде списка аргументов, который является списком разделенных запятыми выражений. Аргументы вычисляются слева направо.
PHP поддерживает передачу аргументов по значению (по умолчанию), передачу аргументов по ссылке, и значения по умолчанию. Списки аргументов переменной длины также поддерживаются, смотрите также описания функций func_num_args() , func_get_arg() и func_get_args() для более детальной информации.
Пример #1 Передача массива в функцию
Передача аргументов по ссылке
По умолчанию аргументы в функцию передаются по значению (это означает, что если вы измените значение аргумента внутри функции, то вне ее значение все равно останется прежним). Если вы хотите разрешить функции модифицировать свои аргументы, вы должны передавать их по ссылке.
Если вы хотите, что бы аргумент всегда передавался по ссылке, вы можете указать амперсанд (&) перед именем аргумента в описании функции:
Пример #2 Передача аргументов по ссылке
Значения аргументов по умолчанию
Функция может определять значения по умолчанию в стиле C++ для скалярных аргументов, например:
Пример #3 Использование значений по умолчанию в определении функции
Результат выполнения данного примера:
PHP также позволяет использовать массивы ( array ) и специальный тип NULL в качестве значений по умолчанию, например:
Пример #4 Использование нескалярных типов в качестве значений по умолчанию
Значение по умолчанию должно быть константным выражением, а не (к примеру) переменной или вызовом функции/метода класса.
Обратите внимание, что все аргументы, для которых установлены значения по умолчанию, должны находиться правее аргументов, для которых значения по умолчанию не заданы, в противном случае ваш код может работать не так, как вы этого ожидаете. Рассмотрим следующий пример:
Пример #5 Некорректное использование значений по умолчанию
<?php
function makeyogurt ( $type = «ацидофил» , $flavour )
<
return «Готовим чашку из бактерий $type со вкусом $flavour .\n» ;
>
echo makeyogurt ( «малины» ); // Не будет работать так, как мы могли бы ожидать
?>
Результат выполнения данного примера:
Теперь сравним его со следующим примером:
Пример #6 Корректное использование значений по умолчанию
<?php
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 Основные объявления типов-классов
<?php
class C <>
class D extends C <>
// Это не является расширением класса C.
class E <>
function f ( C $c ) <
echo get_class ( $c ). «\n» ;
>
Результат выполнения данного примера:
Пример #8 Основные объявления типов-интерфейсов
// Это не реализует интерфейс I.
class E <>
function f ( I $i ) <
echo get_class ( $i ). «\n» ;
>
Результат выполнения данного примера:
Пример #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 Строгая типизация
<?php
declare( strict_types = 1 );
function sum ( int $a , int $b ) <
return $a + $b ;
>
var_dump ( sum ( 1 , 2 ));
var_dump ( sum ( 1.5 , 2.5 ));
?>
Результат выполнения данного примера:
Пример #11 Слабая типизация
<?php
function sum ( int $a , int $b ) <
return $a + $b ;
>
var_dump ( sum ( 1 , 2 ));
// These will be coerced to integers: note the output below!
var_dump ( sum ( 1.5 , 2.5 ));
?>
Результат выполнения данного примера:
Пример #12 Обработка исключения TypeError
<?php
declare( strict_types = 1 );
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 ();
>
?>
Результат выполнения данного примера:
Списки аргументов переменной длины
PHP поддерживает списки аргументов переменной длины для функций, определяемых пользователем. Для версий PHP 5.6 и выше это делается добавлением многоточия (. ). Для версий 5.5 и старше используются функции func_num_args() , func_get_arg() и func_get_args() .
. в PHP 5.6+
В версиях PHP 5.6 и выше список аргументов может содержать многоточие . , чтобы показать, что функция принимает переменное количество аргументов. Аргументы в этом случае будут переданы в виде массива. Например:
Пример #13 Использование . для доступа к аргументам
<?php
function sum (. $numbers ) <
$acc = 0 ;
foreach ( $numbers as $n ) <
$acc += $n ;
>
return $acc ;
>
echo sum ( 1 , 2 , 3 , 4 );
?>
Результат выполнения данного примера:
Многоточие (. ) можно использовать при вызове функции, чтобы распаковать массив ( array ) или Traversable переменную в список аргументов:
Пример #14 Использование . для передачи аргументов
<?php
function add ( $a , $b ) <
return $a + $b ;
>
echo add (. [ 1 , 2 ]). «\n» ;
Результат выполнения данного примера:
Можно задать несколько аргументов в привычном виде, а затем добавить . . В этом случае . поместит в массив только те аргументы, которые не нашли соответствия указанным в объявлении функции.
Также можно добавить подсказку типа перед . . В этом случае PHP будет следить, чтобы все аргументы обработанные многоточием (. ) были того же типа, что указан в подсказке.
Пример #15 Аргументы с подсказкой типов
<?php
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 );
?>
Результат выполнения данного примера:
В конце концов, можно передавать аргументы по ссылке. Для этого перед . нужно поставить амперсанд (&).
Предыдущие версии PHP
Для указания того, что функция принимает переменное число аргументов, никакой специальный синтаксис не используется. Для доступа к аргументам необходимо использовать функции func_num_args() , func_get_arg() и func_get_args() .
В первом примере выше было показано, как задать список аргументов переменной длины для версий PHP 5.5 и более ранних:
Пример #16 Доступ к аргументам в PHP 5.5 и ранних версий
<?php
function sum () <
$acc = 0 ;
foreach ( func_get_args () as $n ) <
$acc += $n ;
>
return $acc ;
>
Можем ли мы передать массив как параметр в любой функции в PHP?
у меня есть функция отправки почты пользователям, и я хочу передать один из ее параметров в виде массива идентификаторов.
возможно ли это сделать? Если да, то как это сделать?
Предположим у нас есть функция как:
в частности, $id должен быть массивом.
12 ответов
вы можете передать массив в качестве аргумента. Он копируется по значению (или корова бы, что по сути означает то же самое для вас), так что вы можете array_pop() (и подобное) все, что вам нравится на нем, и не повлияет ни на что снаружи.
вы можете фактически только принять массив, поместив его тип в сигнатуру аргумента функции.
Есть ли способ передать массив, как список аргументов, в функцию?
Она получает, в качестве аргументов, некоторое число массивов, первый из которых содержит данные для сравнения, а второй и последующие проверяются на наличие в них совпадений.
Есть игровое поле 10×10 клеток, данные о котором хранятся в соответствующем двухмерном массиве. Мне требуется посчитать, сколько клеток определённого типа есть на всём поле.
Функция предполагалась как универсальная, для подсчёта количества совпадений в любом массиве, и переписывать её для проверки массива двухмерного мне не очень хочется.
Очевидное решение состоит в том, что бы переписать функцию для получения ею двух массивов, второй из которых будет содержать массивы для проверки, или ввести ещё один обязательный аргумент, содержащий указание глубины погружения, но я не уверен, что это — оптимальный вариант.
Поэтому вопрос: Нет ли способа передать все элементы массива в функцию, в качестве независимых аргументов? Есть функция list() , но она просто превратит массив из десяти элементов в десять отдельных переменных, которые всё равно придётся передавать функции вручную, как и если бы я просто перечислил все элементы массива. Хотелось бы что-то более элегантное, тем более, что я почти уверен, что такое решение есть, просто я его не нашёл.