com\setasign\SetaSite\Page
PageLocks
File: /SetaSite/src/Page/PageLocks.php
Class hierarchy
Summary
Properties
$lockTable
private \com\setasign\SetaFramework\Database\Table\Table PageLocks::$lockTable
Methods
forceRemoveLock()
This method will remove the lock of $pageId.
If a userId is given it will check whether the active lock is by that user. If not a PageLockException is thrown. It will not be checked whether the lock is allowed to be removed.
Parameters
- $pageId : int
- $language : string
- $userId : ?int
Exceptions
Throws PageLockException
getAllLocks()
public PageLocks::getAllLocks (
?array<int, array{id: int, language: string}> $pages = null
): arrayParameters
- $pages : ?array<int, array{id: int, language: string}>
If given the select will be filtered by this ids.
getLockValidInfo()
Parameters
- $pageId : int
- $language : string
- $userId : int
- $users : \com\setasign\SetaSite\User\Users
- $timeout : int
Return Values
null if no lock exist
isLockedByUser()
Checks whether there is an lock by user $userId on page $pageId.
Doesn't check the validity of the user
Parameters
- $pageId : int
- $language : string
- $userId : ?int
removeLock()
public PageLocks::removeLock (
\com\setasign\SetaSite\User\Users $users,
int $timeout,
int $pageId,
string $language,
?int $activeUserId = null
): voidint $timeout,
int $pageId,
string $language,
?int $activeUserId = null
Parameters
- $users : \com\setasign\SetaSite\User\Users
- $timeout : int
- $pageId : int
- $language : string
- $activeUserId : ?int
Exceptions
Throws PageLockException
setLock()
Parameters
- $pageId : int
- $language : string
- $userId : int
Exceptions
Throws \com\setasign\SetaFramework\Exception
Throws PageLockException