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

PageEditor Class Controller Json

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

Class hierarchy

Implements

Summary

Static Methods

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

$setasite

private PageEditor::$setasite

$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.


Static Methods

clearSession()

public static PageEditor::clearSession (
\com\setasign\SetaFramework\Session\SessionInterface $session,
int $pageId,
string $language
): void
Parameters
$session: \com\setasign\SetaFramework\Session\SessionInterface
 
$pageId: int
 
$language: string
 

getFromSession()

public static PageEditor::getFromSession (): void
Parameters
$session: \com\setasign\SetaFramework\Session\SessionInterface
 
$page: \com\setasign\SetaSite\Page\Page
 
$allowCleanup: bool
 

isEdited()

public static PageEditor::isEdited (): bool
Parameters
$pages: \com\setasign\SetaSite\Page\Pages
 
$session: \com\setasign\SetaFramework\Session\SessionInterface
 
$page: \com\setasign\SetaSite\Page\Page
 

saveToSession()

public static PageEditor::saveToSession (): void
Parameters
$session: \com\setasign\SetaFramework\Session\SessionInterface
 
$page: \com\setasign\SetaSite\Page\Page
 
$forceNewHash: bool
 

Methods

__construct()

public PageEditor::__construct ()
Parameters
$sessionContext: \com\setasign\SetaSite\SessionContext
 
$httpFactory: \com\setasign\SetaFramework\Http\HttpFactoryInterface
 
$setasite: \com\setasign\SetaSite\SetaSite
 

applyHistoryAction()

public PageEditor::applyHistoryAction (): void
Parameters
$pages: \com\setasign\SetaSite\Page\Pages
 
$pageHistory: \com\setasign\SetaSite\Page\PageHistory
 
Exceptions

Throws \com\setasign\SetaSite\Exception

applyPagePropertiesAction()

public PageEditor::applyPagePropertiesAction (): void

Veränderung einer Seite; PageProperties

Parameters
$pages: \com\setasign\SetaSite\Page\Pages
 
$di: \com\setasign\SetaFramework\Di\Di
 
Exceptions

Throws \com\setasign\SetaFramework\Permissions\PermissionException

Throws \com\setasign\SetaSite\BlockManager\UnknownBlockException

cancelEditModeAction()

public PageEditor::cancelEditModeAction (): void
Parameters
$pageLocks: \com\setasign\SetaSite\Page\PageLocks
 
Exceptions

Throws \com\setasign\SetaSite\Exception

exportBlockAction()

public PageEditor::exportBlockAction (): void
Parameters
$pages: \com\setasign\SetaSite\Page\Pages
 
$deploymentHelper: \com\setasign\SetaSite\Page\DeploymentHelper
 

exportPageAction()

public PageEditor::exportPageAction (): void
Parameters
$pages: \com\setasign\SetaSite\Page\Pages
 
$pageLocks: \com\setasign\SetaSite\Page\DeploymentHelper
 
$deploymentHelper: \com\setasign\SetaSite\Page\DeploymentHelper
 
Exceptions

Throws \JsonException

exportPlaceholderAction()

public PageEditor::exportPlaceholderAction (): void
Parameters
$pages: \com\setasign\SetaSite\Page\Pages
 
$deploymentHelper: \com\setasign\SetaSite\Page\DeploymentHelper
 

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

importBlockAction()

public PageEditor::importBlockAction (): void
Parameters
$pages: \com\setasign\SetaSite\Page\Pages
 
$deploymentHelper: \com\setasign\SetaSite\Page\DeploymentHelper
 

importPageAction()

public PageEditor::importPageAction (): void
Parameters
$pages: \com\setasign\SetaSite\Page\Pages
 
$deploymentHelper: \com\setasign\SetaSite\Page\DeploymentHelper
 
Exceptions

Throws \com\setasign\SetaSite\BlockManager\BlockFinalException

Throws \com\setasign\SetaSite\Controller\MultiLangException

Throws \com\setasign\SetaSite\BlockManager\UnknownBlockException

importPlaceholderAction()

public PageEditor::importPlaceholderAction (): void
Parameters
$pages: \com\setasign\SetaSite\Page\Pages
 
$deploymentHelper: \com\setasign\SetaSite\Page\DeploymentHelper
 

renderBlockAction()

public PageEditor::renderBlockAction (): void
Parameters
$pages: \com\setasign\SetaSite\Page\Pages
 
$view: \com\setasign\SetaFramework\View\View
 
Exceptions

Throws \com\setasign\SetaSite\BlockManager\UnknownBlockException

Throws \com\setasign\SetaSite\Exception

renderPlaceholderAction()

public PageEditor::renderPlaceholderAction (): void
Parameters
$pages: \com\setasign\SetaSite\Page\Pages
 
$placeholderFinder: \com\setasign\SetaSite\Page\PlaceholderFinder
 
$view: \com\setasign\SetaFramework\View\View
 
Exceptions

Throws \Throwable

renderView()

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

Throws \JsonException

resetResponse()

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

saveAction()

public PageEditor::saveAction (): 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
 

startEditModeAction()

public PageEditor::startEditModeAction (): void
Parameters
$db: \com\setasign\SetaFramework\Database\Database
 
$pages: \com\setasign\SetaSite\Page\Pages
 
$pageLocks: \com\setasign\SetaSite\Page\PageLocks
 
$users: \com\setasign\SetaSite\User\Users
 
$di: \com\setasign\SetaFramework\Di\Di
 
Exceptions

Throws \com\setasign\SetaSite\Exception

Throws \com\setasign\SetaFramework\Permissions\PermissionException

Throws \Throwable


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