The ArrayObject class

The ArrayObject class

Introduction

(PHP 5, PHP 7, PHP 8)

This class allows objects to work as arrays.

Class synopsis

class ArrayObject implements IteratorAggregate, ArrayAccess, Serializable, Countable {

/* Constants */

const int STD_PROP_LIST = 1;

const int ARRAY_AS_PROPS = 2;

/* Methods */

public __construct(array|object $array = [], int $flags = 0, string $iteratorClass = ArrayIterator::class)

public append(mixed $value): void

public asort(int $flags = SORT_REGULAR): bool

public count(): int

public exchangeArray(array|object $array): array

public getArrayCopy(): array

public getFlags(): int

public getIterator(): Iterator

public getIteratorClass(): string

public ksort(int $flags = SORT_REGULAR): bool

public natcasesort(): bool

public natsort(): bool

public offsetExists(mixed $key): bool

public offsetGet(mixed $key): mixed

public offsetSet(mixed $key, mixed $value): void

public offsetUnset(mixed $key): void

public serialize(): string

public setFlags(int $flags): void

public setIteratorClass(string $iteratorClass): void

public uasort(callable $callback): bool

public uksort(callable $callback): bool

public unserialize(string $data): void

}

Predefined Constants

ArrayObject Flags

ArrayObject::STD_PROP_LIST

Properties of the object have their normal functionality when accessed as list (var_dump, foreach, etc.).

ArrayObject::ARRAY_AS_PROPS

Entries can be accessed as properties (read and write).

Table of Contents

• ArrayObject::append — Appends the value
• ArrayObject::asort — Sort the entries by value
• ArrayObject::__construct — Construct a new array object
• ArrayObject::count — Get the number of public properties in the ArrayObject
• ArrayObject::exchangeArray — Exchange the array for another one
• ArrayObject::getArrayCopy — Creates a copy of the ArrayObject
• ArrayObject::getFlags — Gets the behavior flags
• ArrayObject::getIterator — Create a new iterator from an ArrayObject instance
• ArrayObject::getIteratorClass — Gets the iterator classname for the ArrayObject
• ArrayObject::ksort — Sort the entries by key
• ArrayObject::natcasesort — Sort an array using a case insensitive "natural order" algorithm
• ArrayObject::natsort — Sort entries using a "natural order" algorithm
• ArrayObject::offsetExists — Returns whether the requested index exists
• ArrayObject::offsetGet — Returns the value at the specified index
• ArrayObject::offsetSet — Sets the value at the specified index to newval
• ArrayObject::offsetUnset — Unsets the value at the specified index
• ArrayObject::serialize — Serialize an ArrayObject
• ArrayObject::setFlags — Sets the behavior flags
• ArrayObject::setIteratorClass — Sets the iterator classname for the ArrayObject
• ArrayObject::uasort — Sort the entries with a user-defined comparison function and maintain key association
• ArrayObject::uksort — Sort the entries by keys using a user-defined comparison function
• ArrayObject::unserialize — Unserialize an ArrayObject

© 1997–2020 The PHP Documentation Group
Licensed under the Creative Commons Attribution License v3.0 or later.
https://www.php.net/manual/en/class.arrayobject.php