Открытые статические члены | Поля данных | Закрытые статические члены | Закрытые статические данные
Класс Wrong\File\Locker

Locker блокировщик файлов Подробнее...

Открытые статические члены

static lock ($id, $max_time=self::CLEAN_TIME)
 
static unlock ($id, $forse=false)
 

Поля данных

const LOCK_PATH = __DIR__ . '/../../../temp'
 
const LOCK_PREFIX = 'lock'
 
const CLEAN_TIME = 3600
 

Закрытые статические члены

static setPath ($id)
 
static cleaner ()
 

Закрытые статические данные

static $path
 
static $lock = false
 

Подробное описание

Locker блокировщик файлов

отвечает за блокировку файлов для крон задач, может использоваться при необходимости любых иных блокировок потоков и их ограничения usage example:

if (Locker::lock(basename(FILE, '.php'))) { Locker::unlock(basename(FILE, '.php')); }

См. определение в файле Locker.php строка 24

Методы

◆ cleaner()

static Wrong\File\Locker::cleaner ( )
staticprivate

удаляет любые файлы блокировки, которые старше текущего времени.

Возвращает
bool Логическое значение, истинное означает что текущий файл блокировки по прежнему существует.

См. определение в файле Locker.php строка 119

◆ lock()

static Wrong\File\Locker::lock (   $id,
  $max_time = self::CLEAN_TIME 
)
static

создает файл с именем блокировки и записывает текущее время плюс максимальное время, в течение которого блокировка должна удерживаться в файле.

Если файл уже существует, проверяет, истек ли срок действия блокировки, и если да, то удаляет файл и возвращает значение true.

Если срок действия блокировки не истек, возвращается false.

Если файл не существует, создает файл и возвращает true

Аргументы
int$idИмя файла блокировки.
int$max_timeМаксимальное время удержания блокировки в секундах.

См. определение в файле Locker.php строка 55

◆ setPath()

static Wrong\File\Locker::setPath (   $id)
staticprivate

создает каталог, если он не существует, а затем устанавливает в self::$path имя файла блокировки

Аргументы
Уникальныйидентификатор блокировки, который используется для создания имени файла блокировки.

См. определение в файле Locker.php строка 84

◆ unlock()

static Wrong\File\Locker::unlock (   $id,
  $forse = false 
)
static

Удаляет файл блокировки

Аргументы
int$idИмя файла блокировки.
bool$forseистинное означает что блокировка будет снята, даже если она не была создана текущим процессом.

См. определение в файле Locker.php строка 104

Поля

◆ $lock

Wrong\File\Locker::$lock = false
staticprivate

Используется, чтобы определить, заблокировал ли текущий процесс файл.

См. определение в файле Locker.php строка 39

◆ $path

Wrong\File\Locker::$path
staticprivate

Переменная класса, используется для хранения пути к файлу блокировки.

См. определение в файле Locker.php строка 36

◆ CLEAN_TIME

const Wrong\File\Locker::CLEAN_TIME = 3600

время блокировки в секундах

См. определение в файле Locker.php строка 33

◆ LOCK_PATH

const Wrong\File\Locker::LOCK_PATH = __DIR__ . '/../../../temp'

путь к каталогу, в котором будут храниться файлы блокировки.

См. определение в файле Locker.php строка 27

◆ LOCK_PREFIX

const Wrong\File\Locker::LOCK_PREFIX = 'lock'

префикс файла блокировки.

См. определение в файле Locker.php строка 30

Объявления и описания членов класса находятся в файле: