com\setasign\Konquadrat\Controller\Backend
ConfigInstaller Class ConfigInstaller
File: /Konquadrat/src/Controller/Backend/ConfigInstaller.php
Class hierarchy
Implements
Summary
Properties
$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
$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
)\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
getConfigInstallerPath()
protected ConfigInstaller::getConfigInstallerPath (
\com\setasign\SetaFramework\Application\ApplicationConfig $applicationConfig
): stringParameters
- $applicationConfig: \com\setasign\SetaFramework\Application\ApplicationConfig
Exceptions
getListAction()
public ConfigInstaller::getListAction (
\com\setasign\Konquadrat\DirectorySettings $directorySettings,
\com\setasign\SetaFramework\Application\ApplicationConfig $applicationConfig
): void\com\setasign\SetaFramework\Application\ApplicationConfig $applicationConfig
Parameters
- $directorySettings: \com\setasign\Konquadrat\DirectorySettings
- $applicationConfig: \com\setasign\SetaFramework\Application\ApplicationConfig
Exceptions
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
getRequest()
protected BackendJsonController::getRequest (
void
): \com\setasign\SetaFramework\Request\ServerRequestgetResponse()
public \com\setasign\SetaFramework\Controller\AbstractController::getResponse (
void
): \Psr\Http\Message\ResponseInterfacegetSession()
protected BackendJsonController::getSession (
void
): \com\setasign\SetaFramework\Session\SessionInterfaceinstallAction()
public ConfigInstaller::installAction (
\com\setasign\Konquadrat\DirectorySettings $directorySettings,
\com\setasign\SetaFramework\Application\ApplicationConfig $applicationConfig
): void\com\setasign\SetaFramework\Application\ApplicationConfig $applicationConfig
Parameters
- $directorySettings: \com\setasign\Konquadrat\DirectorySettings
- $applicationConfig: \com\setasign\SetaFramework\Application\ApplicationConfig
Exceptions
Throws \com\setasign\Konquadrat\Exception
Throws \Throwable
renderView()
Exceptions
Throws \JsonException
setParam()
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
