Wiki - 1 output

backSet : modifie la valeur d’une variable, tout en récupérant l’ancienne valeur.

Description

mixed backSet ( mixed &$variable, mixed $value )

backSet copie la valeur de $value dans $variable , et renvoie l’ancienne valeur de $variable .

L’usage commun est de modifier temporairement la valeur d’une variable, pour la rétablir ensuite. Cette fonction apporte une écriture simplifiée de ce pattern.

Liste de paramètres

• $variable
  La variable dont on veut modifier la valeur tout en récupérant l’ancienne valeur.

• $value
  La nouvelle valeur à stocker dans $variable .

Valeurs de retour

Cette fonction retourne l’ancienne valeur de $variable .

Exemple

Le cas d’usage courant est de modifier temporairement la valeur d’une variable, donc en gardant son ancienne valeur pour la rétablir à la fin d’un traitement :

$old_value = backSet($my_var, 'temporary value');
// traitements ici qui utilisent $my_var avec sa valeur temporaire
$my_var = $old_value;

L’appel à backSet est juste une facilité syntaxique pour éviter la répétition de $my_var . Un équivalent plus verbeux sans backSet serait :

$old_value = $my_var;
$my_var = 'temporary_value';
// traitements ici qui utilisent $my_var avec sa valeur temporaire
$my_var = $old_value;