SplFixedArray クラス

(PHP 5 >= 5.3.0, PHP 7, PHP 8)

はじめに

SplFixedArray クラスは配列の主要な機能を提供します。 SplFixedArray と通常の PHP の配列との主な違いは、 SplFixedArray は手動でリサイズしなければならないことと、整数値で指定した範囲内の添字しか使用できないところです。これにより、標準の array よりメモリ消費が少なくて済みます。

クラス概要

class SplFixedArray implements IteratorAggregate, ArrayAccess, Countable, JsonSerializable {

/* メソッド */

public __construct(int $size = 0)

public count(): int

public current(): mixed

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

public getIterator(): Iterator

public getSize(): int

public jsonSerialize(): array

public key(): int

public next(): void

public offsetExists(int $index): bool

public offsetGet(int $index): mixed

public offsetSet(int $index, mixed $value): void

public offsetUnset(int $index): void

public rewind(): void

public __serialize(): array

public setSize(int $size): true

public toArray(): array

public __unserialize(array $data): void

public valid(): bool

#[\Deprecated]
public __wakeup(): void

}

変更履歴

バージョン	説明
8.2.0	マジックメソッド SplFixedArray::__serialize() と SplFixedArray::__unserialize() が、SplFixedArray に追加されました。
8.1.0	SplFixedArray は、 JsonSerializable を実装するようになりました。
8.0.0	SplFixedArray は、 IteratorAggregate を実装するようになりました。これより前のバージョンでは、 Iterator を実装していました。

例

例1 SplFixedArray の使用例

<?php
// 固定長の配列を初期化します
$array = new SplFixedArray(5);

$array[1] = 2;
$array[4] = "foo";

var_dump($array[0]); // NULL
var_dump($array[1]); // int(2)

var_dump($array["4"]); // string(3) "foo"

// 配列のサイズを 10 に拡大します
$array->setSize(10);

$array[9] = "asdf";

// 配列のサイズを 2 に縮めます
$array->setSize(2);

// 以下は RuntimeException: Index invalid or out of range となります
try {
    var_dump($array["non-numeric"]);
} catch(RuntimeException $re) {
    echo "RuntimeException: ".$re->getMessage()."\n";
}

try {
    var_dump($array[-1]);
} catch(RuntimeException $re) {
    echo "RuntimeException: ".$re->getMessage()."\n";
}

try {
    var_dump($array[5]);
} catch(RuntimeException $re) {
    echo "RuntimeException: ".$re->getMessage()."\n";
}
?>

上の例の出力は以下となります。

NULL
int(2)
string(3) "foo"
RuntimeException: Index invalid or out of range
RuntimeException: Index invalid or out of range
RuntimeException: Index invalid or out of range

SplFixedArray::__construct — 新しい固定長配列を作成する
SplFixedArray::count — 配列のサイズを返す
SplFixedArray::current — 現在の配列の要素を返す
SplFixedArray::fromArray — PHP の配列を SplFixedArray インスタンスにインポートする
SplFixedArray::getIterator — 配列を走査するためのイテレータを取得する
SplFixedArray::getSize — 配列のサイズを取得する
SplFixedArray::jsonSerialize — JSON に変換可能な値の表現を返す
SplFixedArray::key — 現在の配列の添字を返す
SplFixedArray::next — 次のエントリに進む
SplFixedArray::offsetExists — 指定した添字が存在するかどうかを返す
SplFixedArray::offsetGet — 指定した添字の値を返す
SplFixedArray::offsetSet — 指定した添字の新しい値を設定する
SplFixedArray::offsetUnset — 指定した添字の値を消去する
SplFixedArray::rewind — イテレータを先頭に巻き戻す
SplFixedArray::__serialize — SplFixedArray オブジェクトをシリアライズする
SplFixedArray::setSize — 配列のサイズを変更する
SplFixedArray::toArray — 固定長配列から PHP の配列を返す
SplFixedArray::__unserialize — data パラメータを SplFixedArray オブジェクトに復元する
SplFixedArray::valid — 配列にまだ要素があるかどうかを調べる
SplFixedArray::__wakeup — アンシリアライズ後に配列を再初期化する

SplFixedArray クラス

はじめに

クラス概要

変更履歴

例

目次