Index

  1. \com\setasign\Konquadrat
    1. Controller
      1. Backend
        1. Admin
        2. BackendJsonController
        3. BackendSsoHelper
        4. ChangedDetailsException
        5. Checkin
        6. Config
        7. ConfigInstaller
        8. Cors
        9. Datasource
        10. Details
        11. DisplayObjectAs
        12. ExportAlreadyExistsException
        13. Grid
        14. History
        15. Import
        16. LoginTryLimiter
        17. Namebadge
        18. ObjectIsReferencedException
        19. ObjectSync
        20. Objects
        21. Task
        22. User
        23. V2
        24. Workflow
        25. Xml

com\setasign\Konquadrat\Controller\Backend

Details Class Details

File: /Konquadrat/src/Controller/Backend/Details.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

$messageList

protected BackendJsonController::$messageList

$response

protected ?\Psr\Http\Message\ResponseInterface \com\setasign\SetaFramework\Controller\AbstractController::$response

$sessionContext

protected BackendJsonController::$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 BackendJsonController::__construct (
\com\setasign\Konquadrat\SessionContext $sessionContext,
\com\setasign\Konquadrat\Object\MessageList $messageList,
\com\setasign\SetaFramework\Http\HttpFactoryInterface $httpFactory
)
Parameters
$sessionContext : \com\setasign\Konquadrat\SessionContext
 
$messageList : \com\setasign\Konquadrat\Object\MessageList
 
$httpFactory : \com\setasign\SetaFramework\Http\HttpFactoryInterface
 

buildSelectorForNeededFields()

protected Details::buildSelectorForNeededFields (
\com\setasign\Konquadrat\Object\ObjectSet $objectSet,
$neededFields
): void
Parameters
$objectSet : \com\setasign\Konquadrat\Object\ObjectSet
 
$neededFields
 
Exceptions

Throws \com\setasign\Konquadrat\Exception

getAction()

public Details::getAction (): void
Parameters
$instancePool : \com\setasign\Konquadrat\Object\InstancePoolInterface
 
$objectFinder : \com\setasign\Konquadrat\Object\ObjectFinder
 
$objectConfig : \com\setasign\Konquadrat\Object\ObjectConfig
 
Exceptions

Throws \com\setasign\Konquadrat\Exception

Throws \JsonException

Throws \com\setasign\Konquadrat\Object\UnknownObjectException

Throws \com\setasign\SetaFramework\Permissions\PermissionException

getAllExternalFilesAction()

public Details::getAllExternalFilesAction (
\com\setasign\SetaFramework\Application\ApplicationConfig $applicationConfig
): void
Parameters
$applicationConfig : \com\setasign\SetaFramework\Application\ApplicationConfig
 
Exceptions

Throws \com\setasign\Konquadrat\Exception

getConfigAction()

public Details::getConfigAction (): void
Parameters
$objectConfig : \com\setasign\Konquadrat\Object\ObjectConfig
 

getData()

protected Details::getData (
\com\setasign\Konquadrat\Object\InstancePoolInterface $instancePool,
\com\setasign\Konquadrat\Object\ObjectFinder $objectFinder,
\com\setasign\Konquadrat\Object\ObjectConfig $objectConfig,
int $id,
\com\setasign\SetaFramework\Permissions\PermissionControl $permissionControl
): array
Parameters
$instancePool : \com\setasign\Konquadrat\Object\InstancePoolInterface
 
$objectFinder : \com\setasign\Konquadrat\Object\ObjectFinder
 
$objectConfig : \com\setasign\Konquadrat\Object\ObjectConfig
 
$id : int
 
$permissionControl : \com\setasign\SetaFramework\Permissions\PermissionControl
 
Exceptions

Throws \com\setasign\Konquadrat\Exception

Throws \JsonException

Throws \com\setasign\Konquadrat\Object\UnknownObjectException

Throws \com\setasign\SetaFramework\Permissions\PermissionException

getNeededFields()

protected Details::getNeededFields (
\com\setasign\Konquadrat\Object\ObjectSet $objectSet,
$neededFields,
\com\setasign\SetaFramework\Permissions\PermissionControl $permissionControl
): array
Parameters
$objectSet : \com\setasign\Konquadrat\Object\ObjectSet
 
$neededFields
 
$permissionControl : \com\setasign\SetaFramework\Permissions\PermissionControl
 
Exceptions

Throws \com\setasign\Konquadrat\Exception

Throws \com\setasign\SetaFramework\Permissions\PermissionException

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

getPermissionControl()

protected BackendJsonController::getPermissionControl (
void
): \com\setasign\Konquadrat\Permission\PermissionControl

getRequest()

protected BackendJsonController::getRequest (
void
): \com\setasign\SetaFramework\Request\ServerRequest

getResponse()

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

getSession()

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

getSubtree()

protected Details::getSubtree (): array
Parameters
$objectConfig : \com\setasign\Konquadrat\Object\ObjectConfig
 
$objectFinder : \com\setasign\Konquadrat\Object\ObjectFinder
 
$nodeObject : \com\setasign\Konquadrat\Object\AbstractObject
 
$activePath : array
 
$treePath : array
 

getTree()

protected Details::getTree (): array
Parameters
$objectConfig : \com\setasign\Konquadrat\Object\ObjectConfig
 
$objectFinder : \com\setasign\Konquadrat\Object\ObjectFinder
 
$path : string
 

handleFileField()

protected Details::handleFileField (
\com\setasign\SetaFramework\Session\SessionInterface $session,
\com\setasign\Konquadrat\Field\File $field,
$value,
&$savedFiles
): void
Parameters
$session : \com\setasign\SetaFramework\Session\SessionInterface
 
$field : \com\setasign\Konquadrat\Field\File
 
$value
 
$savedFiles
 
Exceptions

Throws \com\setasign\Konquadrat\Exception

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 Details::saveAction (): void
Parameters
$objectFinder : \com\setasign\Konquadrat\Object\ObjectFinder
 
$objectManager : \com\setasign\Konquadrat\Object\ObjectManager
 
$objectConfig : \com\setasign\Konquadrat\Object\ObjectConfig
 
$transactionManager : \com\setasign\Konquadrat\Object\TransactionManager
 
$history : \com\setasign\Konquadrat\Object\History
 
$instancePool : \com\setasign\Konquadrat\Object\InstancePoolInterface
 
Exceptions

Throws ChangedDetailsException

Throws \com\setasign\Konquadrat\Exception

Throws \JsonException

Throws \com\setasign\Konquadrat\Object\UnknownObjectException

Throws \Throwable

Throws \com\setasign\SetaFramework\Permissions\PermissionException

saveChilds()

protected Details::saveChilds (
\com\setasign\SetaFramework\Session\SessionInterface $session,
\com\setasign\Konquadrat\Object\ObjectConfig $objectConfig,
\com\setasign\Konquadrat\Object\ObjectFinder $objectFinder,
\com\setasign\Konquadrat\Object\ObjectManager $objectManager,
\com\setasign\Konquadrat\Object\AbstractObject $parent,
array $childData,
\com\setasign\SetaFramework\Permissions\PermissionControl $permissionControl,
array &$savedFiles
): void
Parameters
$session : \com\setasign\SetaFramework\Session\SessionInterface
 
$objectConfig : \com\setasign\Konquadrat\Object\ObjectConfig
 
$objectFinder : \com\setasign\Konquadrat\Object\ObjectFinder
 
$objectManager : \com\setasign\Konquadrat\Object\ObjectManager
 
$parent : \com\setasign\Konquadrat\Object\AbstractObject
 
$childData : array
 
$permissionControl : \com\setasign\SetaFramework\Permissions\PermissionControl
 
$savedFiles : array
 
Exceptions

Throws \com\setasign\Konquadrat\Exception

Throws ObjectIsReferencedException

Throws \JsonException

Throws \com\setasign\Konquadrat\Object\UnknownObjectException

Throws \com\setasign\Konquadrat\Object\ObjectSaveException

Throws \com\setasign\SetaFramework\Permissions\PermissionException

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
 

setValue()

protected Details::setValue (
\com\setasign\SetaFramework\Session\SessionInterface $session,
\com\setasign\Konquadrat\Object\ObjectFinder $objectFinder,
\com\setasign\Konquadrat\Field\FieldContainer\FieldContainerInterface $fieldContainer,
$name,
$value,
array &$savedFiles
): void
Parameters
$session : \com\setasign\SetaFramework\Session\SessionInterface
 
$objectFinder : \com\setasign\Konquadrat\Object\ObjectFinder
 
$fieldContainer : \com\setasign\Konquadrat\Field\FieldContainer\FieldContainerInterface
 
$name
 
$value
 
$savedFiles : array
 
Exceptions

Throws \com\setasign\Konquadrat\Exception

Throws \com\setasign\Konquadrat\Object\UnknownObjectException

uploadFilesAction()

public Details::uploadFilesAction (
void
): void
Exceptions

Throws \com\setasign\SetaFramework\Request\UploadException


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