Docs For Class atkLock

static reference	getInstance()	Returns the only lock instance, based on the settings in the configuration file (if no settings found -> returns NULL!).
success	extend()	Extends the lock lease with the given ID. (This can mean multiple lock leases will be extended, if there are multiple locks with the given ID!)
the	getId()	Returns the unique lock ID.
lock	isLocked()	Checks if a certain item / record is locked or not. If so we return an array with lock information. If not we return NULL.
success	lock()	Locks the record with the given primary key / selector. If the record is already locked the method will fail!
void	unlock()	Tries to remove a lock of a certain record. Ofcourse this method will fail if the lock isn't entirely ours. We also try to remove any old expired locks.

[ Top ]

Properties

mixed $m_id = NULL [line 35]

[ Top ]

Methods

static method getInstance [line 43]

static reference getInstance(
)

Returns the *only* lock instance, based on the settings in the configuration file (if no settings found -> returns NULL!).

API Tags:

Return:	to the only lock instance
Access:	public

[ Top ]

extend [line 107]

success extend(
int
$identifier 
)

Extends the lock lease with the given ID. (This can mean multiple lock leases will be extended, if there are multiple locks with the given ID!)

Parameters:

int

$identifier:

the unique lock ID

API Tags:

Return:

/ failure of operation

Redefined in descendants as:

atkDbLock::extend() : Extends the lock lease with the given ID. (This can mean multiple lock leases will be extended, if there are multiple locks with the given ID!)

[ Top ]

getId [line 70]

the getId(
)

Returns the unique lock ID.

API Tags:

Return:

unique lock ID

[ Top ]

isLocked [line 119]

lock isLocked(
string
$selector, string
$table 
)

Checks if a certain item / record is locked or not. If so we return an array with lock information. If not we return NULL.

Parameters:

string	$selector:	the ATK primary key / selector
string	$table:	the (unique) table name

API Tags:

Return:

information

Redefined in descendants as:

atkDbLock::isLocked() : Checks if a certain item / record is locked or not. If so we return an array with lock information. If not we return NULL.

[ Top ]

lock [line 85]

success lock(
string
$selector, string
$table, [string
$mode = self::EXCLUSIVE] 
)

Locks the record with the given primary key / selector. If the record is already locked the method will fail!

Parameters:

string	$selector:	the ATK primary key / selector
string	$table:	the (unique) table name
string	$mode:	mode of the lock (self::EXCLUSIVE or self::SHARED)

API Tags:

Return:

/ failure of operation

Redefined in descendants as:

atkDbLock::lock() : Locks the record with the given primary key / selector. If the record is already locked the method will fail!

[ Top ]

unlock [line 96]

void unlock(
string
$selector, string
$table 
)

Tries to remove a lock of a certain record. Ofcourse this method will fail if the lock isn't entirely ours. We also try to remove any old expired locks.

Parameters:

string	$selector:	the ATK primary key / selector
string	$table:	the (unique) table name

Redefined in descendants as:

atkDbLock::unlock() : Tries to remove a lock from a certain record. Ofcourse this method will fail if the lock isn't entirely ours. We also try to remove any old expired locks.

[ Top ]

Constants

EXCLUSIVE = 'exclusive' [line 32]

[ Top ]

SHARED = 'shared' [line 33]

[ Top ]