International PHP Conference 2019 - Spring Edition

SplFileObject::flock

(PHP 5 >= 5.1.0, PHP 7)

SplFileObject::flockПортируемая блокировка файла

Описание

public bool SplFileObject::flock ( int $operation [, int &$wouldblock ] )

Блокирует или разблокирует файл тем же портируемым способом, что и flock().

Список параметров

operation

operation может принимать следующие значения:

  • LOCK_SH для получения разделяемой блокировки (чтение).
  • LOCK_EX для получения эксклюзивной блокировки (запись).
  • LOCK_UN для снятия блокировки (разделяемой или эксклюзивной).
  • LOCK_NB чтобы не ждать, пока будет получена блокировка.

wouldblock

Будет установлен TRUE, если блокировка будет блокирующей (код ошибки EWOULDBLOCK).

Возвращаемые значения

Возвращает TRUE в случае успешного завершения или FALSE в случае возникновения ошибки.

Примеры

Пример #1 Пример использования SplFileObject::flock()

<?php
$file 
= new SplFileObject("/tmp/lock.txt""w");
if (
$file->flock(LOCK_EX)) { // выполняем эксклюзивную блокировку
    
$file->ftruncate(0);     // очищаем файл
    
$file->fwrite("Что-нибудь пишем сюда\n");
    
$file->flock(LOCK_UN);   // снимаем блокировку   
} else {
    echo 
"Не удалось получить блокировку!";
}
?>

Список изменений

Версия Описание
5.5.22, 5.6.6 Добавлена поддержка параметра wouldblock в Windows.
5.3.2 Удалена автоматическая разблокировка при закрытии ресурса обработчика файла. Теперь разблокировку всегда придется делать самостоятельно.

Смотрите также

  • flock() - Портируемая консультативная блокировка файлов

add a note add a note

User Contributed Notes 1 note

up
2
digitalprecision at gmail dot com
7 years ago
For the record, the example given here has an explicit command to truncate the file, however with a 'write mode' of 'w', it will do this for you automatically, so the truncate call is not needed.
To Top