Constants

CLASS_METHOD

CLASS_METHOD

HTTP_VERBS

HTTP_VERBS

Properties

$translators

$translators :array

Type

array—translators

$container

$container :\Psr\Container\ContainerInterface

Type

\Psr\Container\ContainerInterface—container

$dispatcher

$dispatcher :\FastRoute\Dispatcher

Type

\FastRoute\Dispatcher—dispatcher

$routes

$routes :array

Type

array—routes

$avoid_parameter_names

$avoid_parameter_names :array

Type

array—reserved parameter names

Methods

__construct()

__construct(\Psr\Container\ContainerInterface  $container)

class constructor

Parameters

\Psr\Container\ContainerInterface $container

Throws

\App\Base\Exceptions\InvalidValueException
\Exception

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

addRoute()

addRoute(string  $group,string  $name,string  $path,string  $class,string  $method = 'renderPage',array<mixed,string>  $verbs = array('GET', 'POST')): \App\Site\Routing\Web

adds a route

Parameters

string $group
string $name
string $path
string $class
string $method
array<mixed,string> $verbs

Returns

\App\Site\Routing\Web

checkRoute()

checkRoute(\Psr\Container\ContainerInterface  $container,string  $route): boolean

checks a route

Parameters

\Psr\Container\ContainerInterface $container
string $route

Returns

boolean

getDispatcher()

getDispatcher(): \FastRoute\Dispatcher

gets dispatcher

Returns

\FastRoute\Dispatcher

getRoutes()

getRoutes(): array

gets routes

Returns

array

getRoute()

getRoute(string  $name): array

gets a single route

Parameters

string $name

Returns

array

getBaseUrl()

getBaseUrl(): string

return base site url

Throws

\Degami\Basics\Exceptions\BasicException

Returns

string

getUrl()

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

Returns url for given route

Parameters

string $route_name
array $route_params

Throws

\Degami\Basics\Exceptions\BasicException

Returns

string

getRequestInfo()

getRequestInfo(\Psr\Container\ContainerInterface  $container,string|null  $http_method = null,string|null  $request_uri = null,string|null  $domain = null): \App\Site\Routing\RouteInfo

returns a RouteInfo instance for current request

Parameters

\Psr\Container\ContainerInterface $container
string|null $http_method
string|null $request_uri
string|null $domain

Returns

\App\Site\Routing\RouteInfo

getService()

getService(string  $service_key): mixed

gets registered service

Parameters

string $service_key

Throws

\Degami\Basics\Exceptions\BasicException

Returns

mixed

checkRouteParameters()

checkRouteParameters(string  $route): boolean

checks route parameters

Parameters

string $route

Returns

boolean

checkRouteVerbs()

checkRouteVerbs(array  $verbs): array

checks route http verbs

Parameters

array $verbs

Returns

array

getRouteByClass()

getRouteByClass(string  $class): array

gets route by class

Parameters

string $class

Returns

array

getCachedRoutes()

getCachedRoutes(\Psr\Container\ContainerInterface  $container): array

gets cached routes

Parameters

\Psr\Container\ContainerInterface $container

Returns

array

getCachedControllers()

getCachedControllers(\Psr\Container\ContainerInterface  $container): array

gets cached controllers

Parameters

\Psr\Container\ContainerInterface $container

Returns

array

_insertRoutes()

_insertRoutes(\FastRoute\RouteCollector  $r,array  $paths): self

adds routes

Parameters

\FastRoute\RouteCollector $r
array $paths

Returns

self

_insertRoute()

_insertRoute(\FastRoute\RouteCollector  $r,array  $p): self

adds a route

Parameters

\FastRoute\RouteCollector $r
array $p

Returns

self