Documentation
\
App
Base
Abstracts
Blocks
Commands
Controllers
Migrations
Models
Queues
Routing
Controllers
Dummy
Exceptions
Overrides
Migrations
Tools
Assets
Cache
DataCollector
Plates
Utils
Traits
Site
Blocks
Commands
App
Cache
Config
Cron
Db
Generate
Info
Mail
Queue
Roles
Search
Users
Website
Controllers
Admin
Json
Frontend
Users
Cron
Tasks
Crud
Admin
Migrations
Models
Queues
ContactFormMail
InternalMail
LinkFormMail
Routing

\App\Base\Abstracts\ControllersFrontendPageWithObject

Base for a page displaying a model

Summary

Methods
Properties
Constants
getRouteGroup()
getTranslations()
getCurrentLocale()
__construct()
addTag()
renderPage()
getRewrite()
getCurrentWebsiteId()
getCurrentWebsite()
showMenu()
showBlocks()
process()
getTemplate()
getInfo()
addFlashMessage()
dropFlashMessages()
getFlashMessages()
calcTokenId()
tokenIsActive()
getCurrentUser()
checkPermission()
hasLoggedUser()
isHomePage()
getRequest()
getRouteInfo()
__toString()
getUrl()
getRouteName()
getControllerUrl()
getDestParam()
canBeFPC()
getTranslator()
__call()
getContainer()
getApp()
getLog()
getTemplates()
getDebugbar()
getDb()
getPdo()
getSchema()
getEventManager()
getWebRouter()
getCrudRouter()
getRouters()
getUtils()
getSiteData()
getAssets()
getGuzzle()
getImagine()
getMailer()
getSesMailer()
getSmtpMailer()
getCache()
getHtmlRenderer()
getIcons()
getElasticsearch()
getEnv()
getAppRouteInfo()
getAppWebsite()
requestUrl()
getObjectTitle()
getObjectClass()
$translators
No constants found
getTemplateData()
setObject()
getObject()
checkCredentials()
getBaseTemplateData()
getRegionTags()
prepareTemplate()
beforeRender()
getTemplateName()
getTokenHeader()
getToken()
getTokenValidationData()
getTokenData()
getRouteData()
getResponse()
doRedirect()
getService()
$template_data
$current_user_model
$locale
$rewrite
$regions
$template
$current_user
$route_info
$request
$response
$container
N/A
No private methods found
No private properties found
N/A

Properties

$translators

$translators : array

Type

array — translators

$template_data

$template_data : array

Type

array — template data

$current_user_model

$current_user_model : \App\Site\Models\User

Type

User — current user model

$locale

$locale : string

Type

string — locale

$rewrite

$rewrite : \App\Site\Models\Rewrite|null

Type

Rewrite|null — rewrite

$regions

$regions : array

Type

array — page regions

$template

$template : \League\Plates\Template\Template

Type

\League\Plates\Template\Template — template object

$current_user

$current_user : array

Type

array — current user data

$route_info

$route_info : \App\Site\Routing\RouteInfo

Type

RouteInfo — route info object

$request

$request : \Symfony\Component\HttpFoundation\Request

Type

\Symfony\Component\HttpFoundation\Request — request object

$response

$response : \Symfony\Component\HttpFoundation\Response

Type

\Symfony\Component\HttpFoundation\Response — response object

$container

$container : \Psr\Container\ContainerInterface

Type

\Psr\Container\ContainerInterface — container

Methods

getRouteGroup()

getRouteGroup() : string

gets route group

Returns

string —

getTranslations()

getTranslations() : array

get current page translations urls

Throws

\Degami\Basics\Exceptions\BasicException

Returns

array —

getCurrentLocale()

getCurrentLocale() : string

gets current page's locale

Throws

\Degami\Basics\Exceptions\BasicException
\DI\DependencyException
\DI\NotFoundException

Returns

string —

__construct()

__construct(\Psr\Container\ContainerInterface  $container) : mixed

constructor

Parameters

\Psr\Container\ContainerInterface $container

Returns

mixed —

addTag()

addTag(string  $region, \Degami\Basics\Html\TagElement|array  $tag) : self|false

adds a tag to page region

Parameters

string $region
\Degami\Basics\Html\TagElement|array $tag

Returns

self|false —

renderPage()

renderPage(\App\Site\Routing\RouteInfo|null  $route_info = null, array  $route_data = []) : \Symfony\Component\HttpFoundation\Response|self

controller entrypoint

Parameters

\App\Site\Routing\RouteInfo|null $route_info
array $route_data

Throws

\App\Base\Exceptions\PermissionDeniedException

Returns

\Symfony\Component\HttpFoundation\Response|self —

getRewrite()

getRewrite(bool  $reset = false) : \App\Site\Models\Rewrite|null

gets Rewrite object for current page

Parameters

bool $reset

Returns

\App\Site\Models\Rewrite|null —

getCurrentWebsiteId()

getCurrentWebsiteId() : int|string|null

gets current website id

Throws

\Degami\Basics\Exceptions\BasicException
\DI\DependencyException
\DI\NotFoundException

Returns

int|string|null —

getCurrentWebsite()

getCurrentWebsite() : \App\Site\Models\Website|int|string|null

gets current website model

Throws

\Degami\Basics\Exceptions\BasicException
\DI\DependencyException
\DI\NotFoundException

Returns

\App\Site\Models\Website|int|string|null —

showMenu()

showMenu() : bool

show menu flag.

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

Returns

bool —

showBlocks()

showBlocks() : bool

show blocks flag.

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

Returns

bool —

process()

process(\App\Site\Routing\RouteInfo|null  $route_info = null, array  $route_data = []) : \Symfony\Component\HttpFoundation\Response

{@inheritdocs}

Parameters

\App\Site\Routing\RouteInfo|null $route_info
array $route_data

Throws

\Exception
\Throwable

Returns

\Symfony\Component\HttpFoundation\Response —

getTemplate()

getTemplate() : \League\Plates\Template\Template

get current template

Returns

\League\Plates\Template\Template —

getInfo()

getInfo() : array

gets info about current page

Returns

array —

addFlashMessage()

addFlashMessage(string  $type, string  $message) : self

adds a flash message for next response

Parameters

string $type
string $message

Throws

\DI\DependencyException
\DI\NotFoundException

Returns

self —

dropFlashMessages()

dropFlashMessages() : self

removes all currently stored flash messages

Returns

self —

getFlashMessages()

getFlashMessages() : array

gets currently stored flash messages

Returns

array —

calcTokenId()

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

calculates JWT token id

Parameters

int $uid
string $username

Returns

string —

tokenIsActive()

tokenIsActive(\Lcobucci\JWT\Token  $token) : bool

checks if token is still active

Parameters

\Lcobucci\JWT\Token $token

Throws

\DI\DependencyException
\DI\NotFoundException

Returns

bool —

getCurrentUser()

getCurrentUser(bool  $reset = false) : \App\Site\Models\User|\App\Site\Models\GuestUser|null

gets current user

Parameters

bool $reset

Throws

\DI\DependencyException
\DI\NotFoundException

Returns

\App\Site\Models\User|\App\Site\Models\GuestUser|null —

checkPermission()

checkPermission(string  $permission_name) : bool

checks if current user has specified permission

Parameters

string $permission_name

Throws

\Degami\Basics\Exceptions\BasicException

Returns

bool —

hasLoggedUser()

hasLoggedUser() : bool

checks if user is logged in

Throws

\DI\DependencyException
\DI\NotFoundException

Returns

bool —

isHomePage()

isHomePage() : bool

checks if current is homepage

Throws

\Degami\Basics\Exceptions\BasicException
\DI\DependencyException
\DI\NotFoundException
\Phpfastcache\Exceptions\PhpfastcacheSimpleCacheException

Returns

bool —

getRequest()

getRequest() : \Symfony\Component\HttpFoundation\Request

gets current request object

Throws

\Degami\Basics\Exceptions\BasicException

Returns

\Symfony\Component\HttpFoundation\Request —

getRouteInfo()

getRouteInfo() : \App\Site\Routing\RouteInfo

get route_info array

Returns

\App\Site\Routing\RouteInfo —

__toString()

__toString() : string

toString magic method

Returns

string —

the form html

getUrl()

getUrl(string  $route_name, array  $route_params = []) : string

gets url by route_name and params

Parameters

string $route_name
array $route_params

Throws

\Degami\Basics\Exceptions\BasicException

Returns

string —

getRouteName()

getRouteName() : string

gets current route name

Returns

string —

getControllerUrl()

getControllerUrl() : string

gets current controller url

Throws

\Degami\Basics\Exceptions\BasicException

Returns

string —

getDestParam()

getDestParam(null  $destination_url = null) : string

gets the destination param

Parameters

null $destination_url

Throws

\Degami\Basics\Exceptions\BasicException

Returns

string —

canBeFPC()

canBeFPC() : bool

{@inheritdocs}

Returns

bool —

getTranslator()

getTranslator(string|null  $locale_code = null) : \Fisharebest\Localization\Translator

gets translator

Parameters

string|null $locale_code

Throws

\DI\DependencyException
\DI\NotFoundException

Returns

\Fisharebest\Localization\Translator —

__call()

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

{@inheritdocs}

Parameters

string $name
mixed $arguments

Throws

\App\Base\Exceptions\InvalidValueException

Returns

mixed —

getContainer()

getContainer() : \Psr\Container\ContainerInterface

gets container object

Returns

\Psr\Container\ContainerInterface —

getApp()

getApp() : \App\App

gets app object

Throws

\Degami\Basics\Exceptions\BasicException

Returns

\App\App —

getLog()

getLog() : \Monolog\Logger

gets log object

Throws

\Degami\Basics\Exceptions\BasicException

Returns

\Monolog\Logger —

getTemplates()

getTemplates() : \League\Plates\Engine

gets plates engine object

Throws

\Degami\Basics\Exceptions\BasicException

Returns

\League\Plates\Engine —

getDebugbar()

getDebugbar() : \DebugBar\StandardDebugBar

gets debugbar object

Throws

\Degami\Basics\Exceptions\BasicException

Returns

\DebugBar\StandardDebugBar —

getDb()

getDb() : \LessQL\Database

gets db object

Throws

\Degami\Basics\Exceptions\BasicException

Returns

\LessQL\Database —

getPdo()

getPdo() : \PDO

gets PDO object

Throws

\Degami\Basics\Exceptions\BasicException

Returns

\PDO —

getSchema()

getSchema() : \Degami\SqlSchema\Schema

gets schema object

Throws

\Degami\Basics\Exceptions\BasicException

Returns

\Degami\SqlSchema\Schema —

getEventManager()

getEventManager() : \Gplanchat\EventManager\SharedEventEmitter

gets events manager service

Throws

\Degami\Basics\Exceptions\BasicException

Returns

\Gplanchat\EventManager\SharedEventEmitter —

getWebRouter()

getWebRouter() : \App\Site\Routing\Web

gets routing service

Throws

\Degami\Basics\Exceptions\BasicException

Returns

\App\Site\Routing\Web —

getCrudRouter()

getCrudRouter() : \App\Site\Routing\Crud

gets crud service

Throws

\Degami\Basics\Exceptions\BasicException

Returns

\App\Site\Routing\Crud —

getRouters()

getRouters() : array

gets routers

Throws

\Degami\Basics\Exceptions\BasicException

Returns

array —

getUtils()

getUtils() : \App\Base\Tools\Utils\Globals

gets global utils service

Throws

\Degami\Basics\Exceptions\BasicException

Returns

\App\Base\Tools\Utils\Globals —

getSiteData()

getSiteData() : \App\Base\Tools\Utils\SiteData

gets site data service

Throws

\Degami\Basics\Exceptions\BasicException

Returns

\App\Base\Tools\Utils\SiteData —

getAssets()

getAssets() : \App\Base\Tools\Assets\Manager

gets assets manager

Throws

\Degami\Basics\Exceptions\BasicException

Returns

\App\Base\Tools\Assets\Manager —

getGuzzle()

getGuzzle() : \GuzzleHttp\Client

gets guzzle service

Throws

\Degami\Basics\Exceptions\BasicException

Returns

\GuzzleHttp\Client —

getImagine()

getImagine() : \Imagine\Gd\Imagine

gets imagine service

Throws

\Degami\Basics\Exceptions\BasicException

Returns

\Imagine\Gd\Imagine —

getMailer()

getMailer() : \App\Base\Tools\Utils\Mailer

gets mailer service

Throws

\Degami\Basics\Exceptions\BasicException

Returns

\App\Base\Tools\Utils\Mailer —

getSesMailer()

getSesMailer() : \Aws\Ses\SesClient

gets SES mailer service

Throws

\Degami\Basics\Exceptions\BasicException

Returns

\Aws\Ses\SesClient —

getSmtpMailer()

getSmtpMailer() : \Swift_Mailer

gets SMTP mailer service

Throws

\Degami\Basics\Exceptions\BasicException

Returns

\Swift_Mailer —

getCache()

getCache() : \App\Base\Tools\Cache\Manager

get cache manager

Throws

\Degami\Basics\Exceptions\BasicException

Returns

\App\Base\Tools\Cache\Manager —

getHtmlRenderer()

getHtmlRenderer() : \App\Base\Tools\Utils\HtmlPartsRenderer

gets html renderer service

Throws

\Degami\Basics\Exceptions\BasicException

Returns

\App\Base\Tools\Utils\HtmlPartsRenderer —

getIcons()

getIcons() : \Feather\Icons

gets icons service

Throws

\Degami\Basics\Exceptions\BasicException

Returns

\Feather\Icons —

getElasticsearch()

getElasticsearch() : \ElasticSearch\Client

gets elasticsearch service

Throws

\Degami\Basics\Exceptions\BasicException

Returns

\ElasticSearch\Client —

getEnv()

getEnv(string  $variable, mixed  $default = null) : mixed

gets env variable

Parameters

string $variable
mixed $default

Throws

\Degami\Basics\Exceptions\BasicException

Returns

mixed —

getAppRouteInfo()

getAppRouteInfo() : \App\Site\Routing\RouteInfo|null

gets route info

Returns

\App\Site\Routing\RouteInfo|null —

getAppWebsite()

getAppWebsite() : \App\Site\Models\Website|null

gets current website

Returns

\App\Site\Models\Website|null —

requestUrl()

requestUrl(string  $url, string  $method = 'GET', array  $options = []) : string|bool

executes an http request

Parameters

string $url
string $method
array $options

Throws

\Exception
\GuzzleHttp\Exception\GuzzleException

Returns

string|bool —

getObjectTitle()

getObjectTitle() : string

gets object title

Returns

string —

getObjectClass()

getObjectClass() : string

gets object class name for loading

Returns

string —

getTemplateData()

getTemplateData() : array

gets current page template data

Returns

array —

setObject()

setObject(\App\Base\Abstracts\Models\BaseModel  $object) : self

sets object to show

Parameters

\App\Base\Abstracts\Models\BaseModel $object

Returns

self —

getObject()

getObject() : \App\Base\Abstracts\Models\BaseModel|null

gets object to show

Returns

\App\Base\Abstracts\Models\BaseModel|null —

checkCredentials()

checkCredentials() : bool

checks user credentials

Throws

\Degami\Basics\Exceptions\BasicException

Returns

bool —

getBaseTemplateData()

getBaseTemplateData() : array

prepares basic template data

Returns

array —

getRegionTags()

getRegionTags(string  $region) : string

get page region tags html

Parameters

string $region

Returns

string —

prepareTemplate()

prepareTemplate() : \League\Plates\Template\Template

prepare template object

Throws

\Degami\Basics\Exceptions\BasicException

Returns

\League\Plates\Template\Template —

beforeRender()

beforeRender() : \Symfony\Component\HttpFoundation\Response|self

{@inheritdocs}

Throws

\App\Base\Exceptions\PermissionDeniedException
\Degami\Basics\Exceptions\BasicException

Returns

\Symfony\Component\HttpFoundation\Response|self —

getTemplateName()

getTemplateName() : string

gets current page template name

Returns

string —

getTokenHeader()

getTokenHeader() : string

gets Authorization token header

Returns

string —

getToken()

getToken() : \Lcobucci\JWT\Token

gets Authorization token Object

Returns

\Lcobucci\JWT\Token —

getTokenValidationData()

getTokenValidationData( $token) : \Lcobucci\JWT\ValidationData

gets token validation data

Parameters

$token

Throws

\DI\DependencyException
\DI\NotFoundException

Returns

\Lcobucci\JWT\ValidationData —

getTokenData()

getTokenData() : array|bool

gets token data

Returns

array|bool —

getRouteData()

getRouteData(null  $var_name = null) : mixed|null

gets route data

Parameters

null $var_name

Returns

mixed|null —

getResponse()

getResponse() : \Symfony\Component\HttpFoundation\Response

get response object

Returns

\Symfony\Component\HttpFoundation\Response —

doRedirect()

doRedirect( $url, array  $additional_headers = []) : \Symfony\Component\HttpFoundation\RedirectResponse

returns a redirect object

Parameters

$url
array $additional_headers

Returns

\Symfony\Component\HttpFoundation\RedirectResponse —

getService()

getService(string  $service_key) : mixed

gets registered service

Parameters

string $service_key

Throws

\Degami\Basics\Exceptions\BasicException

Returns

mixed —