function DrupalLocalStreamWrapper::stream_lock

Support for flock().

Parameters

$operation: 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 value

Always returns TRUE at the present time.

Overrides StreamWrapperInterface::stream_lock

See also

http://php.net/manual/streamwrapper.stream-lock.php

File

includes/stream_wrappers.inc, line 439

Class

DrupalLocalStreamWrapper
Drupal stream wrapper base class for local files.

Code

public function stream_lock($operation) {
    if (in_array($operation, array(
        LOCK_SH,
        LOCK_EX,
        LOCK_UN,
        LOCK_NB,
    ))) {
        return flock($this->handle, $operation);
    }
    return TRUE;
}

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.