Index

  1. \com\setasign\SetaSite
    1. Controller
      1. Backend
        1. AbstractBackendJsonController
        2. AdminUser
        3. Application
        4. BackendSsoHelper
        5. BlockManager
        6. Filesystem
        7. History
        8. LoginTryLimiter
        9. Module
        10. Page
        11. PageChanges
        12. PageEditor
        13. PageLocks
        14. User

com\setasign\SetaSite\Controller\Backend

PageChanges Class Controller Json

File: /SetaSite/src/Controller/Backend/PageChanges.php

Class hierarchy

Implements

  • \com\setasign\SetaFramework\Controller\ControllerInterface

Summary

Methods

Properties

Properties

$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 AbstractBackendJsonController::$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 AbstractBackendJsonController::__construct (
\com\setasign\SetaSite\SessionContext $sessionContext,
\com\setasign\SetaFramework\Http\HttpFactoryInterface $httpFactory
)
Parameters
$sessionContext : \com\setasign\SetaSite\SessionContext
 
$httpFactory : \com\setasign\SetaFramework\Http\HttpFactoryInterface
 

approveChangeAction()

public PageChanges::approveChangeAction (
\com\setasign\SetaSite\Page\Pages $pages,
\com\setasign\SetaSite\Page\PageLocks $pageLocks,
\com\setasign\SetaFramework\Di\Di $di
): void
Parameters
$pages : \com\setasign\SetaSite\Page\Pages
 
$pageLocks : \com\setasign\SetaSite\Page\PageLocks
 
$di : \com\setasign\SetaFramework\Di\Di
 
Exceptions

Throws \Throwable

getAllChangesAction()

public PageChanges::getAllChangesAction (
\com\setasign\SetaFramework\Application\ApplicationConfig $applicationConfig,
\com\setasign\SetaSite\Page\Pages $pages,
\com\setasign\SetaSite\Page\PageLocks $pageLocks,
\com\setasign\SetaSite\User\Users $users
): void
Parameters
$applicationConfig : \com\setasign\SetaFramework\Application\ApplicationConfig
 
$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 AbstractBackendJsonController::getRequest (
void
): \com\setasign\SetaFramework\Request\ServerRequest

getResponse()

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

getSession()

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

hasChangesAction()

public PageChanges::hasChangesAction (): void
Parameters
$pages : \com\setasign\SetaSite\Page\Pages
 

renderView()

protected \com\setasign\SetaFramework\Controller\AbstractJsonController::renderView (
void
): void
Exceptions

Throws \JsonException

resetResponse()

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

revertChangeAction()

public PageChanges::revertChangeAction (
\com\setasign\SetaSite\Page\Pages $pages,
\com\setasign\SetaSite\Page\PageLocks $pageLocks,
\com\setasign\SetaFramework\Di\Di $di
): void
Parameters
$pages : \com\setasign\SetaSite\Page\Pages
 
$pageLocks : \com\setasign\SetaSite\Page\PageLocks
 
$di : \com\setasign\SetaFramework\Di\Di
 
Exceptions

Throws \Throwable

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
 

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