com\setasign\SetaSite\Controller\Backend
Module Class Controller Json
File: /SetaSite/src/Controller/Backend/Module.php
Class hierarchy
- com\setasign\SetaFramework\Controller\AbstractJsonController
Implements
- \com\setasign\SetaFramework\Controller\ControllerInterface
Summary
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
$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 Module::__construct (
\com\setasign\SetaSite\SessionContext $sessionContext,
\com\setasign\SetaFramework\Http\HttpFactoryInterface $httpFactory,
\com\setasign\SetaSite\Module\ModuleManager $moduleManager
)\com\setasign\SetaFramework\Http\HttpFactoryInterface $httpFactory,
\com\setasign\SetaSite\Module\ModuleManager $moduleManager
Parameters
- $sessionContext : \com\setasign\SetaSite\SessionContext
- $httpFactory : \com\setasign\SetaFramework\Http\HttpFactoryInterface
- $moduleManager : \com\setasign\SetaSite\Module\ModuleManager
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
getParams()
-
public \com\setasign\SetaFramework\Controller\AbstractController::getParams (
void
): arrayGet all existing params
getRegisteredModulesAction()
public Module::getRegisteredModulesAction (
\com\setasign\SetaSite\SessionContext $sessionContext
): voidParameters
- $sessionContext : \com\setasign\SetaSite\SessionContext
getRequest()
protected AbstractBackendJsonController::getRequest (
void
): \com\setasign\SetaFramework\Request\ServerRequestgetResponse()
-
public \com\setasign\SetaFramework\Controller\AbstractController::getResponse (
void
): \Psr\Http\Message\ResponseInterfacegetSession()
protected AbstractBackendJsonController::getSession (
void
): \com\setasign\SetaFramework\Session\SessionInterfacerenderView()
-
protected \com\setasign\SetaFramework\Controller\AbstractJsonController::renderView (
void
): voidExceptions
Throws \JsonException
resetResponse()
-
public \com\setasign\SetaFramework\Controller\AbstractController::resetResponse (
void
): voidsetParam()
-
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