Функция PHP с дополнительными параметрами

Я написал функцию PHP, которая может принимать 10 параметров, но требуются только 2. Иногда я хочу определить восьмой параметр, но не хочу вводить пустые строки для каждого из параметров, пока не дойду до восьмого.

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

Есть ли лучший способ настроить функцию, чтобы я мог передавать только те параметры, которые мне нужны?

Сделайте так, чтобы функция принимала один параметр: массив. Передайте фактические параметры как значения в массиве.

Изменить: ссылка в комментарии Пекки почти подводит итог.

В этом случае я передал массив, где ключ - это имя параметра, а значение - это значение.

$optional = array(
  "param" => $param1,
  "param2" => $param2
);

function func($required, $requiredTwo, $optional) {
  if(isset($optional["param2"])) {
    doWork();
  }
}

Чтобы выполнить то, что вы хотите, используйте массив, как сказал Rabbot (хотя это может стать проблемой для документирования / поддержки при чрезмерном использовании). Или просто используйте традиционные необязательные аргументы.

//My function with tons of optional params
function my_func($req_a, $req_b, $opt_a = NULL, $opt_b = NULL, $opt_c = NULL)
{
  //Do stuff
}
my_func('Hi', 'World', null, null, 'Red');

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

//Specialization of my_func - assuming my_func itself cannot be refactored
function my_color_func($reg_a, $reg_b, $opt = 'Red')
{
  return my_func($reg_a, $reg_b, null, null, $opt);
}
my_color_func('Hi', 'World');
my_color_func('Hello', 'Universe', 'Green');

В PHP 5.6 и более поздних версиях списки аргументов могут включать токен ... для обозначения того, что функция принимает переменное количество аргументов. Аргументы будут переданы в данную переменную в виде массива; например:

Пример использования ... для доступа к переменным аргументам

<?php
function sum(...$numbers) {
    $acc = 0;
    foreach ($numbers as $n) {
        $acc += $n;
    }
    return $acc;
}

echo sum(1, 2, 3, 4);
?>

Приведенный выше пример выведет:

10

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

Вы можете просто установить значение по умолчанию на null.

<?php
function functionName($value, $value2 = null) {
// do stuff
}

ПРИМЕЧАНИЕ. Это старый ответ для PHP 5.5 и ниже. PHP 5.6+ поддерживает аргументы по умолчанию

В PHP 5.5 и ниже вы можете добиться этого, используя один из следующих двух методов:

• с помощью функций func_num_args () и func_get_arg () ;
• с использованием аргументов NULL;

Как пользоваться

function method_1()
{
  $arg1 = (func_num_args() >= 1)? func_get_arg(0): "default_value_for_arg1";
  $arg2 = (func_num_args() >= 2)? func_get_arg(1): "default_value_for_arg2";
}

function method_2($arg1 = null, $arg2 = null)
{
  $arg1 = $arg1? $arg1: "default_value_for_arg1";
  $arg2 = $arg2? $arg2: "default_value_for_arg2";
}

Я предпочитаю второй метод, потому что он понятен и понятен, но иногда вам может понадобиться первый метод.

Думаю, вы тоже можете использовать объекты как params-transportes.

$myParam = new stdClass();
$myParam->optParam2 = 'something';
$myParam->optParam8 = 3;
theFunction($myParam);

function theFunction($fparam){      
  return "I got ".$fparam->optParam8." of ".$fparam->optParam2." received!";
}

Конечно, вы должны установить значения по умолчанию для «optParam8» и «optParam2» в этой функции, в противном случае вы получите «Notice: Undefined property: stdClass :: $ optParam2»

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

function theFunction($fparam){
   $default = array(
      'opt1' => 'nothing',
      'opt2' => 1
   );
   if(is_array($fparam)){
      $fparam = array_merge($default, $fparam);
   }else{
      $fparam = $default;
   }
   //now, the default values are overwritten by these passed by $fparam
   return "I received ".$fparam['opt1']." and ".$fparam['opt2']."!";
}

Если для создания объекта с допустимым состоянием требуются только два значения, вы можете просто удалить все другие необязательные аргументы и предоставить им сеттеры (если вы не хотите, чтобы они изменялись во время выполнения). Затем просто создайте экземпляр объекта с двумя обязательными аргументами и настройте остальные по мере необходимости с помощью установщика.

дальнейшее чтение

• Мартин Фаулер о Constructor vs Setter Injection и
• Внедрение зависимостей через конструкторы или установщики свойств?

Я знаю, что это старый пост, но у меня была проблема, такая как OP, и это то, что я придумал.

Пример массива, который вы можете передать. Вы можете повторно заказать это, если требуется конкретный заказ, но в этом вопросе это будет делать то, что вам задают.

$argument_set = array (8 => 'lots', 5 => 'of', 1 => 'data', 2 => 'here');

Это управляемо, легко читается, а точки извлечения данных могут быть добавлены и удалены в любой момент в любом месте кодирования и при этом избежать масштабной перезаписи. Я использовал целочисленные ключи, чтобы соответствовать исходному вопросу OP, но строковые ключи можно было использовать так же легко. Собственно для читабельности я бы посоветовал это.

Вставьте это во внешний файл для удобства

function unknown_number_arguments($argument_set) {

    foreach ($argument_set as $key => $value) {

        # create a switch with all the cases you need. as you loop the array 
        # keys only your submitted $keys values will be found with the switch. 
        switch ($key) {
            case 1:
                # do stuff with $value
                break;
            case 2:
                # do stuff with $value;
                break;
            case 3:
                # key 3 omitted, this wont execute 
                break;
            case 5:
                # do stuff with $value;
                break;
            case 8:
                # do stuff with $value;
                break;
            default:
                # no match from the array, do error logging?
                break;
        }
    }
return;
}

поместите это в начало, если файл.

$argument_set = array(); 

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

$argument_set[1][] = $some_variable; 

И наконец передаем массив

unknown_number_arguments($argument_set);

function yourFunction($var1, $var2, $optional = Null){
   ... code
}

Вы можете создать обычную функцию, а затем добавить дополнительные переменные, присвоив им значение Null по умолчанию.

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

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

Если вы используете разные значения, у вас есть 2 варианта.

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

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

PHP допускает аргументы по умолчанию ( ссылка ). В вашем случае вы можете определить все параметры от 3 до 8 как NULL или как пустую строку "" в зависимости от кода вашей функции. Таким образом, вы можете вызвать функцию только с использованием первых двух параметров.

Например:

<?php
  function yourFunction($arg1, $arg2, $arg3=NULL, $arg4=NULL, $arg5=NULL, $arg6=NULL, $arg7=NULL, $arg8=NULL){
echo $arg1;
echo $arg2;
if(isset($arg3)){echo $arg3;}
# other similar statements for $arg4, ...., $arg5
if(isset($arg8)){echo $arg8;}
}

Просто установите Null, чтобы игнорировать параметры, которые вы не хотите использовать, а затем установите необходимый параметр в соответствии с положением.

 function myFunc($p1,$p2,$p3=Null,$p4=Null,$p5=Null,$p6=Null,$p7=Null,$p8=Null){
    for ($i=1; $i<9; $i++){
        $varName = "p$i";
        if (isset($$varName)){
            echo $varName." = ".$$varName."<br>\n";
        }
    }
}   

myFunc( "1", "2", Null, Null, Null, Null, Null, "eight" );

func( "1", "2", default, default, default, default, default, "eight" );