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

【PHP8.x】STREAM_URL_STAT_LINK定数の使い方

STREAM_URL_STAT_LINK定数の使い方について、初心者にもわかりやすく解説します。

作成日: 更新日:

基本的な使い方

STREAM_URL_STAT_LINK定数は、PHPのストリームラッパーがURLの情報を取得する際の挙動を制御するためのオプションを表す定数です。PHPには、http://ftp://のようなURLをあたかもファイルのように扱える「ストリームラッパー」という便利な仕組みが備わっています。例えば、file_exists()filesize()といったファイル操作関数は、通常のローカルファイルだけでなく、これらのURLに対しても情報を取得しようとすることがあります。

この定数は、ストリームラッパーに対して、参照されるURLがもし別のURLへの「リンク」(ウェブページのリダイレクトやエイリアスのような概念)である場合に、そのリンク「自体」の情報を取得すべきか、それともリンクが指し示す「最終的な対象」の情報を取得すべきかを指示するために使われます。これは、ファイルシステムにおけるシンボリックリンクを扱うlstat()関数の振る舞いに似ており、リンク先のファイル情報ではなく、リンクそのものの属性(例えば、リダイレクトの設定情報など)が必要な場合に、この定数をフラグとして指定することで、その情報を要求することができます。

主に、PHPで独自のカスタムストリームラッパーを開発する際、streamWrapper::url_stat()メソッドの実装において、呼び出し元がどのようなURL情報を求めているかを正確に判断し、適切なデータを提供するために利用されます。これにより、URLの種類や状況に応じた柔軟な情報取得が可能になります。

構文(syntax)

1<?php
2$option_flag = STREAM_URL_STAT_LINK;

引数(parameters)

引数なし

引数はありません

戻り値(return)

int

STREAM_URL_STAT_LINK は、stream_url_stat() 関数の statbits パラメータで使用される定数です。この定数は、HTTP リダイレクトの追跡を有効にするために指定します。

関連コンテンツ