http_cache_etag

(PECL)

http_cache_etag -- ETag でキャッシュする

説明

bool http_cache_etag ( [string etag] )

送信されるエンティティを、その ETag を基準にしてキャッシュしようとします。 ETag は、指定されたものを使用するか、あるいは INI 設定 http.etag.mode で指定したハッシュアルゴリズムにより生成したものを使用します。

クライアントの If-None-Match ヘッダがこの ETag と一致した場合は、その本文はクライアント側でキャッシュされていると判断し、 ステータスコード 304 Not Modified を発行します。

INI 設定 http.log.cache が設定されており、キャッシュの試みが成功した場合は、 キャッシュログにエントリが書き込まれます。

注意: この関数は、 http_send_data()http_send_file() そして http_send_stream() と組み合わせて使用しすることもあります。

この関数を http_send_*() API の外部で使用すると、 ob_etaghandler() を助けます。

パラメータ

etag

独自の ETag

返り値

失敗した場合は FALSE を返します。成功した場合は 終了 します。 エンティティがキャッシュされた場合は、304 Not Modified となります。 "終了" の意味については、INI 設定 http.force_exit を参照ください。

例 1. http_cache_etag() の例

<?php
http_cache_etag
();
http_send_data("data");
?>

参考

http_cache_last_modified()
ob_etaghandler()
http_match_etag()
PHP 5.1 以降を使用している場合は HttpResponse クラス