ILock Interface Reference
[General]

Declare the interface 'iLock'. More...

Inheritance diagram for ILock:

List of all members.

Public Member Functions
	isLockExpired ($lockName_, $lockTime_=60, $compressName_=true)
	Check if a specified name is locked.

---

Detailed Description

Declare the interface 'iLock'.

Author:

Daniel Lindh <[email protected]>

Definition at line 8 of file ILock.php.

---

Member Function Documentation

ILock::isLockExpired	(	$	lockName_,
		$	lockTime_ = 60,
		$	compressName_ = true
	)

Check if a specified name is locked.

An entity is locked in the system, if that entity was locked more then $lockTime_ seconds ago, this funtion returns true.

This is used to see how long ago a certatin operation was done. Example, If it's more then 1 minute since we last did send an SMS message we can now send a new.

Parameters:

	$lockName_	- string - The name of the lock/variable/file.
	$lockTime_	- string - Seconds the lockTitle is locked before expiring.
	$compressName_	- boolean - true - An md5 will be done on the filename/lockName_.

Returns:

- boolean -

Implemented in FileLock.

---

The documentation for this interface was generated from the following file:

• Static/PhpInclude/FareOfficeLib/General/ILock.php