PHP Class Scalr\Exception\LockedException

Author: N.V.
Inheritance: extends ScalrException
Show file Open project: scalr/scalr

Public Methods

Method Description
__construct ( integer $lockedBy, mixed $object = null, string $comment = '', integer $code, Exception $previous = null ) LockedException
getLockedBy ( ) : integer Gets the identifier of the User who locked the object
getLockedObject ( ) : mixed Gets the object that is locked by the User

Method Details

__construct() public method

LockedException
public __construct ( integer $lockedBy, mixed $object = null, string $comment = '', integer $code, Exception $previous = null )
$lockedBy integer Id of User that add a lock to the object
$object mixed optional Locked object
$comment string optional Lock comment
$code integer optional The Exception code
$previous Exception optional The previous exception used for the exception chaining

getLockedBy() public method

Gets the identifier of the User who locked the object
public getLockedBy ( ) : integer
return integer Returns the identifier of the User who locked the object

getLockedObject() public method

Gets the object that is locked by the User
public getLockedObject ( ) : mixed
return mixed Returns the object that is locked