The PHP ArrayIterator::offsetSet API performs a focused operation on an object or value. The examples below show its effect on actual data.
Creates or replaces an entry at the specified key, changing the collection.
What Is ArrayIterator::offsetSet in PHP?
Creates or replaces an entry at the specified key, changing the collection.
Syntax:
ArrayIterator::offsetSet(mixed $key, mixed $value)The method accepts the following parameters:
$key— Required. The entry key used for reading, writing, or checking an item.$value— Required. The value to insert, store, or write; its accepted type depends on the underlying collection.
Return type declared by PHP: mixed / not explicitly declared. The value or side effect is demonstrated in the examples below.
Example 1: Basic Usage
This example uses a small input to make the main behavior visible.
<?php
$arrayIterator = new ArrayIterator(["pear" => 4, "apple" => 2, "plum" => 9]);
$arrayIterator->offsetSet("status", "active");
print_r($arrayIterator->getArrayCopy());Output:
Array
(
[pear] => 4
[apple] => 2
[plum] => 9
[status] => active
)Creates or replaces an entry at the specified key, changing the collection.
Example 2: A Different Input
A different set of values shows the same operation in another situation.
<?php
$arrayIterator = new ArrayIterator(["first" => "draft", "second" => "ready", "third" => "done"]);
$arrayIterator->offsetSet("status", "active");
print_r($arrayIterator->getArrayCopy());Output:
Array
(
[first] => draft
[second] => ready
[third] => done
[status] => active
)These operations affect iterator position or entries of the ArrayIterator instance, not an unrelated source array.
Practical Example: Applying the Feature
This example shows an application-style use of the feature, with its surrounding setup visible.
<?php
$arrayIterator = new ArrayIterator([10, 20, 30, 40]);
$arrayIterator->offsetSet("status", "active");
print_r($arrayIterator->getArrayCopy());Output:
Array
(
[0] => 10
[1] => 20
[2] => 30
[3] => 40
[status] => active
)The code is shown for learning. Adjust the class names, inputs and error handling to suit your application.
Important Behavior and Edge Cases
- These operations affect iterator position or entries of the ArrayIterator instance, not an unrelated source array.
- Creates or replaces an entry at the specified key, changing the collection.
- Observe differences in empty inputs, invalid states and optional extension availability where relevant.
Comparison With Related Approaches
| Approach | Important Difference |
|---|---|
ArrayIterator::offsetSet | Creates or replaces an entry at the specified key, changing the collection. |
| ArrayObject | ArrayObject is a container that supplies an iterator, while ArrayIterator itself holds the cursor and traversal methods. |
Common Beginner Mistakes
| Mistake | Correct Approach |
|---|---|
Ignoring the documented state or precondition of ArrayIterator::offsetSet | These operations affect iterator position or entries of the ArrayIterator instance, not an unrelated source array. |
| Expecting a different type of result | Read the declared return type and distinguish returned values from changes to the source object. |
| Assuming a related API works identically | ArrayObject is a container that supplies an iterator, while ArrayIterator itself holds the cursor and traversal methods. |
Key Takeaways
- Creates or replaces an entry at the specified key, changing the collection.
- These operations affect iterator position or entries of the ArrayIterator instance, not an unrelated source array.
- Use the example that matches the values, runtime version and dependencies in your application.
ArrayIterator::offsetSet is useful when its behavior matches the data structure and lifecycle of your PHP application. Choose it with a clear understanding of its preconditions and returned values.