Description

Anemone::first(bool $take = false): mixed;

This method returns the first item in the data. Optionally, takes it from the current data. If the data is empty, this method returns null. It does not modify the data.

Example

$anemone = new Anemone([1, 2, 3, 4, 5]);

$first = $anemone->first(); // Returns `1`
$all = $anemone->get(); // Returns `[1, 2, 3, 4, 5]`

$first = $anemone->first(true); // Returns `1`
$all = $anemone->get(); // Returns `[2, 3, 4, 5]`

$anemone = new Anemone([
    'a' => 1,
    'b' => 2,
    'c' => 3,
    'd' => 4,
    'e' => 5
]);

$first = $anemone->first(); // Returns `1`
$all = $anemone->get(); // Returns `['a' => 1, 'b' => 2, 'c' => 3, 'd' => 4, 'e' => 5]`

$first = $anemone->first(true); // Returns `1`
$all = $anemone->get(); // Returns `['b' => 2, 'c' => 3, 'd' => 4, 'e' => 5]`