array ( 0 => 'index.php', 1 => 'PHP Manual', ), 'head' => array ( 0 => 'UTF-8', 1 => 'en', ), 'this' => array ( 0 => 'streamwrapper.stream-lock.php', 1 => 'streamWrapper::stream_lock', 2 => 'Advisory file locking', ), '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' => 'en', '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 — Advisory file locking

Description

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

This method is called in response to flock(), when file_put_contents() (when flags contains LOCK_EX), stream_set_blocking() and when closing the stream (LOCK_UN).

Parameters

operation

operation is one of the following:

  • LOCK_SH to acquire a shared lock (reader).
  • LOCK_EX to acquire an exclusive lock (writer).
  • LOCK_UN to release a lock (shared or exclusive).
  • LOCK_NB if you don't want flock() to block while locking. (not supported on Windows)

Return Values

Returns true on success or false on failure.

Errors/Exceptions

Emits E_WARNING if call to this method fails (i.e. not implemented).

See Also