Funkcja PHP z opcjonalnymi parametrami

Napisałem funkcję PHP, która akceptuje 10 parametrów, ale wymagane są tylko 2. Czasami chcę zdefiniować ósmy parametr, ale nie chcę wpisywać pustych ciągów dla każdego z parametrów, dopóki nie osiągnę ósmego.

Pomysł, jaki miałem, to przekazanie abstrakcyjnej funkcji z tablicą parametrów, która przekazuje ją do funkcji rzeczywistej.

Czy istnieje lepszy sposób na skonfigurowanie funkcji, aby móc przekazywać tylko te parametry, które chcę?

Niech funkcja przyjmuje jeden parametr: tablicę. Przekaż rzeczywiste parametry jako wartości w tablicy.

Edycja: link w komentarzu Pekki prawie to podsumowuje.

W tym przypadku przekazałem tablicę, w której kluczem jest nazwa parametru, a wartością jest wartość.

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

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

Aby osiągnąć to, co chcesz, użyj tablicy Jak powiedział Rabbot (chociaż może to stać się uciążliwe do dokumentowania / utrzymywania, jeśli jest używane nadmiernie). Lub po prostu użyj tradycyjnych opcjonalnych argumentów.

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

Jednak zwykle stwierdzam, że kiedy zaczynam pisać funkcję / metodę z tak wieloma argumentami - najczęściej jest to zapach kodu i można go ponownie przekształcić / wyabstrahować w coś znacznie czystszego.

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

W PHP 5.6 i późniejszych, listy argumentów mogą zawierać token ... oznaczający, że funkcja przyjmuje zmienną liczbę argumentów. Argumenty zostaną przekazane do podanej zmiennej jako tablica; na przykład:

Przykład Użycie ... do uzyskania dostępu do zmiennych argumentów

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

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

Powyższy przykład wyświetli:

10

Lista argumentów o zmiennej długości Dokumentacja PHP

Możesz po prostu ustawić wartość domyślną na null.

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

UWAGA: To jest stara odpowiedź, dla PHP 5.5 i starszych . PHP 5.6+ obsługuje domyślne argumenty

W PHP 5.5 i starszych możesz to osiągnąć za pomocą jednej z następujących 2 metod:

• używając funkcji func_num_args () i func_get_arg () ;
• używając argumentów NULL;

Jak używać

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

Wolę drugą metodę, ponieważ jest przejrzysta i łatwa do zrozumienia, ale czasami możesz potrzebować pierwszej metody.

Myślę, że możesz też używać obiektów jako nośników parametrów.

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

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

Oczywiście musisz ustawić domyślne wartości dla "optParam8" i "optParam2" w tej funkcji, w innym przypadku otrzymasz "Uwaga: Undefined property: stdClass :: $ optParam2"

Jeśli używasz tablic jako parametrów funkcji, podoba mi się ten sposób ustawiania wartości domyślnych:

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']."!";
}

Jeśli do utworzenia obiektu z prawidłowym stanem wymagane są tylko dwie wartości, możesz po prostu usunąć wszystkie inne opcjonalne argumenty i podać je ustawiające (chyba że nie chcesz, aby były zmieniane w czasie wykonywania). Następnie po prostu utwórz instancję obiektu z dwoma wymaganymi argumentami i ustaw pozostałe zgodnie z potrzebami za pomocą metody ustawiającej.

Dalsza lektura

• Martin Fowler on Constructor vs Setter Injection oraz
• Wstrzykiwanie zależności przez konstruktory lub metody ustawiające właściwości?

Wiem, że to stary post, ale miałem problem jak OP i to właśnie wymyśliłem.

Przykład tablicy, którą możesz przekazać. Możesz zamówić to ponownie, jeśli było wymagane określone zamówienie, ale w przypadku tego pytania zrobi to, o co zostało zadane.

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

Jest to łatwe w zarządzaniu, łatwe do odczytania, a punkty wyodrębniania danych można dodawać i usuwać w dowolnym momencie w dowolnym miejscu kodowania, a jednocześnie uniknąć masowego przepisywania. Użyłem kluczy całkowitych, aby dopasować się do oryginalnego pytania OP, ale klucze łańcuchowe mogą być równie łatwo używane. Właściwie dla czytelności radziłbym to.

Dla ułatwienia umieść to w zewnętrznym pliku

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

umieść to na początku, jeśli plik.

$argument_set = array(); 

Po prostu użyj ich, aby przypisać kolejną część danych numerację / nazewnictwo w zależności od tego, skąd pochodzą dane.

$argument_set[1][] = $some_variable; 

I na koniec przekaż tablicę

unknown_number_arguments($argument_set);

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

Możesz utworzyć zwykłą funkcję, a następnie dodać opcjonalne zmienne, nadając im domyślną wartość Null.

Wartość Null nadal jest wartością, jeśli nie wywołasz funkcji z wartością dla tej zmiennej, nie będzie ona pusta, więc nie ma błędu.

Jeśli zwykle przekazujesz tylko ósmą wartość, możesz zmienić kolejność parametrów, tak aby była pierwsza. Musisz tylko określić parametry aż do ostatniego, który chcesz ustawić.

Jeśli używasz różnych wartości, masz 2 opcje.

Jednym z nich byłoby utworzenie zestawu funkcji opakowujących, które przyjmują różne parametry i ustawiają wartości domyślne dla innych. Jest to przydatne, jeśli używasz tylko kilku kombinacji, ale może szybko się skomplikować.

Inną opcją jest przekazanie tablicy, w której klucze są nazwami parametrów. Możesz wtedy po prostu sprawdzić, czy w tablicy jest wartość z kluczem, a jeśli nie, użyj wartości domyślnej. Ale znowu, może to stać się bałaganiarskie i dodać dużo dodatkowego kodu, jeśli masz dużo parametrów.

PHP dopuszcza domyślne argumenty ( link ). W twoim przypadku możesz zdefiniować wszystkie parametry od 3 do 8 jako NULL lub jako pusty ciąg "" w zależności od kodu funkcji. W ten sposób możesz wywołać funkcję tylko przy użyciu pierwszych dwóch parametrów.

Na przykład:

<?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;}
}

Po prostu ustaw Null, aby ignorować parametry, których nie chcesz używać, a następnie ustaw wymagany parametr zgodnie z pozycją.

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