PHP Class Jackalope\Lock\Lock

Inheritance: implements PHPCR\Lock\LockInterface
Show file Open project: jackalope/jackalope Class Usage Examples

Protected Properties

Property Type Description
$expire integer The unix timestamp (seconds since 1970) at which this lock will expire
$isDeep boolean
$isLive boolean
$isLockOwningSession boolean
$isSessionScoped boolean
$lockManager LockManager
$lockOwner string
$lockToken string
$path string

Public Methods

Method Description
getLockOwner ( ) {@inheritDoc}
getLockToken ( ) {@inheritDoc}
getNode ( ) {@inheritDoc}
getSecondsRemaining ( ) {@inheritDoc}
isDeep ( ) {@inheritDoc}
isLive ( ) {@inheritDoc}
isLockOwningSession ( ) {@inheritDoc}
isSessionScoped ( ) {@inheritDoc}
refresh ( ) {@inheritDoc}
setExpireTime ( integer $expire ) Set the lock expire timestamp
setIsDeep ( boolean $isDeep )
setIsLive ( boolean $isLive ) Can be used by the lock manager to tell the lock its no longer live
setIsLockOwningSession ( boolean $isLockOwningSession )
setIsSessionScoped ( boolean $isSessionScoped )
setLockManager ( LockManager $lm ) Set the lock manager to be used with isLive requests and such
setLockOwner ( string $owner )
setLockToken ( string $token )
setNodePath ( string $path )

Method Details

getLockOwner() public method

{@inheritDoc}
public getLockOwner ( )

getLockToken() public method

{@inheritDoc}
public getLockToken ( )

getNode() public method

{@inheritDoc}
public getNode ( )

getSecondsRemaining() public method

{@inheritDoc}
public getSecondsRemaining ( )

isDeep() public method

{@inheritDoc}
public isDeep ( )

isLive() public method

{@inheritDoc}
public isLive ( )

isLockOwningSession() public method

{@inheritDoc}
public isLockOwningSession ( )

isSessionScoped() public method

{@inheritDoc}
public isSessionScoped ( )

refresh() public method

{@inheritDoc}
public refresh ( )

setExpireTime() public method

Set to null for unknown / infinite timeout
See also: http://ch.php.net/manual/en/function.time.php
public setExpireTime ( integer $expire )
$expire integer timestamp when this lock will expire in seconds of unix epoch

setIsDeep() public method

public setIsDeep ( boolean $isDeep )
$isDeep boolean

setIsLive() public method

Can be used by the lock manager to tell the lock its no longer live
public setIsLive ( boolean $isLive )
$isLive boolean

setIsLockOwningSession() public method

public setIsLockOwningSession ( boolean $isLockOwningSession )
$isLockOwningSession boolean

setIsSessionScoped() public method

public setIsSessionScoped ( boolean $isSessionScoped )
$isSessionScoped boolean

setLockManager() public method

Set the lock manager to be used with isLive requests and such
public setLockManager ( LockManager $lm )
$lm LockManager

setLockOwner() public method

public setLockOwner ( string $owner )
$owner string

setLockToken() public method

public setLockToken ( string $token )
$token string

setNodePath() public method

public setNodePath ( string $path )
$path string the path to our owning node

Property Details

$expire protected property

The unix timestamp (seconds since 1970) at which this lock will expire
protected int $expire
return integer

$isDeep protected property

protected bool $isDeep
return boolean

$isLive protected property

protected bool $isLive
return boolean

$isLockOwningSession protected property

protected bool $isLockOwningSession
return boolean

$isSessionScoped protected property

protected bool $isSessionScoped
return boolean

$lockManager protected property

protected LockManager,Jackalope\Lock $lockManager
return LockManager

$lockOwner protected property

protected string $lockOwner
return string

$lockToken protected property

protected string $lockToken
return string

$path protected property

protected string $path
return string