A simple class represeinting a lock on a logical object in CMSMS.
| package |
CMS |
|---|---|
| author |
Robert Campbell (calguy1000@cmsmadesimple.org) |
| since | 2.0 |
| param-read |
int $id |
| param-read |
int $created (unixtime) |
| param-read |
int $modified (unixtime) |
| param-read |
int $lifetime (minutes) |
| param-read |
int $expires (unixtime) |
| param | |
| param | |
| param |
__construct(string $type, integer $oid, integer $lifetime = null)
string $typeinteger $oidObject Id
integer $lifetime(in minutes) The lifetime of the lock before it can be stolen. If not specified, the system default value will be used.
expired() : boolean
boolean
save()
delete()
load_by_id(integer $lock_id, string $type, integer $oid, integer $uid = NULL) : \CmsLock
integer $lock_idstring $typeThe lock type (type of object being locked)
integer $oidThe object id
integer $uidAn optional user identifier.
load(string $type, integer $oid, integer $uid = null) : \CmsLock
string $typeThe lock type (type of object being locked)
integer $oidThe object id
integer $uidAn optional user identifier.