array ( 0 => 'index.php', 1 => 'PHP Manual', ), 'head' => array ( 0 => 'UTF-8', 1 => 'ja', ), 'this' => array ( 0 => 'streamwrapper.stream-lock.php', 1 => 'streamWrapper::stream_lock', 2 => 'ファイルのアドバイザリ・ロック', ), 'up' => array ( 0 => 'class.streamwrapper.php', 1 => 'streamWrapper', ), 'prev' => array ( 0 => 'streamwrapper.stream-flush.php', 1 => 'streamWrapper::stream_flush', ), 'next' => array ( 0 => 'streamwrapper.stream-metadata.php', 1 => 'streamWrapper::stream_metadata', ), 'alternatives' => array ( ), 'source' => array ( 'lang' => 'ja', 'path' => 'reference/stream/streamwrapper/stream-lock.xml', ), 'history' => array ( ), ); $setup["toc"] = $TOC; $setup["toc_deprecated"] = $TOC_DEPRECATED; $setup["parents"] = $PARENTS; manual_setup($setup); contributors($setup); ?>

streamWrapper::stream_lock

(PHP 5, PHP 7, PHP 8)

streamWrapper::stream_lock — ファイルのアドバイザリ・ロック

説明

public streamWrapper::stream_lock(int $operation): bool

このメソッドは、flock() に対応してコールされます。また file_put_contents() (flags が LOCK_EX を含む場合)、 stream_set_blocking() がコールされたときやストリームを閉じるとき (LOCK_UN) にもコールされます。

パラメータ

operation

operation は以下のいずれかとなります。

  • LOCK_SH 共有ロック (読み込み) を確保します。
  • LOCK_EX 排他ロック (書き込み) を確保します。
  • LOCK_UN ロック (共有あるいは排他) を開放します。
  • LOCK_NB flock() によるロック中にブロックしない (Windows ではサポートしていません)。

戻り値

成功した場合に true を、失敗した場合に false を返します。

エラー / 例外

このメソッドのコールに失敗した場合 (実装されていないなど) は E_WARNING を発行します。

参考