com\setasign\Konquadrat\Controller\Backend\V2

Config Class Controller Json

File: /Konquadrat/src/Controller/Backend/V2/Config.php

Class hierarchy

Implements

Summary

Constants

PERMISSION_ACTION_READ

public const Config::PERMISSION_ACTION_READ = 'read'

PERMISSION_ACTION_RELOAD

public const Config::PERMISSION_ACTION_RELOAD = 'reload'

Properties

$config

$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

$logHandler

$messageList

$objectFinder

$objectManager

$response

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

$sessionContext

$textContentType

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

addCorsHeaders()

public AbstractController::addCorsHeaders (
\Psr\Http\Message\ResponseInterface $response
): \Psr\Http\Message\ResponseInterface
Parameters
$response: \Psr\Http\Message\ResponseInterface
 

errorAction()

public AbstractController::errorAction (
void
): void

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()

Get all existing params

getPath()

protected Config::getPath (
\com\setasign\Konquadrat\DirectorySettings $directorySettings,
string $type
): string
Parameters
$directorySettings: \com\setasign\Konquadrat\DirectorySettings

,

$type: string
 

getResponse()

public \com\setasign\SetaFramework\Controller\AbstractController::getResponse (
void
): \Psr\Http\Message\ResponseInterface

preflightAction()

public AbstractController::preflightAction (
void
): void

removeEmptyDirectories()

protected Config::removeEmptyDirectories (
\com\setasign\Konquadrat\DirectorySettings $directorySettings,
string $path
): void
Parameters
$directorySettings: \com\setasign\Konquadrat\DirectorySettings
 
$path: string
 
Exceptions

Throws \com\setasign\Konquadrat\Exception

renderView()

protected AbstractController::renderView (
void
): void
Exceptions

Throws \JsonException

setParam()

Sets a param

Parameters
$name: string
 
$value: mixed
 

setParams()

Set a array of params

Note: The params will be merged with the existing params!!

Parameters
$params: array