Documentation

BaseHtmlPage extends BasePage
in package
implements HtmlPageInterface uses PageTrait

AbstractYes

Base for pages rendering an html response

Table of Contents

Interfaces

HtmlPageInterface

Properties

$translators  : array<string|int, mixed>
$container  : ContainerInterface
$current_user  : array<string|int, mixed>|object|null
$current_user_model  : AccountModel|null
$request  : Request|null
$response  : Response
$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
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
getApp()  : App
gets app object
getAppRouteInfo()  : RouteInfo|null
gets route info
getAppWebsite()  : Website|null
gets current website
getAssets()  : Manager
gets assets manager
getBaseTemplateData()  : array<string|int, mixed>
prepares basic template data
getCache()  : Manager
get cache manager
getCacheKey()  : string
gets cache key
getContainer()  : ContainerInterface
gets container object
getControllerUrl()  : string
gets current controller url
getCrudRouter()  : Crud
gets crud service
getCurrentUser()  : AccountModel|null
gets current user
getDb()  : Database
gets db object
getDebugbar()  : StandardDebugBar
gets debugbar object
getDestParam()  : string
gets the destination param
getEnv()  : mixed
gets env variable
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
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
gets PDO object
getRedis()  : Manager
gets redis service
getRequest()  : Request
get request object
getRewriteObject()  : Rewrite|null
gets rewrite object
getRouteInfo()  : RouteInfo|null
get route_info
getRouteName()  : string
gets current route name
getRouters()  : array<string|int, mixed>
gets routers
getSchema()  : Schema
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
getTemplates()  : Engine
gets plates engine object
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|BaseHtmlPage|Response
controller entrypoint
requestUrl()  : string|bool
executes an http request
setRouteInfo()  : BasePage
set route info
tokenIsActive()  : bool
checks if token is still active
beforeRender()  : Response|self
before render hook
doRedirect()  : RedirectResponse
returns a redirect object
getResponse()  : Response
get response object
getRouteData()  : mixed
gets route data
getService()  : mixed
gets registered service
getTokenData()  : mixed
gets token data
normalizeCacheKey()  : string
prepareTemplate()  : Template
prepare template object
refreshPage()  : RedirectResponse
returns a redirect object to same page

Properties

$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

$request

protected Request|null $request = null

$response

protected Response $response

response object

$template

protected Template|null $template = null

template object

Methods

__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
Tags
throws
BasicException
throws
DependencyException
throws
NotFoundException

__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

Tags
throws
DependencyException
throws
NotFoundException
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

Tags
throws
DependencyException
throws
NotFoundException
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

Tags
throws
DependencyException
throws
NotFoundException
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

Tags
throws
DependencyException
throws
NotFoundException
Return values
self

addWarningFlashMessage()

adds a warning flash message

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

store message in session

Tags
throws
DependencyException
throws
NotFoundException
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
Tags
throws
BasicException
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

getBaseTemplateData()

prepares basic template data

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

getCacheKey()

gets cache key

public getCacheKey() : string
Return values
string

getContainer()

gets container object

public getContainer() : ContainerInterface
Return values
ContainerInterface

getControllerUrl()

gets current controller url

public getControllerUrl() : string
Tags
throws
BasicException
Return values
string

getCurrentUser()

gets current user

public getCurrentUser([bool $reset = false ]) : AccountModel|null
Parameters
$reset : bool = false
Tags
throws
DependencyException
throws
NotFoundException
Return values
AccountModel|null

getDb()

gets db object

public getDb() : Database
Tags
throws
BasicException
Return values
Database

getDebugbar()

gets debugbar object

public getDebugbar() : StandardDebugBar
Tags
throws
BasicException
Return values
StandardDebugBar

getDestParam()

gets the destination param

public getDestParam([null $destination_url = null ]) : string
Parameters
$destination_url : null = null
Tags
throws
BasicException
Return values
string

getEnv()

gets env variable

public getEnv(string $variable[, mixed $default = null ]) : mixed
Parameters
$variable : string
$default : mixed = null
Tags
throws
BasicException

getEventManager()

gets events manager service

public getEventManager() : SharedEventEmitter
Tags
throws
BasicException
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
Tags
throws
BasicException
Return values
PHPGangsta_GoogleAuthenticator

getGuzzle()

gets guzzle service

public getGuzzle() : Client
Tags
throws
BasicException
Return values
Client

getIcons()

gets icons service

public getIcons() : Icons
Tags
throws
BasicException
Return values
Icons

getImagine()

gets imagine service

public getImagine() : Imagine
Tags
throws
BasicException
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
Tags
throws
BasicException
Return values
Logger

getPageRouteName()

gets controller route name

public static getPageRouteName() : string
Return values
string

getPdo()

gets PDO object

public getPdo() : PDO
Tags
throws
BasicException
Return values
PDO

getRequest()

get request object

public getRequest() : Request
Return values
Request

getRouteName()

gets current route name

public getRouteName() : string
Return values
string

getRouters()

gets routers

public getRouters() : array<string|int, mixed>
Tags
throws
BasicException
Return values
array<string|int, mixed>

getSchema()

gets schema object

public getSchema() : Schema
Tags
throws
BasicException
Return values
Schema

getSesMailer()

gets SES mailer service

public getSesMailer() : SesClient
Tags
throws
BasicException
Return values
SesClient

getSmtpMailer()

gets SMTP mailer service

public getSmtpMailer() : Swift_Mailer
Tags
throws
BasicException
Return values
Swift_Mailer

getTemplate()

get current template

public getTemplate() : Template|null
Return values
Template|null

getTemplates()

gets plates engine object

public getTemplates() : Engine
Tags
throws
BasicException
Return values
Engine

getTranslator()

gets translator

public getTranslator([string|null $locale_code = null ]) : Translator
Parameters
$locale_code : string|null = null
Tags
throws
DependencyException
throws
NotFoundException
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> = []
Tags
throws
BasicException
Return values
string

hasLoggedUser()

checks if user is logged in

public hasLoggedUser() : bool
Tags
throws
DependencyException
throws
NotFoundException
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
Tags
throws
BasicException
throws
DependencyException
throws
NotFoundException
throws
PhpfastcacheSimpleCacheException
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> = []
Tags
throws
BasicException
throws
Throwable
throws
PhpfastcacheSimpleCacheException
Return values
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> = []
Tags
throws
Exception
throws
GuzzleException
Return values
string|bool

tokenIsActive()

checks if token is still active

public tokenIsActive(Token $token) : bool
Parameters
$token : Token
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

getResponse()

get response object

protected getResponse() : Response
Return values
Response

getRouteData()

gets route data

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

getService()

gets registered service

protected getService(string $service_key) : mixed
Parameters
$service_key : string
Tags
throws
BasicException

getTokenData()

gets token data

protected getTokenData() : mixed

normalizeCacheKey()

protected normalizeCacheKey(mixed $key) : string
Parameters
$key : mixed
Return values
string

prepareTemplate()

prepare template object

protected prepareTemplate() : Template
Tags
throws
BasicException
Return values
Template

refreshPage()

returns a redirect object to same page

protected refreshPage() : RedirectResponse
Return values
RedirectResponse 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results