Class JsonError in namespace com\setasign\SetaSite\Controller in SetaSite API Reference

Index

\com\setasign\SetaSite
1. Controller

com\setasign\SetaSite\Controller

JsonError Class JsonError

File: /SetaSite/src/Controller/JsonError.php

Class hierarchy

com\setasign\SetaFramework\Controller\AbstractJsonController
- JsonError

Implements

\com\setasign\SetaFramework\Controller\ControllerInterface

Summary

Properties

$data
$encodingOptions
$httpFactory
$response
$textContentType

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:

copy

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

$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 \com\setasign\SetaFramework\Controller\AbstractController::__construct (

\com\setasign\SetaFramework\Http\HttpFactoryInterface $httpFactory

)

Parameters

$httpFactory : \com\setasign\SetaFramework\Http\HttpFactoryInterface

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

getResponse()

public \com\setasign\SetaFramework\Controller\AbstractController::getResponse (

void

): \Psr\Http\Message\ResponseInterface

indexAction()

public JsonError::indexAction (

\com\setasign\SetaFramework\Application\ApplicationConfig $config,
\com\setasign\SetaFramework\Log\ApplicationLogHandler $logHandler,
\com\setasign\SetaSite\SessionContext $sessionContext

): void

Parameters

$config : \com\setasign\SetaFramework\Application\ApplicationConfig
$logHandler : \com\setasign\SetaFramework\Log\ApplicationLogHandler
$sessionContext : \com\setasign\SetaSite\SessionContext

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

throwableToArray()

protected JsonError::throwableToArray (

\Throwable $error,
bool $isDebug,
string $systemLanguage,
string $defaultSystemLanguage

): array

Parameters

$error : \Throwable
$isDebug : bool
$systemLanguage : string
$defaultSystemLanguage : string