Class Device in namespace com\setasign\Konquadrat\Controller\MobileCheckinBackend in Konquadrat API Reference

Index

\com\setasign\Konquadrat
1. Controller
  1. MobileCheckinBackend

com\setasign\Konquadrat\Controller\MobileCheckinBackend

Device Class Controller Json

File: /Konquadrat/src/Controller/MobileCheckinBackend/Device.php

Class hierarchy

com\setasign\SetaFramework\Controller\AbstractJsonController
- AbstractController
  - Device

Implements

\com\setasign\SetaFramework\Controller\ControllerInterface

Summary

Properties

$config
$data
$encodingOptions
$httpFactory
$languageManager
$objectFinder
$objectManager
$response
$sessionContext
$textContentType

Properties

$config

protected AbstractController::$config

$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

$sessionContext

protected AbstractController::$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 AbstractController::__construct (

\com\setasign\SetaFramework\Http\HttpFactoryInterface $httpFactory,
\com\setasign\SetaFramework\Application\ApplicationConfig $config,
\com\setasign\Konquadrat\Object\ObjectFinder $objectFinder,
\com\setasign\Konquadrat\Object\ObjectManager $objectManager,
\com\setasign\Konquadrat\LanguageManager $languageManager,
\com\setasign\Konquadrat\SessionContext $sessionContext

)

Parameters

$httpFactory : \com\setasign\SetaFramework\Http\HttpFactoryInterface
$config : \com\setasign\SetaFramework\Application\ApplicationConfig
$objectFinder : \com\setasign\Konquadrat\Object\ObjectFinder
$objectManager : \com\setasign\Konquadrat\Object\ObjectManager
$languageManager : \com\setasign\Konquadrat\LanguageManager
$sessionContext : \com\setasign\Konquadrat\SessionContext

addCorsHeaders()

public AbstractController::addCorsHeaders (

\Psr\Http\Message\ResponseInterface $response

): \Psr\Http\Message\ResponseInterface

Parameters

$response : \Psr\Http\Message\ResponseInterface

changeNameAction()

public Device::changeNameAction (

void

): void

Exceptions

Throws \Throwable

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

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

loginAction()

public Device::loginAction (

\com\setasign\SetaFramework\Request\ServerRequest $request,
\com\setasign\Konquadrat\LanguageManager $languageManager,
\com\setasign\Konquadrat\Controller\Backend\LoginTryLimiter $limiter

): void

Parameters

$request : \com\setasign\SetaFramework\Request\ServerRequest
$languageManager : \com\setasign\Konquadrat\LanguageManager
$limiter : \com\setasign\Konquadrat\Controller\Backend\LoginTryLimiter

Exceptions

Throws \Throwable

logoutAction()

public Device::logoutAction (

void

): void

preflightAction()

public AbstractController::preflightAction (

void

): void

renderView()

protected AbstractController::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