pht\Vector::shift

(PECL pht >= 0.0.1)

pht\Vector::shiftShifts a value from the vector

Description

public pht\Vector::shift ( void ) : mixed

This method shifts a value from the front of a vector (in linear time). Shifting a value from an empty vector will result in an Error exception.

Parameters

This function has no parameters.

Return Values

The value from the front of the vector.

Examples

Example #1 Shifting a value from a vector

<?php

use pht\Vector;

$vector = new Vector();

$vector->push(1);
$vector[] = 2;

var_dump($vector->shift());

The above example will output:

int(1)