php8.5
Home/ Manual/ ds / sequence/ Ds\Sequence::remove

Ds\Sequence::remove

PHP function Edit on GitHub ✎

(PECL ds >= 1.0.0)

Removes and returns a value by index

Description

Ds\Sequence::remove(int $index): mixed

Removes and returns a value by index.

Parameters

index

The index of the value to remove.

Return Values

The value that was removed.

Errors/Exceptions

OutOfRangeException if the index is not valid.

Examples

Ds\Sequence::remove() example

php
<?php
$sequence = new \Ds\Vector(["a", "b", "c"]);

var_dump($sequence->remove(1));
var_dump($sequence->remove(0));
var_dump($sequence->remove(0));
?>

The above example will output something similar to:

output
string(1) "b"
string(1) "a"
string(1) "c"

Source: reference/ds/ds/sequence/remove.xml · from the official PHP manual (php/doc-en)