Функція PHP з додатковими параметрами

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

Однією з ідей у ​​мене була передача абстрагованої функції з масивом параметрів, які передають її реальній функції.

Чи є кращий спосіб налаштування функції, щоб я міг передати лише потрібні параметри?

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

Редагувати: посилання в коментарі Пекки майже підсумовує її.

У цьому випадку я зробив передачу масиву, де ключовим є ім'я параметра, а значення - значення.

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

У 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";
}

Я віддаю перевагу другий метод, тому що він чистий і легкий для розуміння, але іноді може знадобитися перший метод.

Я думаю, ви також можете використовувати предмети як парам-транспорти.

$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" в цій функції, в іншому випадку ви отримаєте "Примітка: Не визначене властивість: 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');

Це керовано, легко для читання, а пункти вилучення даних можна додавати та видаляти на моменти, помітні в будь-якому місці кодування, і все ж уникати масового перезапису. Я використовував цілі клавіші, щоб порівнювати з початковим питанням про ОП, але рядкові клавіші можна було використовувати так само легко. Насправді для читабельності я б порадив це.

Вставте це у зовнішній файл для зручності

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 - це все-таки значення, якщо ви не викликаєте функцію зі значенням для цієї змінної, вона не буде порожньою, тому помилки не буде.

Якщо ви зазвичай просто передаєте восьме значення, ви можете змінити порядок своїх параметрів, щоб він був першим. Вам потрібно лише вказати параметри до останнього, який потрібно встановити.

Якщо ви використовуєте різні значення, у вас є 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" );