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

Grid Class Grid

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

$gridFinder

protected Grid::$gridFinder

$httpFactory

protected \com\setasign\SetaFramework\Http\HttpFactoryInterface \com\setasign\SetaFramework\Controller\AbstractController::$httpFactory

$languageManager

protected Grid::$languageManager

$messageList

protected BackendJsonController::$messageList

$objectFinder

protected Grid::$objectFinder

$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 Grid::__construct (
\com\setasign\Konquadrat\SessionContext $sessionContext,
\com\setasign\Konquadrat\Object\MessageList $messageList,
\com\setasign\Konquadrat\Grid\GridFinder $gridFinder,
\com\setasign\Konquadrat\Object\ObjectFinder $objectFinder,
\com\setasign\Konquadrat\LanguageManager $languageManager,
\com\setasign\SetaFramework\Http\HttpFactoryInterface $httpFactory
)
Parameters
$sessionContext : \com\setasign\Konquadrat\SessionContext
 
$messageList : \com\setasign\Konquadrat\Object\MessageList
 
$gridFinder : \com\setasign\Konquadrat\Grid\GridFinder
 
$objectFinder : \com\setasign\Konquadrat\Object\ObjectFinder
 
$languageManager : \com\setasign\Konquadrat\LanguageManager
 
$httpFactory : \com\setasign\SetaFramework\Http\HttpFactoryInterface
 

createExportAction()

public Grid::createExportAction (): void
Parameters
$languageManager : \com\setasign\Konquadrat\LanguageManager
 
$directorySettings : \com\setasign\Konquadrat\DirectorySettings
 
$objectManager : \com\setasign\Konquadrat\Object\ObjectManager
 
$transactionManager : \com\setasign\Konquadrat\Object\TransactionManager
 
$taskProcessor : \com\setasign\Konquadrat\Task\TaskProcessor
 
Exceptions

Throws \com\setasign\Konquadrat\Exception

Throws \com\setasign\SetaFramework\Permissions\PermissionException

Throws \Throwable

Throws \com\setasign\Konquadrat\Object\ObjectSaveException

Throws \JsonException

deleteRowsAction()

public Grid::deleteRowsAction (
\com\setasign\SetaFramework\Request\ServerRequest $request,
\com\setasign\Konquadrat\Object\TransactionManager $transactionManager
): void
Parameters
$request : \com\setasign\SetaFramework\Request\ServerRequest
 
$transactionManager : \com\setasign\Konquadrat\Object\TransactionManager
 
Exceptions

Throws \com\setasign\Konquadrat\Exception

Throws \Throwable

getConfigAction()

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

Throws \com\setasign\Konquadrat\Exception

getFilteredGrid()

protected Grid::getFilteredGrid (
int|string $gridId,
mixed $context,
?int $limit,
?int $offset,
&$filter,
&$sort
): \com\setasign\Konquadrat\Grid\GridInterface
Parameters
$gridId : int|string
 
$context : mixed
 
$limit : ?int
 
$offset : ?int
 
$filter
 
$sort
 
Exceptions

Throws \JsonException

Throws \com\setasign\Konquadrat\Exception

getGrid()

protected Grid::getGrid (
int|string $gridId,
mixed $context
): \com\setasign\Konquadrat\Grid\GridInterface
Parameters
$gridId : int|string
 
$context : mixed
 
Exceptions

Throws \com\setasign\Konquadrat\Exception

getIdsAction()

public Grid::getIdsAction (
\com\setasign\SetaFramework\Request\ServerRequest $request
): void
Parameters
$request : \com\setasign\SetaFramework\Request\ServerRequest
 
Exceptions

Throws \JsonException

Throws \com\setasign\Konquadrat\Exception

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

getValuesAction()

public Grid::getValuesAction (
\com\setasign\SetaFramework\Request\ServerRequest $request,
\com\setasign\SetaFramework\SimpleCache\ApplicationCacheHandler $cacheHandler
): void
Parameters
$request : \com\setasign\SetaFramework\Request\ServerRequest
 
$cacheHandler : \com\setasign\SetaFramework\SimpleCache\ApplicationCacheHandler
 
Exceptions

Throws \JsonException

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

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
 

updateValueAction()

public Grid::updateValueAction (
\com\setasign\SetaFramework\Request\ServerRequest $request
): void
Parameters
$request : \com\setasign\SetaFramework\Request\ServerRequest
 
Exceptions

Throws \com\setasign\Konquadrat\Exception


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