API Documentation
\
Charcoal
App
Action
Config
Handler
Middleware
Module
Route
Script
ServiceProvider
Template

\Charcoal\App\ScriptCronScriptTrait

Cron-job utilities

Summary

Methods
Properties
Constants
setUseLock()
useLock()
startLock()
stopLock()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
$useLock
$lockFilePointer
N/A

Properties

$useLock

$useLock : boolean

Type

boolean

$lockFilePointer

$lockFilePointer : resource

Lock file pointer

Type

resource

Methods

setUseLock()

setUseLock(boolean  $useLock) : \Charcoal\App\Script\CronScriptInterface

Parameters

boolean $useLock

The boolean flag if a lock should be used.

Returns

\Charcoal\App\Script\CronScriptInterface —

Chainable

useLock()

useLock() : boolean

Returns

boolean

startLock()

startLock() : boolean

Throws

\Exception

If the lock file can not be opened.

Returns

boolean

stopLock()

stopLock() : void