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

BlockManager Class BlockManager

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

$pages

protected \com\setasign\SetaSite\Page\Pages BlockManager::$pages

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

addBlockAction()

public BlockManager::addBlockAction (
void
): void
Exceptions

Throws \Throwable

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

moveBlockAction()

public BlockManager::moveBlockAction (
void
): void
Exceptions

Throws \Throwable

removeBlockAction()

public BlockManager::removeBlockAction (
void
): void
Exceptions

Throws \Throwable

renameBlocksGloballyAction()

public BlockManager::renameBlocksGloballyAction (
\com\setasign\SetaSite\Page\PageLocks $pageLocks,
\com\setasign\SetaFramework\Database\Database $database
): void
Parameters
$pageLocks : \com\setasign\SetaSite\Page\PageLocks
 
$database : \com\setasign\SetaFramework\Database\Database
 
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

setBlockDataAction()

public BlockManager::setBlockDataAction (
void
): void
Exceptions

Throws \Throwable

setBlockNameAction()

public BlockManager::setBlockNameAction (
void
): void
Exceptions

Throws \Throwable

setFinalAction()

public BlockManager::setFinalAction (
void
): void
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
 

setRenderOrderAction()

public BlockManager::setRenderOrderAction (
void
): void
Exceptions

Throws \Throwable

setVisibilityAction()

public BlockManager::setVisibilityAction (
void
): void
Exceptions

Throws \Throwable


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