【PHP8.x】countメソッドの使い方
countメソッドの使い方について、初心者にもわかりやすく解説します。
基本的な使い方
countメソッドは、GlobIteratorオブジェクトが、指定されたグローバル(glob)パターンに一致するファイルまたはディレクトリの総数を取得するメソッドです。
このメソッドはGlobIteratorクラスに属しており、PHPの標準インターフェースであるCountableを実装しています。そのため、通常の配列やオブジェクトに対してcount()関数を使用するのと同じように、GlobIteratorオブジェクトをcount()関数に渡すことで、このcountメソッドが内部的に呼び出され、条件に合致する要素の数が返されます。
countメソッドは、イテレータが実際に反復処理を行う前に、指定したglobパターン(例えば*.logやimages/*.pngなど)に合致するファイルやディレクトリがいくつ存在するのかを事前に把握したい場合に特に役立ちます。これにより、ファイルやディレクトリの存在確認、処理対象の件数を事前に把握して条件分岐を行う、あるいは進行状況を示す際などに利用できます。
戻り値は、条件に一致したファイルおよびディレクトリの総数を示す整数値です。
例えば、new GlobIterator('/path/to/files/*.txt')といった形で作成されたイテレータに対してcount()関数を適用すると、/path/to/filesディレクトリ内のすべての.txtファイルの数を正確に取得できます。
ファイルシステムのコンテンツを効率的に管理・操作するための、非常に便利な機能の一つです。
構文(syntax)
1<?php 2 3$iterator = new GlobIterator('*.txt'); 4count($iterator);
引数(parameters)
引数なし
引数はありません
戻り値(return)
int
GlobIterator::count メソッドは、グローバリゼーションパターンに一致したファイルおよびディレクトリの総数を整数型(int)で返します。