Webエンジニア向けプログラミング解説動画をYouTubeで配信中!
▶ チャンネル登録はこちら

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

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

作成日: 更新日:

基本的な使い方

getCompressedSizeメソッドは、Pharアーカイブ内のファイルの圧縮されたサイズを取得するメソッドです。

このメソッドは、PHPアプリケーションの配布やデプロイを容易にするPharアーカイブにおいて、個々のファイルに関する情報を提供するPharFileInfoクラスに属しています。Pharアーカイブは、複数のPHPスクリプトやその他のリソースを一つのアーカイブファイルにまとめることができる仕組みです。PharFileInfoオブジェクトは、そのアーカイブ内に含まれる特定のファイルやディレクトリを表現します。

getCompressedSizeメソッドを実行すると、対象のファイルがPharアーカイブ内でZLIBやBZIP2などの圧縮アルゴリズムによって圧縮された後の、実際のバイト単位のサイズが整数値で返されます。この値は、ファイルが圧縮される前の元のサイズ(非圧縮サイズ)とは異なり、ディスク上で実際に消費されているストレージ容量を示します。

このメソッドを利用することで、Pharアーカイブ内の各ファイルがどの程度ディスク容量を節約しているかを把握したり、アーカイブ全体のストレージ効率を評価したりすることが可能になります。ファイルサイズを最適化する際や、アーカイブの内容を分析する際に役立つ情報です。

構文(syntax)

1<?php
2// $pharFileInfo は PharFileInfo クラスのインスタンスです。
3$compressedSize = $pharFileInfo->getCompressedSize();
4?>

引数(parameters)

引数なし

引数はありません

戻り値(return)

int

PharFileInfo::getCompressedSizeは、圧縮されたファイル(.pharファイル)のサイズをバイト単位で整数(int)で返します。

関連コンテンツ