Retourner des références

Retourner des références est utile lorsque l'on souhaite utiliser une fonction pour déterminer à quelle variable une référence devrait être liée. Il ne faut pas utiliser le retour par référence pour améliorer les performances, le moteur est suffisamment robuste pour optimiser cela en interne. Il convient de ne retourner des références que lorsqu'il y a de bonnes raisons techniques de le faire. Pour retourner des références, utiliser cette syntaxe :

<?php

class Foo
{
    public $value = 42;

    public function &getValue()
    {
        return $this->value;
    }
}

$obj = new Foo();
$myValue = &$obj->getValue(); // $myValue est une référence de $obj->value, qui vaut 42.
$obj->value = 2;
echo $myValue;                // affiche la nouvelle valeur de $obj->value, i.e. 2.

?>

Dans cet exemple, on affecte une valeur à la propriété de l'objet retourné par la fonction getValue, et non à sa copie, comme ce serait le cas si nous n'avions pas utilisé la syntaxe de référence.

Note: Contrairement au passage de paramètre, ici, il faut utiliser & aux deux endroits, à la fois pour indiquer le retour par référence (pas par copie), et pour indiquer l'assignation aussi par référence (pas par copie non plus) pour la variable $myValue.

Note: Tenter de retourner une référence depuis une fonction avec la syntaxe : return ($this->value);, ne fonctionnera pas comme attendu, et retournera le résultat de l'expression, et pas de la variable, par référence. Seules des variables peuvent être retournées par référence depuis une fonction - et rien d'autre.

Pour utiliser la référence retournée, il faut utiliser l'affectation par référence :

<?php

function &collector()
{
    static $collection = array();
    return $collection;
}

$collection = &collector();
// Désormais, la variable $collection est une variable par référence qui référence le tableau static à l’intérieur de la fonction

$collection[] = 'foo';

print_r(collector());
// Array
// (
//    [0] => foo
// )

?>

Note: Si l'affectation est faite sans le symbole &, par exemple $collection = collector();, la variable $collection recevra une copie de la valeur, et non la référence retournée par la fonction.

Pour passer la référence retournée à une autre fonction attendant une référence, il est possible d'utiliser la syntaxe suivante :

<?php

function &collector()
{
    static $collection = array();
    return $collection;
}

array_push(collector(), 'foo');

?>

Note: Il est à noter que array_push(&collector(), 'foo'); ne fonctionnera pas, et résultera en une erreur fatale.