com\setasign\Konquadrat\Controller\Backend\V2
AbstractController Class Controller Json
File: /Konquadrat/src/Controller/Backend/V2/AbstractController.php
Class hierarchy
Implements
Summary
Properties
$config
protected AbstractController::$config
$data
protected mixed \com\setasign\SetaFramework\Controller\AbstractJsonController::$data
Result data to convert to JSON.
$encodingOptions
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
$languageManager
protected AbstractController::$languageManager
$logHandler
protected AbstractController::$logHandler
$messageList
protected AbstractController::$messageList
$objectFinder
protected AbstractController::$objectFinder
$objectManager
protected AbstractController::$objectManager
$response
protected ?\Psr\Http\Message\ResponseInterface \com\setasign\SetaFramework\Controller\AbstractController::$response
$sessionContext
protected AbstractController::$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 AbstractController::__construct (
\com\setasign\SetaFramework\Http\HttpFactoryInterface $httpFactory,
\com\setasign\SetaFramework\Application\ApplicationConfig $config,
\com\setasign\Konquadrat\Object\ObjectFinder $objectFinder,
\com\setasign\Konquadrat\Object\ObjectManager $objectManager,
\com\setasign\Konquadrat\LanguageManager $languageManager,
\com\setasign\Konquadrat\SessionContext $sessionContext,
\com\setasign\Konquadrat\Object\MessageList $messageList,
\com\setasign\SetaFramework\Log\ApplicationLogHandler $logHandler
)\com\setasign\SetaFramework\Application\ApplicationConfig $config,
\com\setasign\Konquadrat\Object\ObjectFinder $objectFinder,
\com\setasign\Konquadrat\Object\ObjectManager $objectManager,
\com\setasign\Konquadrat\LanguageManager $languageManager,
\com\setasign\Konquadrat\SessionContext $sessionContext,
\com\setasign\Konquadrat\Object\MessageList $messageList,
\com\setasign\SetaFramework\Log\ApplicationLogHandler $logHandler
Parameters
- $httpFactory: \com\setasign\SetaFramework\Http\HttpFactoryInterface
- $config: \com\setasign\SetaFramework\Application\ApplicationConfig
- $objectFinder: \com\setasign\Konquadrat\Object\ObjectFinder
- $objectManager: \com\setasign\Konquadrat\Object\ObjectManager
- $languageManager: \com\setasign\Konquadrat\LanguageManager
- $sessionContext: \com\setasign\Konquadrat\SessionContext
- $messageList: \com\setasign\Konquadrat\Object\MessageList
- $logHandler: \com\setasign\SetaFramework\Log\ApplicationLogHandler
addCorsHeaders()
public AbstractController::addCorsHeaders (
\Psr\Http\Message\ResponseInterface $response
): \Psr\Http\Message\ResponseInterfaceParameters
- $response: \Psr\Http\Message\ResponseInterface
getParam()
public \com\setasign\SetaFramework\Controller\AbstractController::getParam (
string $name,
mixed $default = null
): ?mixedmixed $default = null
Returns a param if it exists otherwise this will return $default
Parameters
- $name: string
- $default: mixed
getPermissionControl()
protected AbstractController::getPermissionControl (
void
): \com\setasign\Konquadrat\Permission\PermissionControlgetRequest()
protected AbstractController::getRequest (
void
): \com\setasign\SetaFramework\Request\ServerRequestgetResponse()
public \com\setasign\SetaFramework\Controller\AbstractController::getResponse (
void
): \Psr\Http\Message\ResponseInterfacegetSession()
protected AbstractController::getSession (
void
): \com\setasign\SetaFramework\Session\SessionInterfacesetParam()
public \com\setasign\SetaFramework\Controller\AbstractController::setParam (
string $name,
mixed $value
): \com\setasign\SetaFramework\Controller\ControllerInterfacemixed $value
Sets a param
Parameters
- $name: string
- $value: mixed
setParams()
public \com\setasign\SetaFramework\Controller\AbstractController::setParams (
array $params
): \com\setasign\SetaFramework\Controller\ControllerInterfaceSet a array of params
Note: The params will be merged with the existing params!!
Parameters
- $params: array
