com\setasign\SetaSite\Controller\Frontend

Gui Class Gui

File: /SetaSite/src/Controller/Frontend/Gui.php

Class hierarchy

  • com\setasign\SetaFramework\Controller\AbstractViewController

Implements

  • \com\setasign\SetaFramework\Controller\ControllerInterface

Summary

Constants

DEFTJS_VERSION

private const Gui::DEFTJS_VERSION = 'deftjs-0.9.1'

EXTJS_VERSION

private const Gui::EXTJS_VERSION = 'ext-4.2.1.883'

Properties

$applicationConfig

$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

$viewScript

protected string \com\setasign\SetaFramework\Controller\AbstractViewController::$viewScript

Methods

__construct()

public Gui::__construct (
\com\setasign\SetaFramework\Http\HttpFactoryInterface $httpFactory,
\com\setasign\SetaFramework\View\View $view,
\com\setasign\SetaFramework\Application\ApplicationConfig $applicationConfig
)
Parameters
$httpFactory : \com\setasign\SetaFramework\Http\HttpFactoryInterface
 
$view : \com\setasign\SetaFramework\View\View
 
$applicationConfig : \com\setasign\SetaFramework\Application\ApplicationConfig
 

buildJavascriptFile()

protected Gui::buildJavascriptFile (
void
): void

getBackendJavascriptAction()

public Gui::getBackendJavascriptAction (
\com\setasign\SetaFramework\SimpleCache\ApplicationCacheHandler $cacheHandler
): void
Parameters
$cacheHandler : \com\setasign\SetaFramework\SimpleCache\ApplicationCacheHandler
 

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

getView()

public \com\setasign\SetaFramework\Controller\AbstractViewController::getView (
void
): \com\setasign\SetaFramework\View\View

Returns the view

indexAction()

public Gui::indexAction (
\com\setasign\SetaFramework\Request\ServerRequest $request,
\com\setasign\SetaSite\Controller\Backend\BackendSsoHelper $ssoHelper,
\com\setasign\SetaFramework\Bootstrap\RequestPathPrefix $requestPathPrefix
): void
Parameters
$request : \com\setasign\SetaFramework\Request\ServerRequest
 
$ssoHelper : \com\setasign\SetaSite\Controller\Backend\BackendSsoHelper
 
$requestPathPrefix : \com\setasign\SetaFramework\Bootstrap\RequestPathPrefix
 

renderView()

protected \com\setasign\SetaFramework\Controller\AbstractViewController::renderView (
void
): void
Exceptions

Throws \com\setasign\SetaFramework\View\ViewException

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
 

startPageAction()

public Gui::startPageAction (
\com\setasign\SetaFramework\Application\ApplicationConfig $applicationConfig,
\com\setasign\SetaFramework\Request\ServerRequest $request,
\com\setasign\SetaSite\Page\PageSettings $pageSettings,
\com\setasign\SetaSite\Page\PagePathAndLanguageNegotiator $pagePathAndLanguageNegotiator
): void
Parameters
$applicationConfig : \com\setasign\SetaFramework\Application\ApplicationConfig
 
$request : \com\setasign\SetaFramework\Request\ServerRequest
 
$pageSettings : \com\setasign\SetaSite\Page\PageSettings
 
$pagePathAndLanguageNegotiator : \com\setasign\SetaSite\Page\PagePathAndLanguageNegotiator
 
Exceptions

Throws \com\setasign\SetaSite\Page\UnknownPageException