com\setasign\SetaSite

SetaSite Class AbstractHttp

File: /SetaSite/src/SetaSite.php

Class hierarchy

  • com\setasign\SetaFramework\Application\AbstractHttpApplication

Implements

  • \com\setasign\SetaFramework\Application\ApplicationInterface
  • \com\setasign\SetaFramework\Application\HttpApplicationInterface

Summary

Constants

APPLICATION_NAME

public const SetaSite::APPLICATION_NAME = 'SetaSite'

ROUTE_BACKEND

public const SetaSite::ROUTE_BACKEND = 'SetaSite-backendRoutes'

ROUTE_BACKEND_DEFAULT

public const SetaSite::ROUTE_BACKEND_DEFAULT = 'SetaSite-defaultBackendRoute'

ROUTE_BACKEND_LOGGED_IN

public const SetaSite::ROUTE_BACKEND_LOGGED_IN = 'SetaSite-backendLoggedInRoutes'

ROUTE_BACKEND_USER_WITHOUT_LOGIN

public const SetaSite::ROUTE_BACKEND_USER_WITHOUT_LOGIN = 'SetaSite-backendUserWithoutLogin'

ROUTE_DEFAULT_PAGE

public const SetaSite::ROUTE_DEFAULT_PAGE = 'SetaSite-defaultPageRoute'

ROUTE_GUI

public const SetaSite::ROUTE_GUI = 'SetaSite-guiRoute'

ROUTE_GUI_JS

public const SetaSite::ROUTE_GUI_JS = 'SetaSite-guiJSRoute'

ROUTE_GUI_JS_LOGGER

public const SetaSite::ROUTE_GUI_JS_LOGGER = 'SetaSite-guiJsLogger'

ROUTE_GUI_STARTPAGE

public const SetaSite::ROUTE_GUI_STARTPAGE = 'SetaSite-guiStartpageRoute'

ROUTE_INSTALLER

public const SetaSite::ROUTE_INSTALLER = 'SetaSite-installerRoute'

ROUTE_RESOURCE

public const SetaSite::ROUTE_RESOURCE = 'SetaSite-resourceRoute'

VERSION

public const SetaSite::VERSION = '2.5.3.8'

Properties

$bootstrap

protected \com\setasign\SetaFramework\Bootstrap\Bootstrap \com\setasign\SetaFramework\Application\AbstractApplication::$bootstrap

$config

protected \com\setasign\SetaFramework\Application\ApplicationConfig \com\setasign\SetaFramework\Application\AbstractApplication::$config

$di

protected ?\com\setasign\SetaFramework\Application\ApplicationDi \com\setasign\SetaFramework\Application\AbstractApplication::$di

$name

protected string \com\setasign\SetaFramework\Application\AbstractApplication::$name

The name of the application


Static Methods

getSystemLanguages()

public static SetaSite::getSystemLanguages (
void
): array

Methods

__construct()

public SetaSite::__construct (
\com\setasign\SetaFramework\Bootstrap\Bootstrap $bootstrap,
string $name,
\com\setasign\SetaFramework\Application\ApplicationConfig $config
)

SetaSite constructor.

Parameters
$bootstrap : \com\setasign\SetaFramework\Bootstrap\Bootstrap
 
$name : string
 
$config : \com\setasign\SetaFramework\Application\ApplicationConfig
 

__debugInfo()

public \com\setasign\SetaFramework\Application\AbstractApplication::__debugInfo (
void
): void

getApplicationDirectory()

protected SetaSite::getApplicationDirectory (
void
): string

Path to application dir, usally equal to DIR

getConfig()

public \com\setasign\SetaFramework\Application\AbstractApplication::getConfig (
void
): \com\setasign\SetaFramework\Application\ApplicationConfig

getDi()

public SetaSite::getDi (
void
): \com\setasign\SetaFramework\Application\ApplicationDi

getName()

public \com\setasign\SetaFramework\Application\AbstractApplication::getName (
void
): string

Get the application name

getPageLanguage()

WARNING: This method is marked as deprecated!

Use PageSettings instead

public SetaSite::getPageLanguage (
void
): ?string

Returns the page language. Only available in backend and over the Frontend-PageController.

getPageLanguages()

WARNING: This method is marked as deprecated!

Use PageSettings instead

public SetaSite::getPageLanguages (
void
): array

Returns all registered page languages.

getRequestPathPrefix()

final public \com\setasign\SetaFramework\Application\AbstractHttpApplication::getRequestPathPrefix (
void
): ?string
Return Values

If used in cli this will be null.

getViewDirectory()

public \com\setasign\SetaFramework\Application\AbstractHttpApplication::getViewDirectory (
void
): string

Returns the view directory

getViewHelperNamespaces()

public SetaSite::getViewHelperNamespaces (
void
): array

registerRequest()

final public \com\setasign\SetaFramework\Application\AbstractHttpApplication::registerRequest (
\com\setasign\SetaFramework\Request\ServerRequest $serverRequest
): void
Parameters
$serverRequest : \com\setasign\SetaFramework\Request\ServerRequest
 

setPageLanguage()

WARNING: This method is marked as deprecated!

Use PageSettings instead

public SetaSite::setPageLanguage (
string $language
): void

Sets the page language.

Parameters
$language : string
 

setupRoutes()

public SetaSite::setupRoutes (
\com\setasign\SetaFramework\Router\Router $router
): void

Setup Routes for the Application

Parameters
$router : \com\setasign\SetaFramework\Router\Router

The main Router-instance

Exceptions

Throws \com\setasign\SetaFramework\Router\RouteException

Throws \Throwable