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

Application Class Application

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

Class hierarchy

  • com\setasign\SetaFramework\Controller\AbstractJsonController

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

$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 \com\setasign\SetaFramework\Controller\AbstractController::__construct (
\com\setasign\SetaFramework\Http\HttpFactoryInterface $httpFactory
)
Parameters
$httpFactory : \com\setasign\SetaFramework\Http\HttpFactoryInterface
 

checkData()

private Application::checkData (
\com\setasign\SetaFramework\Database\Database $db,
?\com\setasign\SetaFramework\Database\Migration\MigrationGenerator $migrationGenerator,
\com\setasign\SetaSite\Config\UserTableNames $userTableNames,
\com\setasign\SetaSite\Config\PageTableNames $pageTableNames
): void
Parameters
$db : \com\setasign\SetaFramework\Database\Database
 
$migrationGenerator : ?\com\setasign\SetaFramework\Database\Migration\MigrationGenerator
 
$userTableNames : \com\setasign\SetaSite\Config\UserTableNames
 
$pageTableNames : \com\setasign\SetaSite\Config\PageTableNames
 

clearCacheAction()

public Application::clearCacheAction (
\com\setasign\SetaFramework\Bootstrap\Bootstrap $bootstrap
): void
Parameters
$bootstrap : \com\setasign\SetaFramework\Bootstrap\Bootstrap
 

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

getRegisteredBlocksAction()

public Application::getRegisteredBlocksAction (): void
Parameters
$setaSite : \com\setasign\SetaSite\SetaSite
 
$blockFactory : \com\setasign\SetaSite\Block\BlockFactory
 
$sessionContext : \com\setasign\SetaSite\SessionContext
 
$moduleManager : \com\setasign\SetaSite\Module\ModuleManager
 
Exceptions

Throws \com\setasign\SetaSite\Exception

getResponse()

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

installAction()

public Application::installAction (
\com\setasign\SetaFramework\Application\ApplicationConfig $config,
\com\setasign\SetaFramework\Database\Database $db,
\com\setasign\SetaSite\Module\ModuleManager $moduleManager,
\com\setasign\SetaSite\Config\PageTableNames $pageTableNames,
\com\setasign\SetaSite\Config\UserTableNames $userTableNames,
\com\setasign\SetaFramework\Controller\ControllerDispatcher $controllerDispatcher
): void
Parameters
$config : \com\setasign\SetaFramework\Application\ApplicationConfig
 
$db : \com\setasign\SetaFramework\Database\Database
 
$moduleManager : \com\setasign\SetaSite\Module\ModuleManager
 
$pageTableNames : \com\setasign\SetaSite\Config\PageTableNames
 
$userTableNames : \com\setasign\SetaSite\Config\UserTableNames
 
$controllerDispatcher : \com\setasign\SetaFramework\Controller\ControllerDispatcher
 
Exceptions

Throws \com\setasign\SetaSite\Exception

Throws \com\setasign\SetaFramework\Database\Manager\TableSchemaBuilderException

Throws \com\setasign\SetaFramework\Controller\InitControllerException

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
 

setupDefaultData()

private Application::setupDefaultData (
\com\setasign\SetaFramework\Database\Database $db,
?\com\setasign\SetaFramework\Database\Migration\MigrationGenerator $migrationGenerator,
\com\setasign\SetaFramework\Application\ApplicationConfig $applicationConfig
): void
Parameters
$db : \com\setasign\SetaFramework\Database\Database
 
$migrationGenerator : ?\com\setasign\SetaFramework\Database\Migration\MigrationGenerator
 
$applicationConfig : \com\setasign\SetaFramework\Application\ApplicationConfig
 

updateTo20()

private Application::updateTo20 (
\com\setasign\SetaSite\Config\PageTableNames $pageTableNames,
\com\setasign\SetaFramework\Database\Database $db,
\com\setasign\SetaFramework\Database\Manager\AbstractManager $dbManager,
array $languages,
string $pageChangeTableName,
string $pageLockTableName,
?\com\setasign\SetaFramework\Database\Migration\MigrationGenerator $migrationGenerator
): void
Parameters
$pageTableNames : \com\setasign\SetaSite\Config\PageTableNames
 
$db : \com\setasign\SetaFramework\Database\Database
 
$dbManager : \com\setasign\SetaFramework\Database\Manager\AbstractManager
 
$languages : array
 
$pageChangeTableName : string
 
$pageLockTableName : string
 
$migrationGenerator : ?\com\setasign\SetaFramework\Database\Migration\MigrationGenerator
 

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