Index

  1. \com\setasign\SetaSite
    1. Controller
      1. BackendV2
        1. AbstractController
        2. Application
        3. BlockManager
        4. Filesystem
        5. History
        6. Page
        7. PageChange
        8. PageEditor
        9. PageLock
        10. User

com\setasign\SetaSite\Controller\BackendV2

PageLock Class PageLocks

File: /SetaSite/src/Controller/BackendV2/PageLock.php

Class hierarchy

Implements

Summary

Methods

Properties

Properties

$config

protected AbstractController::$config

$data

protected mixed \com\setasign\SetaFramework\Controller\AbstractJsonController::$data

Result data to convert to JSON.

$encodingOptions

protected int \com\setasign\SetaFramework\Controller\AbstractJsonController::$encodingOptions = 79

Default JSON encoding is performed with the following options, which produces RFC4627-compliant JSON, capable of embedding into HTML.

default value of:

JSON_HEX_TAG | JSON_HEX_APOS | JSON_HEX_AMP | JSON_HEX_QUOT | JSON_UNESCAPED_SLASHES

$httpFactory

protected \com\setasign\SetaFramework\Http\HttpFactoryInterface \com\setasign\SetaFramework\Controller\AbstractController::$httpFactory

$response

protected ?\Psr\Http\Message\ResponseInterface \com\setasign\SetaFramework\Controller\AbstractController::$response

$sessionContext

protected AbstractController::$sessionContext

$textContentType

protected bool \com\setasign\SetaFramework\Controller\AbstractJsonController::$textContentType = false

If true the response contentType will be 'text/html; charset=utf-8' instead of 'application/json'.

Needed for the IE. The IE will try to download 'application/json' responses from iframes.


Methods

__construct()

public AbstractController::__construct ()
Parameters
$sessionContext: \com\setasign\SetaSite\SessionContext
 
$config: \com\setasign\SetaFramework\Application\ApplicationConfig
 
$httpFactory: \com\setasign\SetaFramework\Http\HttpFactoryInterface
 

addCorsHeaders()

public AbstractController::addCorsHeaders (
\Psr\Http\Message\ResponseInterface $response
): \Psr\Http\Message\ResponseInterface
Parameters
$response: \Psr\Http\Message\ResponseInterface
 

errorAction()

public AbstractController::errorAction (
void
): void

getAllAction()

public PageLock::getAllAction (): void
Parameters
$pages: \com\setasign\SetaSite\Page\Pages
 
$pageLocks: \com\setasign\SetaSite\Page\PageLocks
 
$users: \com\setasign\SetaSite\User\Users
 

getParam()

public \com\setasign\SetaFramework\Controller\AbstractController::getParam (
string $name,
mixed $default = null
): ?mixed

Returns a param if it exists otherwise this will return $default

Parameters
$name: string
 
$default: mixed
 

getParams()

public \com\setasign\SetaFramework\Controller\AbstractController::getParams (
void
): array

Get all existing params

getRequest()

protected AbstractController::getRequest (
void
): \com\setasign\SetaFramework\Request\ServerRequest

getResponse()

public \com\setasign\SetaFramework\Controller\AbstractController::getResponse (
void
): \Psr\Http\Message\ResponseInterface

getSession()

protected AbstractController::getSession (
void
): \com\setasign\SetaFramework\Session\SessionInterface

hasAction()

public PageLock::hasAction (): void
Parameters
$pageLocks: \com\setasign\SetaSite\Page\PageLocks
 
$users: \com\setasign\SetaSite\User\Users
 

preflightAction()

public AbstractController::preflightAction (
void
): void

removeAction()

public PageLock::removeAction (): void
Parameters
$pageLocks: \com\setasign\SetaSite\Page\PageLocks
 
$users: \com\setasign\SetaSite\User\Users
 

removeMultipleAction()

public PageLock::removeMultipleAction (): void
Parameters
$pageLocks: \com\setasign\SetaSite\Page\PageLocks
 
$users: \com\setasign\SetaSite\User\Users
 
$db: \com\setasign\SetaFramework\Database\Database
 

renderView()

protected AbstractController::renderView (
void
): void
Exceptions

Throws \JsonException

resetResponse()

public \com\setasign\SetaFramework\Controller\AbstractController::resetResponse (
void
): void

setParam()

public \com\setasign\SetaFramework\Controller\AbstractController::setParam (
string $name,
mixed $value
): \com\setasign\SetaFramework\Controller\ControllerInterface

Sets a param

Parameters
$name: string
 
$value: mixed
 

setParams()

public \com\setasign\SetaFramework\Controller\AbstractController::setParams (
array $params
): \com\setasign\SetaFramework\Controller\ControllerInterface

Set a array of params

Note: The params will be merged with the existing params!!

Parameters
$params: array
 

© 2026 Setasign GmbH & Co. KG · Contact / Imprint · Data Privacy Statement (German)