SplFixedArray

class SplFixedArray implements Iterator, ArrayAccess, Countable, IteratorAggregate, JsonSerializable (View source)

The SplFixedArray class provides the main functionalities of array. The main difference between a SplFixedArray and a normal PHP array is that the SplFixedArray must be resized manually and allows only integers within the range as indexes. The advantage is that it uses less memory than a standard array.

Methods

__construct(int $size = 0)

Constructs a new fixed array

int
count()

Returns the size of the array

array
toArray()

Returns a PHP array from the fixed array

static SplFixedArray
fromArray(array $array, bool $preserveKeys = true)

Import a PHP array in a SplFixedArray instance

int
getSize()

Gets the size of the array

bool
setSize(int $size)

Change the size of an array

bool
offsetExists(int $index)

Returns whether the requested index exists

mixed
offsetGet(int $index)

Returns the value at the specified index

void
offsetSet(int $index, TValue $value)

Sets a new value at a specified index

void
offsetUnset(int $index)

Unsets the value at the specified $index

void
rewind()

Rewind iterator back to the start

mixed
current()

Return current array entry

mixed
key()

Return current array index

void
next()

Move to next entry

bool
valid()

Check whether the array contains more elements

void
__wakeup()

Reinitialises the array after being unserialised

array
__serialize()

Serializes the SplFixedArray object

void
__unserialize(array $data)

Deserializes the data parameter into an SplFixedArray object

Traversable
getIterator()

Retrieve the iterator to go through the array

mixed
jsonSerialize()

Returns a representation that can be converted to JSON

Details

at line 1932
__construct(int $size = 0)

Constructs a new fixed array

Parameters

int $size [optional]

Exceptions

ValueError

at line 1939
int count()

Returns the size of the array

Return Value

int

The custom count as an integer.

The return value is cast to an integer.

at line 1947
array toArray()

Returns a PHP array from the fixed array

Return Value

array

a PHP array, similar to the fixed array.

at line 1962
static SplFixedArray fromArray(array $array, bool $preserveKeys = true)

Import a PHP array in a SplFixedArray instance

Parameters

array $array

The array to import.

bool $preserveKeys

[optional]

Try to save the numeric indexes used in the original array.

Return Value

SplFixedArray

an instance of SplFixedArray containing the array content.

at line 1973
int getSize()

Gets the size of the array

Return Value

int

the size of the array, as an integer.

at line 1985
bool setSize(int $size)

Change the size of an array

Parameters

int $size

The new array size.

Return Value

bool

Always returns true.

Exceptions

ValueError

at line 1997
bool offsetExists(int $index)

Returns whether the requested index exists

Parameters

int $index

The index being checked.

Return Value

bool

true on success or false on failure.

The return value will be casted to boolean if non-boolean was returned.

at line 2010
mixed offsetGet(int $index)

Returns the value at the specified index

Parameters

int $index

The index with the value.

Return Value

mixed

Can return all value types.

Exceptions

RuntimeException

at line 2026
void offsetSet(int $index, TValue $value)

Sets a new value at a specified index

Parameters

int $index

The index being set.

TValue $value

The value to set.

Return Value

void

No value is returned.

Exceptions

RuntimeException

at line 2039
void offsetUnset(int $index)

Unsets the value at the specified $index

Parameters

int $index

The index being unset.

Return Value

void

No value is returned.

Exceptions

RuntimeException

at line 2048
void rewind()

Rewind iterator back to the start

Return Value

void

Any returned value is ignored.

at line 2058
mixed current()

Return current array entry

Return Value

mixed

Can return any type.

Exceptions

RuntimeException

at line 2066
mixed key()

Return current array index

Return Value

mixed

TKey on success, or null on failure.

at line 2074
void next()

Move to next entry

Return Value

void

Any returned value is ignored.

at line 2082
bool valid()

Check whether the array contains more elements

Return Value

bool

The return value will be casted to boolean and then evaluated. Returns true on success or false on failure.

at line 2090
void __wakeup()

Reinitialises the array after being unserialised

Return Value

void

No value is returned.

at line 2099
array __serialize()

Serializes the SplFixedArray object

Return Value

array

at line 2108
void __unserialize(array $data)

Deserializes the data parameter into an SplFixedArray object

Parameters

array $data

The value being deserialized.

Return Value

void

No value is returned.

at line 2121
Traversable getIterator()

Since: 8.0

Retrieve the iterator to go through the array

Returns the iterator to go through the array.

Return Value

Traversable

An instance of an object implementing Iterator or Traversable

at line 2132
mixed jsonSerialize()

Returns a representation that can be converted to JSON

Serializes the array to a value that can be serialized natively by json_encode.

Return Value

mixed

data which can be serialized by json_encode, which is a value of any type other than a resource.