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

Page Class Page

File: /SetaSite/src/Controller/Backend/Page.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

$setasite

protected \com\setasign\SetaSite\SetaSite Page::$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.


Methods

__construct()

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

copyAction()

public Page::copyAction (
\com\setasign\SetaSite\Page\Pages $pages,
\com\setasign\SetaFramework\Di\Di $di
): void
Parameters
$pages : \com\setasign\SetaSite\Page\Pages
 
$di : \com\setasign\SetaFramework\Di\Di
 
Exceptions

Throws \Throwable

createAction()

public Page::createAction (
\com\setasign\SetaSite\Page\Pages $pages,
\com\setasign\SetaFramework\Di\Di $di
): void

Seite erstellen

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

Throws \Throwable

deleteAction()

public Page::deleteAction (
\com\setasign\SetaSite\Page\Pages $pages,
\com\setasign\SetaSite\Page\PageLocks $pageLocks,
\com\setasign\SetaFramework\EventManager\EventManager $eventManager,
\com\setasign\SetaFramework\Di\Di $di
): void

Löschen einer Seite

Parameters
$pages : \com\setasign\SetaSite\Page\Pages
 
$pageLocks : \com\setasign\SetaSite\Page\PageLocks
 
$eventManager : \com\setasign\SetaFramework\EventManager\EventManager
 
$di : \com\setasign\SetaFramework\Di\Di
 
Exceptions

Throws \Throwable

exportPageAction()

WARNING: This method is marked as deprecated!

Only used by old gui versions

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

Throws \JsonException

getAnchorsAction()

public Page::getAnchorsAction (): void
Parameters
$pages : \com\setasign\SetaSite\Page\Pages
 
Exceptions

Throws \Throwable

getFiles()

protected Page::getFiles (): array
Parameters
$filesystemManager : \com\setasign\SetaSite\FileSystem\FilesystemManagerInterface
 
$path : ?string
 
Exceptions

Throws \com\setasign\SetaSite\Exception

getPageInfoAction()

public Page::getPageInfoAction (): void
Parameters
$pages : \com\setasign\SetaSite\Page\Pages
 
$users : \com\setasign\SetaSite\User\Users
 

getPagePathAction()

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

getPagePropertiesAction()

public Page::getPagePropertiesAction (): void
Parameters
$pageProperties : \com\setasign\SetaSite\Config\PageProperties
 

getPageTreeAction()

public Page::getPageTreeAction (): void
Parameters
$pages : \com\setasign\SetaSite\Page\Pages
 
$pageLocks : \com\setasign\SetaSite\Page\PageLocks
 
$users : \com\setasign\SetaSite\User\Users
 
$filesystemManager : \com\setasign\SetaSite\FileSystem\FilesystemManagerInterface
 
Exceptions

Throws \com\setasign\SetaSite\Exception

getPagesPathsAction()

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

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

getSubpagesTreeAction()

public Page::getSubpagesTreeAction (): void
Parameters
$pages : \com\setasign\SetaSite\Page\Pages
 
Exceptions

Throws \Throwable

getTemplateFilesAction()

public Page::getTemplateFilesAction (
void
): void

getTree()

protected Page::getTree (): array
Parameters
$pages : \com\setasign\SetaSite\Page\Pages
 
$pageLocks : \com\setasign\SetaSite\Page\PageLocks
 
$users : \com\setasign\SetaSite\User\Users
 
$language : string
 
$rootNode : ?int
 

moveAction()

public Page::moveAction (
\com\setasign\SetaSite\Page\Pages $pages,
\com\setasign\SetaFramework\Di\Di $di
): void
Parameters
$pages : \com\setasign\SetaSite\Page\Pages
 
$di : \com\setasign\SetaFramework\Di\Di
 
Exceptions

Throws \Throwable

rebuildPathOrderAction()

public Page::rebuildPathOrderAction (
\com\setasign\SetaFramework\Database\Database $db,
\com\setasign\SetaSite\Page\Pages $pages,
\com\setasign\SetaFramework\Application\ApplicationConfig $config
): void
Parameters
$db : \com\setasign\SetaFramework\Database\Database
 
$pages : \com\setasign\SetaSite\Page\Pages
 
$config : \com\setasign\SetaFramework\Application\ApplicationConfig
 
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

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)