modResource.addLock

modResource.addLock¶

Writes a lock record into the locks registry (modDbRegister) under /resource/, keyed by the md5 of the Resource ID. The lock lives for lock_ttl seconds, 360 by default, and a second call by the same user renews it.

The return value is not always boolean. true grants the lock; an integer is the ID of the current holder; false means the method ran outside modX. Compare with === true to test whether the lock is yours.

Syntax¶

boolean|integer addLock ([int $user = 0 [, array $options = array()]])

• $user (integer) lock owner; 0 selects the logged-in user
• $options (array) read for the lock_ttl option, by default array()

Example¶

$resource = $modx->getObject('modResource', array('id' => 5));
if ($resource->addLock() === true) {
    echo 'lock granted';
}

See Also¶

• modResource
• modResource.getLock
• modResource.removeLock