PHP-функция с необязательными параметрами



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



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

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

1164   11  

11 ответов:

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


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

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

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

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

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

//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');

Примечание: это старый пост, но может помочь кому-то сейчас или в будущем.

Вы можете достичь этого, используя один из этих 2 методов:

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

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

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

function method_2($arg1 = null, $arg2 = null)
{
  $arg1 = $arg1? $arg1: "default_value_fot_arg1";
  $arg2 = $arg2? $arg2: "default_value_fot_arg2";
}
Я предпочитаю второй метод, потому что он чистый и простой для понимания, но иногда вам может понадобиться первый метод.

В 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 Documentation

Я думаю, что вы также можете использовать объекты в качестве 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']."!";
}

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

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

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

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

$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);

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

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

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

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

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

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

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

Comments

    Ничего не найдено.