com\setasign\Konquadrat\Controller\Backend

History Class History

File: /Konquadrat/src/Controller/Backend/History.php

Class hierarchy

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

$history

protected History::$history

$httpFactory

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

$messageList

$response

protected ?\Psr\Http\Message\ResponseInterface \com\setasign\SetaFramework\Controller\AbstractController::$response

$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 History::__construct (
\com\setasign\Konquadrat\SessionContext $sessionContext,
\com\setasign\Konquadrat\Object\MessageList $messageList,
\com\setasign\Konquadrat\Object\History $history,
\com\setasign\SetaFramework\Http\HttpFactoryInterface $httpFactory
)
Parameters
$sessionContext : \com\setasign\Konquadrat\SessionContext
 
$messageList : \com\setasign\Konquadrat\Object\MessageList
 
$history : \com\setasign\Konquadrat\Object\History
 
$httpFactory : \com\setasign\SetaFramework\Http\HttpFactoryInterface
 

getAction()

public History::getAction (
\com\setasign\Konquadrat\Object\ObjectFinder $objectFinder,
\com\setasign\SetaFramework\Database\Database $database
): void
Parameters
$objectFinder : \com\setasign\Konquadrat\Object\ObjectFinder
 
$database : \com\setasign\SetaFramework\Database\Database
 
Exceptions

Throws \JsonException

Throws \com\setasign\SetaFramework\Permissions\PermissionException

getDetailsAction()

public History::getDetailsAction (
void
): void
Exceptions

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

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

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