Documentation

FrontendPage extends BaseHtmlPage
in package

Degami

Sitebase

uses FrontendPageTrait

AbstractYes

Base for frontend pages

Properties

$translators : array<string|int, mixed>
$container : ContainerInterface
$current_user : array<string|int, mixed>|object|null
$current_user_model : AccountModel|null
$current_website : Website|null
$regions : array<string|int, mixed>
$request : Request|null
$response : Response
$rewrite : Rewrite|null
$route_info : RouteInfo|null
$template : Template|null

Methods

__call() : mixed: {@inheritdoc}
__construct() : mixed: BasePage constructor.
__toString() : string: toString magic method
addErrorFlashMessage() : self: adds a error flash message
addFlashMessage() : self: adds a flash message for next response
addInfoFlashMessage() : self: adds an info flash message
addSuccessFlashMessage() : self: adds a success flash message
addTag() : self|bool: adds a tag to page region
addWarningFlashMessage() : self: adds a warning flash message
calcTokenId() : string: calculates JWT token id
canBeFPC() : bool: specifies if this controller is eligible for full page cache
checkPermission() : bool: checks if current user has specified permission
containerCall() : mixed: call method through container
containerMake() : mixed: create object through container
dropFlashMessages() : self: removes all currently stored flash messages
getAdminRouter() : Admin: gets admin service
getAI() : Manager: gets ai manager service
getApp() : App: gets app object
getApplicationLogger() : Manager: gets application_logger service
getAppRouteInfo() : RouteInfo|null: gets route info
getAppWebsite() : Website|null: gets current website
getAssets() : Manager: gets assets manager
getAuth() : Manager: gets auth manager service
getBaseTemplateData() : array<string|int, mixed>: prepares basic template data
getCache() : Manager: get cache manager
getCacheKey() : string: gets cache key
getContainer() : ContainerInterface|Container: gets container object
getControllerUrl() : string: gets current controller url
getCrudRouter() : Crud: gets crud service
getCurrentLocale() : string|null: gets current page's locale
getCurrentUser() : AccountModel|null: gets current user
getCurrentWebsite() : Website|null: gets current website model
getCurrentWebsiteId() : int|null: gets current website id
getDb() : Database|null: gets db object
getDebugbar() : StandardDebugBar: gets debugbar object
getDestParam() : string: gets the destination param
getEnvironment() : Manager: gets environment manager service
getEventManager() : SharedEventEmitter: gets events manager service
getFlashMessages() : array<string|int, mixed>|null: gets currently stored flash messages
getFpcCacheKey() : string: gets fpc cache key
getGoogleAuthenticator() : PHPGangsta_GoogleAuthenticator: gets google authenticator service
getGuzzle() : Client: gets guzzle service
getGZip() : GZip: gets gzip service
getHtmlRenderer() : HtmlPartsRenderer: gets html renderer service
getIcons() : Icons: gets icons service
getImagine() : Imagine: gets imagine service
getInfo() : array<string|int, mixed>: gets info about current page
getLog() : Logger: gets log object
getMailer() : Mailer: gets mailer service
getPageRouteName() : string: gets controller route name
getPdo() : PDO|null: gets PDO object
getRedis() : Manager: gets redis service
getRequest() : Request: get request object
getResponse() : Response: get response object
getRewrite() : Rewrite|null: gets Rewrite object for current page
getRewriteObject() : Rewrite|null: gets rewrite object
getRouteGroup() : string|null: gets route group
getRouteInfo() : RouteInfo|null: get route_info
getRouteName() : string: gets current route name
getRouters() : array<string|int, mixed>: gets routers
getSchema() : Schema|null: gets schema object
getSearch() : Manager: gets search service
getSesMailer() : SesClient: gets SES mailer service
getSiteData() : SiteData: gets site data service
getSmtpMailer() : Swift_Mailer: gets SMTP mailer service
getTemplate() : Template|null: get current template
getTemplateData() : array<string|int, mixed>: {@inheritdoc}
getTemplates() : Engine: gets plates engine object
getTokenData() : mixed: gets token data
getTranslations() : array<string|int, mixed>: get current page translations urls
getTranslator() : Translator: gets translator
getUrl() : string: gets url by route_name and params
getUtils() : Globals: gets global utils service
getWebhooksRouter() : Webhooks: gets webhooks service
getWebRouter() : Web: gets routing service
getZip() : Zip: gets zip service
hasLoggedUser() : bool: checks if user is logged in
isEnabled() : bool: determines if route is available for router
isHomePage() : bool: checks if current is homepage
process() : Response: controller action
renderPage() : BasePage|Response: controller entrypoint
requestUrl() : string|bool: executes an http request
returnAfterLogin() : RedirectResponse: gets a RedirectResponse to loginPage that will return tu current page after login
setRouteInfo() : BasePage: set route info
showBlocks() : bool: show blocks flag.
showMenu() : bool: show menu flag.
alterTemplateName() : string: eventually alters template name
beforeRender() : Response|self: before render hook
check2FA() : bool: checks if 2FA is passed
checkCredentials() : bool: checks user credentials
doRedirect() : RedirectResponse: returns a redirect object
getHtmlBodyClasses() : string
getRegionTags() : bool|string: get page region tags html
getRouteData() : mixed: gets route data
getService() : mixed: gets registered service
normalizeCacheKey() : string
prepareTemplate() : Template: prepare template object
refreshPage() : RedirectResponse: returns a redirect object to same page

$translators


    public
    static    array<string|int, mixed>
    $translators
     = []

translators

$container


    protected
        ContainerInterface
    $container

$current_user


    protected
        array<string|int, mixed>|object|null
    $current_user
     = null

current user data

$current_user_model


    protected
        AccountModel|null
    $current_user_model
     = null

current user model

$current_website


    protected
        Website|null
    $current_website
     = null

current website model

$regions


    protected
        array<string|int, mixed>
    $regions
     = []

page regions

$request


    protected
        Request|null
    $request
     = null

$response


    protected
        Response
    $response

response object

$rewrite


    protected
        Rewrite|null
    $rewrite
     = null

rewrite

$route_info


    protected
        RouteInfo|null
    $route_info
     = null

$template


    protected
        Template|null
    $template
     = null

template object

__call()

{@inheritdoc}


    public
                    __call(string $name, mixed $arguments) : mixed

Parameters

$name : string
$arguments : mixed

__construct()

BasePage constructor.


    public
                    __construct(ContainerInterface $container[, Request $request = null ][, RouteInfo $route_info = null ]) : mixed

Parameters

$container : ContainerInterface
$request : Request = null
$route_info : RouteInfo = null

__toString()

toString magic method


    public
                    __toString() : string

Return values

string —

the form html

addErrorFlashMessage()

adds a error flash message


    public
                    addErrorFlashMessage(string $message[, bool $direct = false ]) : self

Parameters

$message : string
$direct : bool = false: store message in session

Return values

self

addFlashMessage()

adds a flash message for next response


    public
                    addFlashMessage(string $type, string $message[, bool $direct = false ]) : self

Parameters

$type : string
$message : string
$direct : bool = false: store message in session

Return values

self

addInfoFlashMessage()

adds an info flash message


    public
                    addInfoFlashMessage(string $message[, bool $direct = false ]) : self

Parameters

$message : string
$direct : bool = false: store message in session

Return values

self

addSuccessFlashMessage()

adds a success flash message


    public
                    addSuccessFlashMessage(string $message[, bool $direct = false ]) : self

Parameters

$message : string
$direct : bool = false: store message in session

Return values

self

addTag()

adds a tag to page region


    public
                    addTag(string $region, TagElement|array<string|int, mixed> $tag) : self|bool

Parameters

$region : string
$tag : TagElement|array<string|int, mixed>

Return values

self|bool

addWarningFlashMessage()

adds a warning flash message


    public
                    addWarningFlashMessage(string $message[, bool $direct = false ]) : self

Parameters

$message : string
$direct : bool = false: store message in session

Return values

self

calcTokenId()

calculates JWT token id


    public
                    calcTokenId(int $uid, string $username) : string

Parameters

$uid : int
$username : string

Return values

string

canBeFPC()

specifies if this controller is eligible for full page cache


    public
                    canBeFPC() : bool

Return values

bool

checkPermission()

checks if current user has specified permission


    public
                    checkPermission(string $permission_name) : bool

Parameters

$permission_name : string

Return values

bool

containerCall()

call method through container


    public
                    containerCall(callable $callable[, array<string|int, mixed> $arguments = [] ]) : mixed

Parameters

$callable : callable
$arguments : array<string|int, mixed> = []

containerMake()

create object through container


    public
                    containerMake(string $className[, array<string|int, mixed> $arguments = [] ]) : mixed

Parameters

$className : string
$arguments : array<string|int, mixed> = []

dropFlashMessages()

removes all currently stored flash messages


    public
                    dropFlashMessages() : self

Return values

self

getAdminRouter()

gets admin service


    public
                    getAdminRouter() : Admin

Return values

Admin

getAI()

gets ai manager service


    public
                    getAI() : Manager

Return values

Manager

getApp()

gets app object


    public
                    getApp() : App

Return values

App

getApplicationLogger()

gets application_logger service


    public
                    getApplicationLogger() : Manager

Return values

Manager

getAppRouteInfo()

gets route info


    public
                    getAppRouteInfo() : RouteInfo|null

Return values

RouteInfo|null

getAppWebsite()

gets current website


    public
                    getAppWebsite() : Website|null

Return values

Website|null

getAssets()

gets assets manager


    public
                    getAssets() : Manager

Return values

Manager

getAuth()

gets auth manager service


    public
                    getAuth() : Manager

Return values

Manager

getBaseTemplateData()

prepares basic template data


    public
                    getBaseTemplateData() : array<string|int, mixed>

Return values

array<string|int, mixed>

getCache()

get cache manager


    public
                    getCache() : Manager

Return values

Manager

getCacheKey()

gets cache key


    public
                    getCacheKey() : string

Return values

string

getContainer()

gets container object


    public
                    getContainer() : ContainerInterface|Container

Return values

ContainerInterface|Container

getControllerUrl()

gets current controller url


    public
                    getControllerUrl() : string

Return values

string

getCrudRouter()

gets crud service


    public
                    getCrudRouter() : Crud

Return values

Crud

getCurrentLocale()

gets current page's locale


    public
                    getCurrentLocale() : string|null

Return values

string|null

getCurrentUser()

gets current user


    public
                    getCurrentUser([bool $reset = false ]) : AccountModel|null

Parameters

$reset : bool = false

Return values

AccountModel|null

getCurrentWebsite()

gets current website model


    public
                    getCurrentWebsite() : Website|null

Return values

Website|null

getCurrentWebsiteId()

gets current website id


    public
                    getCurrentWebsiteId() : int|null

Return values

int|null

getDb()

gets db object


    public
                    getDb() : Database|null

Return values

Database|null

getDebugbar()

gets debugbar object


    public
                    getDebugbar() : StandardDebugBar

Return values

StandardDebugBar

getDestParam()

gets the destination param


    public
                    getDestParam([string|null $destination_url = null ]) : string

Parameters

$destination_url : string|null = null

Return values

string

getEnvironment()

gets environment manager service


    public
                    getEnvironment() : Manager

Return values

Manager

getEventManager()

gets events manager service


    public
                    getEventManager() : SharedEventEmitter

Return values

SharedEventEmitter

getFlashMessages()

gets currently stored flash messages


    public
                    getFlashMessages([bool $direct = false ]) : array<string|int, mixed>|null

Parameters

$direct : bool = false: session stored flash messages

Return values

array<string|int, mixed>|null

getFpcCacheKey()

gets fpc cache key


    public
                    getFpcCacheKey() : string

Return values

string

getGoogleAuthenticator()

gets google authenticator service


    public
                    getGoogleAuthenticator() : PHPGangsta_GoogleAuthenticator

Return values

PHPGangsta_GoogleAuthenticator

getGuzzle()

gets guzzle service


    public
                    getGuzzle() : Client

Return values

Client

getGZip()

gets gzip service


    public
                    getGZip() : GZip

Return values

GZip

getHtmlRenderer()

gets html renderer service


    public
                    getHtmlRenderer() : HtmlPartsRenderer

Return values

HtmlPartsRenderer

getIcons()

gets icons service


    public
                    getIcons() : Icons

Return values

Icons

getImagine()

gets imagine service


    public
                    getImagine() : Imagine

Return values

Imagine

getInfo()

gets info about current page


    public
                    getInfo() : array<string|int, mixed>

Return values

array<string|int, mixed>

getLog()

gets log object


    public
                    getLog() : Logger

Return values

Logger

getMailer()

gets mailer service


    public
                    getMailer() : Mailer

Return values

Mailer

getPageRouteName()

gets controller route name


    public
            static        getPageRouteName() : string

Return values

string

getPdo()

gets PDO object


    public
                    getPdo() : PDO|null

Return values

PDO|null

getRedis()

gets redis service


    public
                    getRedis() : Manager

Return values

Manager

getRequest()

get request object


    public
                    getRequest() : Request

Return values

Request

getResponse()

get response object


    public
                    getResponse() : Response

Return values

Response

getRewrite()

gets Rewrite object for current page


    public
                    getRewrite([bool $reset = false ]) : Rewrite|null

Parameters

$reset : bool = false

Return values

Rewrite|null

getRewriteObject()

gets rewrite object


    public
                    getRewriteObject() : Rewrite|null

Return values

Rewrite|null

getRouteGroup()

gets route group


    public
            static        getRouteGroup() : string|null

Return values

string|null

getRouteInfo()

get route_info


    public
                    getRouteInfo() : RouteInfo|null

Return values

RouteInfo|null

getRouteName()

gets current route name


    public
                    getRouteName() : string

Return values

string

getRouters()

gets routers


    public
                    getRouters() : array<string|int, mixed>

Return values

array<string|int, mixed>

getSchema()

gets schema object


    public
                    getSchema() : Schema|null

Return values

Schema|null

getSearch()

gets search service


    public
                    getSearch() : Manager

Return values

Manager

getSesMailer()

gets SES mailer service


    public
                    getSesMailer() : SesClient

Return values

SesClient

getSiteData()

gets site data service


    public
                    getSiteData() : SiteData

Return values

SiteData

getSmtpMailer()

gets SMTP mailer service


    public
                    getSmtpMailer() : Swift_Mailer

Return values

Swift_Mailer

getTemplate()

get current template


    public
                    getTemplate() : Template|null

Return values

Template|null

getTemplateData()

{@inheritdoc}


    public
                    getTemplateData() : array<string|int, mixed>

Return values

array<string|int, mixed>

getTemplates()

gets plates engine object


    public
                    getTemplates() : Engine

Return values

Engine

getTokenData()

gets token data


    public
                    getTokenData() : mixed

getTranslations()

get current page translations urls


    public
                    getTranslations() : array<string|int, mixed>

Return values

array<string|int, mixed>

getTranslator()

gets translator


    public
                    getTranslator([string|null $locale_code = null ]) : Translator

Parameters

$locale_code : string|null = null

Return values

Translator

getUrl()

gets url by route_name and params


    public
                    getUrl(string $route_name[, array<string|int, mixed> $route_params = [] ]) : string

Parameters

$route_name : string
$route_params : array<string|int, mixed> = []

Return values

string

getUtils()

gets global utils service


    public
                    getUtils() : Globals

Return values

Globals

getWebhooksRouter()

gets webhooks service


    public
                    getWebhooksRouter() : Webhooks

Return values

Webhooks

getWebRouter()

gets routing service


    public
                    getWebRouter() : Web

Return values

Web

getZip()

gets zip service


    public
                    getZip() : Zip

Return values

Zip

hasLoggedUser()

checks if user is logged in


    public
                    hasLoggedUser() : bool

Return values

bool

isEnabled()

determines if route is available for router


    public
            static        isEnabled() : bool

Return values

bool

isHomePage()

checks if current is homepage


    public
                    isHomePage() : bool

Return values

bool

process()

controller action


    public
                    process([RouteInfo|null $route_info = null ][, array<string|int, mixed> $route_data = [] ]) : Response

Parameters

$route_info : RouteInfo|null = null
$route_data : array<string|int, mixed> = []

Return values

Response

renderPage()

controller entrypoint


    public
                    renderPage([RouteInfo|null $route_info = null ][, array<string|int, mixed> $route_data = [] ]) : BasePage|Response

Parameters

$route_info : RouteInfo|null = null
$route_data : array<string|int, mixed> = []

Return values

BasePage|Response

requestUrl()

executes an http request


    public
                    requestUrl(string $url[, string $method = 'GET' ][, array<string|int, mixed> $options = [] ]) : string|bool

Parameters

$url : string
$method : string = 'GET'
$options : array<string|int, mixed> = []

Return values

string|bool

returnAfterLogin()

gets a RedirectResponse to loginPage that will return tu current page after login


    public
                    returnAfterLogin([string $custom_message = null ]) : RedirectResponse

Parameters

$custom_message : string = null

Return values

RedirectResponse

setRouteInfo()

set route info


    public
                    setRouteInfo(RouteInfo $routeInfo) : BasePage

Parameters

$routeInfo : RouteInfo

Return values

BasePage

showBlocks()

show blocks flag.


    public
                    showBlocks() : bool

utility function, subclasses can override this method to disable blocks load

Return values

bool

showMenu()

show menu flag.


    public
                    showMenu() : bool

utility function, subclasses can override this method to disable menu load

Return values

bool

alterTemplateName()

eventually alters template name


    protected
                    alterTemplateName(string $templateName) : string

Parameters

$templateName : string

Return values

string

beforeRender()

before render hook


    protected
                    beforeRender() : Response|self

Return values

Response|self

check2FA()

checks if 2FA is passed


    protected
                    check2FA() : bool

Return values

bool

checkCredentials()

checks user credentials


    protected
                    checkCredentials() : bool

Return values

bool

doRedirect()

returns a redirect object


    protected
                    doRedirect(mixed $url[, array<string|int, mixed> $additional_headers = [] ]) : RedirectResponse

Parameters

$url : mixed
$additional_headers : array<string|int, mixed> = []

Return values

RedirectResponse

getHtmlBodyClasses()


    protected
                    getHtmlBodyClasses() : string

Return values

string

getRegionTags()

get page region tags html


    protected
                    getRegionTags(string $region) : bool|string

Parameters

$region : string

Return values

bool|string

getRouteData()

gets route data


    protected
                    getRouteData([mixed|null $var_name = null ]) : mixed

Parameters

$var_name : mixed|null = null

getService()

gets registered service


    protected
                    getService(string $service_key) : mixed

Parameters

$service_key : string

normalizeCacheKey()


    protected
                    normalizeCacheKey(mixed $key) : string

Parameters

$key : mixed

Return values

string

prepareTemplate()

prepare template object


    protected
                    prepareTemplate() : Template

Return values

Template

refreshPage()

returns a redirect object to same page


    protected
                    refreshPage([array<string|int, mixed> $urlParams = [] ]) : RedirectResponse

Parameters

$urlParams : array<string|int, mixed> = []

Return values

RedirectResponse

FrontendPage extends BaseHtmlPage in package Degami Sitebase uses FrontendPageTrait

Table of Contents

Properties

Methods

Properties

$translators

$container

$current_user

$current_user_model

$current_website

$regions

$request

$response

$rewrite

$route_info

$template

Methods

__call()

Parameters

Tags

__construct()

Parameters

Tags

__toString()

Return values

addErrorFlashMessage()

Parameters

Tags

Return values

addFlashMessage()

Parameters

Tags

Return values

addInfoFlashMessage()

Parameters

Tags

Return values

addSuccessFlashMessage()

Parameters

Tags

Return values

addTag()

Parameters

Return values

addWarningFlashMessage()

Parameters

Tags

Return values

calcTokenId()

Parameters

Return values

canBeFPC()

Return values

checkPermission()

Parameters

Tags

Return values

containerCall()

Parameters

containerMake()

Parameters

dropFlashMessages()

Return values

getAdminRouter()

Tags

Return values

getAI()

Tags

Return values

getApp()

Tags

Return values

getApplicationLogger()

Tags

Return values

getAppRouteInfo()

Return values

getAppWebsite()

Return values

getAssets()

FrontendPage extends BaseHtmlPage
in package

Degami

Sitebase

uses FrontendPageTrait