Properties

$current_user_model

$current_user_model :\App\Site\Models\User

Type

\App\Site\Models\User—current user model

$action_buttons

$action_buttons :array

Type

array—action_buttons

$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

$translators

$translators :array

Type

array—translators

$container

$container :\Psr\Container\ContainerInterface

Type

\Psr\Container\ContainerInterface—container

Methods

getRouteGroup()

getRouteGroup(): string

gets route group

Returns

string

checkPermission()

checkPermission(string  $permission_name): boolean

checks if current user has permission

Parameters

string $permission_name

Returns

boolean

addActionLink()

addActionLink(  $key,  $link_id,  $link_text,string  $link_href = '#',string  $link_class = 'btn btn-sm btn-light',array  $attributes = array()): $this

adds an action link

Parameters

$key
$link_id
$link_text
string $link_href
string $link_class
array $attributes

Returns

$this

__construct()

__construct(\Psr\Container\ContainerInterface  $container)

constructor

Parameters

\Psr\Container\ContainerInterface $container

getRouteVerbs()

getRouteVerbs(): array

returns valid route HTTP verbs

Returns

array

process()

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

controller action

Parameters

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

Returns

\Symfony\Component\HttpFoundation\Response|self

getObjectClass()

getObjectClass(): string

{@inheritdocs}

Returns

string

renderPage()

renderPage(\App\Site\Routing\RouteInfo|null  $route_info = null,array  $route_data = array()): \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

getRequest()

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

get request object

Returns

\Symfony\Component\HttpFoundation\Request

__toString()

__toString(): string

toString magic method

Returns

string —

the form html

getUrl()

getUrl(string  $route_name,array  $route_params = array()): 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(): boolean

specifies if this controller is eligible for full page cache

Returns

boolean

getTranslator()

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

gets translator

Parameters

string|null $locale_code

Returns

\Fisharebest\Localization\Translator

__call()

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

{@inheritdocs}

Parameters

string $name
mixed $arguments

Throws

\App\Base\Exceptions\InvalidValueException

Returns

mixed

requestUrl()

requestUrl(string  $url,string  $method = 'GET',array  $options = array()): string|boolean

executes an http request

Parameters

string $url
string $method
array $options

Throws

\Exception
\GuzzleHttp\Exception\GuzzleException

Returns

string|boolean

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

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

getRouting()

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

gets routing service

Throws

\Degami\Basics\Exceptions\BasicException

Returns

\App\Site\Routing\Web

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

getEnv()

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

gets env variable

Parameters

string $variable
mixed $default

Throws

\Degami\Basics\Exceptions\BasicException

Returns

mixed

getRoutePath()

getRoutePath(): string

return route path

Returns

string

beforeRender()

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

before render hook

Throws

\App\Base\Exceptions\PermissionDeniedException

Returns

\Symfony\Component\HttpFoundation\Response|self

getAccessPermission()

getAccessPermission(): string

{@inheritdocs}

Returns

string

checkCredentials()

checkCredentials(): boolean

checks user credentials

Returns

boolean

renderActionButtons()

renderActionButtons(): string

renders action buttons

Returns

string

addActionButton()

addActionButton(string  $key,string  $button_id,string  $button_text,string  $button_class = 'btn btn-sm btn-light'): \App\Base\Traits\AdminTrait

adds an action button

Parameters

string $key
string $button_id
string $button_text
string $button_class

Returns

\App\Base\Traits\AdminTrait

getVerb()

getVerb(): string

get Request HTTP verb

Returns

string

loadObject()

loadObject(integer  $id): \App\Base\Abstracts\Models\BaseModel

loads object by id

Parameters

integer $id

Returns

\App\Base\Abstracts\Models\BaseModel

getRouteData()

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

gets route data

Parameters

null $varname

Returns

mixed|null

getResponse()

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

get response object

Returns

\Symfony\Component\HttpFoundation\Response

doRedirect()

doRedirect(  $url,array  $additional_headers = array()): \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