CakeFest 2024: The Official CakePHP Conference

ArrayObject::offsetGet

(PHP 5, PHP 7, PHP 8)

ArrayObject::offsetGetRetourne la valeur de l'index spécifié

Description

public ArrayObject::offsetGet(mixed $key): mixed

Liste de paramètres

key

L'index demandé.

Valeurs de retour

La valeur à l'index ou null.

Erreurs / Exceptions

Produit une alerte de niveau E_NOTICE lorsque l'index spécifié n'existe pas.

Exemples

Exemple #1 Exemple avec ArrayObject::offsetGet()

<?php
$arrayobj
= new ArrayObject(array('zero', 7, 'example'=>'e.g.'));
var_dump($arrayobj->offsetGet(1));
var_dump($arrayobj->offsetGet('example'));
var_dump($arrayobj->offsetExists('notfound'));
?>

L'exemple ci-dessus va afficher :

int(7)
string(4) "e.g."
bool(false)

add a note

User Contributed Notes 3 notes

up
4
Jason
7 years ago
It's worth noting that the PHP devs *did* fix the issue brought up in Sam's comment in 2013 (per the comment thread in his link here: https://bugs.php.net/bug.php?id=34783#1366088374), since at least PHP 5.3.8.

So, you *can* (and in most cases should) overload offsetGet with reference syntax to get expected functionality:

<?php
class myArrayType extends ArrayAccess {

public function &
offsetGet($index) {
// ...
}

}
?>
up
5
Sam
16 years ago
If you're overloading ArrayObject, it's worth noting that while this method (when implemented by the parent) will return a reference, so code like $fakeArray['foobar']['hello'] = 1; will work like you expect.

However, when you overload the offsetGet method, you CANNOT define it as &offsetGet, so the above code falls out (because it returns the 'foobar' variable before you actually work with it).

This is something that the developers broke between 5.0 and 5.1, and was closed as bogus (http://bugs.php.net/bug.php?id=34783). So this is not a big, or question, or request, but just something worth noting.
up
2
Alex Andrienko
15 years ago
Speaking of offsetGet() method overloading, be advised, that if you're iterating through Object via foreach, this method wouldn't be called. Iterator's current() method will be called instead.
To Top