【PHP8.x】SplFixedArray::getSize()メソッドの使い方

getSizeメソッドの使い方について、初心者にもわかりやすく解説します。

作成日: 2025年09月11日更新日: 2026年01月10日

基本的な使い方

getSizeメソッドは、SplFixedArrayオブジェクトに現在格納されている要素の数を取得するメソッドです。

SplFixedArrayは、あらかじめ指定された固定サイズの配列を効率的に扱うためにPHPに用意された特殊なクラスです。通常のPHP配列とは異なり、一度サイズを設定すると、後からそのサイズを変更することはできません。このような固定長の特性を持つ配列では、現在の要素数を正確に把握することが重要になります。

このgetSizeメソッドは、SplFixedArrayが保持している要素の総数を簡単に確認するために利用されます。メソッドは引数を一切取らず、戻り値として現在の要素数を表す整数値（int型）を返します。例えば、SplFixedArrayのすべての要素に対して繰り返し処理を行いたい場合や、配列の現在の大きさをプログラム内で判断したい場合に、getSizeメソッドを使用することで正確な情報を得られます。固定長配列のメモリ効率やパフォーマンスを最大限に活かすためには、そのサイズを適切に管理することが求められるため、getSizeメソッドはSplFixedArrayを効果的に利用する上で非常に役立つ機能の一つです。

構文(syntax)


1<?php
2$fixedArray = new SplFixedArray(5);
3echo $fixedArray->getSize();
4?>

引数(parameters)

引数なし

引数はありません

戻り値(return)

int

SplFixedArray インスタンスの要素数を整数で返します。

サンプルコード

PHP SplFixedArray のサイズを取得する


1<?php
2
3/**
4 * SplFixedArray クラスの getSize メソッドの使用例を示します。
5 * SplFixedArray は固定サイズの配列であり、getSize メソッドでその配列に格納されている要素の数を取得します。
6 */
7function demonstrateSplFixedArraySize(): void
8{
9    // サイズを3として SplFixedArray を初期化します。
10    // この配列は最大3つの要素を格納できます。
11    $fixedArray = new SplFixedArray(3);
12
13    // 配列の各インデックスに要素をセットします。
14    $fixedArray[0] = '要素A';
15    $fixedArray[1] = '要素B';
16    $fixedArray[2] = '要素C';
17
18    // SplFixedArray::getSize() メソッドを使用して、配列の現在の要素数を取得します。
19    // このメソッドは、配列が初期化された際の固定サイズを整数で返します。
20    $size = $fixedArray->getSize();
21
22    echo "SplFixedArray のサイズ (要素数): " . $size . "\n";
23
24    // サイズ0の SplFixedArray の例
25    $emptyFixedArray = new SplFixedArray(0);
26    $emptySize = $emptyFixedArray->getSize();
27    echo "空の SplFixedArray のサイズ (要素数): " . $emptySize . "\n";
28}
29
30// 関数を実行し、SplFixedArray のサイズ取得の動作を確認します。
31demonstrateSplFixedArraySize();
32
33?>

PHPのSplFixedArrayは、あらかじめ決められた固定サイズの配列を扱うためのクラスです。通常のPHP配列とは異なり、一度サイズを決定するとその容量は変化しません。このSplFixedArray::getSize()メソッドは、その固定サイズ、つまり配列が最大でいくつの要素を格納できるかを整数で取得するために使われます。

このメソッドは引数を一切必要とせず、SplFixedArrayが初期化時に指定されたサイズをint型の数値として返します。例えば、new SplFixedArray(3)で生成された配列では、getSize()は常に「3」を返します。これは、実際に配列に要素がいくつ格納されているかではなく、配列の容量そのものを示します。

サンプルコードでは、サイズ3で初期化した$fixedArrayに対してgetSize()を呼び出し、「3」という結果を出力しています。同様に、サイズ0で初期化した$emptyFixedArrayでは「0」が返されます。これにより、プログラムはSplFixedArrayの最大容量を正確に把握し、メモリ管理やループ処理などに活用することができます。

SplFixedArray::getSize()メソッドは、配列の初期化時に指定した固定サイズ（最大容量）を返します。これは、PHPのcount()関数が返す現在の要素数とは異なるため、混同しないよう注意が必要です。getSize()は、あくまで配列が確保できる最大の領域を示します。実際に格納済みの要素数を把握するには、別途カウントロジックが必要です。SplFixedArrayは、固定長でパフォーマンスが求められる場合に有効です。