Funzione PHP con parametri opzionali

Ho scritto una funzione PHP che può accettare 10 parametri, ma solo 2 sono necessari. A volte, voglio definire l'ottavo parametro, ma non voglio digitare stringhe vuote per ciascuno dei parametri fino a quando non raggiungo l'ottavo.

Un'idea che avevo era quella di passare una funzione astratta con un array di parametri che la passasse alla funzione reale.

C'è un modo migliore per impostare la funzione in modo da poter passare solo i parametri che voglio?

Fai in modo che la funzione prenda un parametro: un array. Passa i parametri effettivi come valori nell'array.

Modifica: il collegamento nel commento di Pekka lo riassume quasi.

Quello che ho fatto in questo caso è passare un array, dove la chiave è il nome del parametro e il valore è il valore.

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

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

Per ottenere ciò che vuoi, usa un array come ha detto Rabbot (anche se questo può diventare un problema da documentare / mantenere se usato eccessivamente). Oppure usa semplicemente i tradizionali argomenti opzionali.

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

Tuttavia, di solito trovo che quando inizio a scrivere una funzione / metodo con così tanti argomenti, il più delle volte si tratta di un odore di codice e può essere ri-fattorizzato / astratto in qualcosa di molto più pulito.

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

In PHP 5.6 e versioni successive, gli elenchi di argomenti possono includere il token ... per indicare che la funzione accetta un numero variabile di argomenti. Gli argomenti verranno passati nella variabile data come un array; per esempio:

Esempio Utilizzo di ... per accedere agli argomenti delle variabili

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

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

L'esempio precedente produrrà:

10

L'argomento a lunghezza variabile elenca la documentazione PHP

Puoi semplicemente impostare il valore predefinito su null.

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

NOTA: questa è una vecchia risposta, per PHP 5.5 e versioni precedenti. PHP 5.6+ supporta gli argomenti predefiniti

In PHP 5.5 e versioni precedenti, puoi ottenere ciò utilizzando uno di questi 2 metodi:

• utilizzando le funzioni func_num_args () e func_get_arg () ;
• utilizzando argomenti NULL;

Come usare

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

Preferisco il secondo metodo perché è pulito e facile da capire, ma a volte potrebbe essere necessario il primo metodo.

Penso che tu possa usare gli oggetti anche come params-transport.

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

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

Ovviamente, devi impostare i valori predefiniti per "optParam8" e "optParam2" in questa funzione, in altri casi otterrai "Avviso: proprietà non definita: stdClass :: $ optParam2"

Se si utilizzano array come parametri di funzione, mi piace in questo modo impostare i valori predefiniti:

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

Se sono richiesti solo due valori per creare l'oggetto con uno stato valido, è possibile rimuovere semplicemente tutti gli altri argomenti opzionali e fornire i setter (a meno che non si desideri che vengano modificati in fase di esecuzione). Quindi basta istanziare l'oggetto con i due argomenti richiesti e impostare gli altri come necessario tramite il setter.

Ulteriore lettura

• Martin Fowler su Constructor vs Setter Injection e
• Inserimento di dipendenze tramite costruttori o setter di proprietà?

So che questo è un vecchio post, ma stavo avendo un problema come l'OP e questo è ciò che mi è venuto in mente.

Esempio di array che potresti passare. Puoi riordinarlo se è richiesto un ordine particolare, ma per questa domanda questo farà ciò che viene richiesto.

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

Questo è gestibile, facile da leggere e i punti di estrazione dei dati possono essere aggiunti e rimossi in un momento in qualsiasi punto della codifica ed evitare comunque una massiccia riscrittura. Ho usato i tasti interi per coincidere con la domanda originale dell'OP, ma i tasti stringa potevano essere usati altrettanto facilmente. Infatti per leggibilità lo consiglierei.

Inseriscilo in un file esterno per facilità

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

mettilo all'inizio se il file.

$argument_set = array(); 

Basta usarli per assegnare la numerazione / denominazione al pezzo successivo di dati in base alla provenienza dei dati.

$argument_set[1][] = $some_variable; 

E infine passa l'array

unknown_number_arguments($argument_set);

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

È possibile creare una funzione regolare e quindi aggiungere le variabili facoltative assegnando loro un valore Null predefinito.

Un Null è ancora un valore, se non chiami la funzione con un valore per quella variabile, non sarà vuoto, quindi nessun errore.

Se di solito passi solo l'ottavo valore, puoi riordinare i parametri in modo che sia il primo. Devi solo specificare i parametri fino all'ultimo che vuoi impostare.

Se stai usando valori diversi, hai 2 opzioni.

Uno potrebbe essere quello di creare un insieme di funzioni wrapper che accettano parametri diversi e impostano i valori predefiniti sugli altri. Questo è utile se usi solo poche combinazioni, ma può diventare molto disordinato rapidamente.

L'altra opzione è passare un array in cui le chiavi sono i nomi dei parametri. È quindi possibile verificare se nell'array è presente un valore con una chiave e, in caso contrario, utilizzare il valore predefinito. Ma ancora una volta, questo può diventare disordinato e aggiungere molto codice extra se hai molti parametri.

PHP consente argomenti predefiniti ( collegamento ). Nel tuo caso, puoi definire tutti i parametri da 3 a 8 come NULL o come una stringa vuota "" a seconda del codice della funzione. In questo modo è possibile chiamare la funzione solo utilizzando i primi due parametri.

Per esempio:

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

Basta impostare Null per ignorare i parametri che non si desidera utilizzare e quindi impostare il parametro necessario in base alla posizione.

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