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\Tools\UtilsSiteData

Site Data Helper Class

Summary

Methods
Properties
Constants
__construct()
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()
getRequest()
getAppRouteInfo()
getAppWebsite()
requestUrl()
currentServerName()
getCurrentWebsite()
getCurrentWebsiteId()
getDefaultLocale()
getBrowserPreferredLanguage()
preloadConfiguration()
getCachedConfig()
getConfigValue()
getHomePageId()
getHomePageRedirectsToLanguage()
getShowLogoOnMenu()
getSiteEmail()
getSiteLocales()
getMainMenuName()
getThemeName()
getDateFormat()
getRedirects()
getPageRegions()
getBlockRegions()
getAllPageBlocks()
getSiteMenu()
buildSiteMenu()
$translators
LOCALES_PATH
HOMEPAGE_ID_PATH
HOMEPAGE_REDIRECTS_TO_LANGUAGE_PATH
MAINMENU_PATH
SITE_EMAIL_PATH
CONFIGURATION_CACHE_KEY
MENU_LOGO_PATH
THEMENAME_PATH
DEFAULT_LOCALE
DATE_FORMAT_PATH
getService()
menuElementToArray()
$container
N/A
No private methods found
No private properties found
N/A

Constants

LOCALES_PATH

LOCALES_PATH = 'app/frontend/langs'

HOMEPAGE_ID_PATH

HOMEPAGE_ID_PATH = 'app/frontend/homepage'

HOMEPAGE_REDIRECTS_TO_LANGUAGE_PATH

HOMEPAGE_REDIRECTS_TO_LANGUAGE_PATH = 'app/frontend/homepage_redirects_to_language'

MAINMENU_PATH

MAINMENU_PATH = 'app/frontend/main_menu'

SITE_EMAIL_PATH

SITE_EMAIL_PATH = 'app/global/site_mail_address'

CONFIGURATION_CACHE_KEY

CONFIGURATION_CACHE_KEY = 'site.configuration'

MENU_LOGO_PATH

MENU_LOGO_PATH = 'app/frontend/menu_with_logo'

THEMENAME_PATH

THEMENAME_PATH = 'app/frontend/themename'

DEFAULT_LOCALE

DEFAULT_LOCALE = 'en'

DATE_FORMAT_PATH

DATE_FORMAT_PATH = 'app/frontend/date_format'

Properties

$translators

$translators : array

Type

array — translators

$container

$container : \Psr\Container\ContainerInterface

Type

\Psr\Container\ContainerInterface — container

Methods

__construct()

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

constructor

Parameters

\Psr\Container\ContainerInterface $container

Returns

mixed —

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 —

getRequest()

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

gets current request object

Throws

\Degami\Basics\Exceptions\BasicException

Returns

\Symfony\Component\HttpFoundation\Request —

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 —

currentServerName()

currentServerName() : string

gets current server name

Returns

string —

getCurrentWebsite()

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

gets current website id

Throws

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

Returns

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

getCurrentWebsiteId()

getCurrentWebsiteId() : int|null

gets current website id

Throws

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

Returns

int|null —

getDefaultLocale()

getDefaultLocale() : string|null

gets default site locale

Throws

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

Returns

string|null —

getBrowserPreferredLanguage()

getBrowserPreferredLanguage() : string

gets preferred language by browser configuration

Throws

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

Returns

string —

preloadConfiguration()

preloadConfiguration() : array

loads configuration

Throws

\Degami\Basics\Exceptions\BasicException
\Phpfastcache\Exceptions\PhpfastcacheSimpleCacheException

Returns

array —

getCachedConfig()

getCachedConfig() : array

get cached config

Throws

\Phpfastcache\Exceptions\PhpfastcacheSimpleCacheException
\Degami\Basics\Exceptions\BasicException
\Phpfastcache\Exceptions\PhpfastcacheSimpleCacheException
\Degami\Basics\Exceptions\BasicException

Returns

array —

getConfigValue()

getConfigValue(string  $config_path, int|null  $website_id = null, string|null  $locale = null) : mixed

gets config value

Parameters

string $config_path
int|null $website_id
string|null $locale

Throws

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

Returns

mixed —

getHomePageId()

getHomePageId(null  $website_id = null, null  $locale = null) : mixed|null

gets homepage page id

Parameters

null $website_id
null $locale

Throws

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

Returns

mixed|null —

getHomePageRedirectsToLanguage()

getHomePageRedirectsToLanguage(null  $website_id = null) : bool

gets homepage redirects to default language preference

Parameters

null $website_id

Throws

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

Returns

bool —

getShowLogoOnMenu()

getShowLogoOnMenu(null  $website_id = null) : bool

gets show logo in menu preference

Parameters

null $website_id

Throws

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

Returns

bool —

getSiteEmail()

getSiteEmail(null  $website_id = null) : mixed|null

gets website email address

Parameters

null $website_id

Throws

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

Returns

mixed|null —

getSiteLocales()

getSiteLocales(null  $website_id = null) : false|string[]

gets site enabled locales

Parameters

null $website_id

Throws

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

Returns

false|string[] —

getMainMenuName()

getMainMenuName(null  $website_id = null, null  $locale = null) : mixed|null

gets main menu name

Parameters

null $website_id
null $locale

Throws

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

Returns

mixed|null —

getThemeName()

getThemeName(null  $website_id = null, null  $locale = null) : mixed|null

gets main menu name

Parameters

null $website_id
null $locale

Throws

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

Returns

mixed|null —

getDateFormat()

getDateFormat(null  $website_id = null, null  $locale = null) : string

gets date format string

Parameters

null $website_id
null $locale

Throws

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

Returns

string —

getRedirects()

getRedirects(int|null  $current_website_id, bool  $reset = false) : array|mixed

gets defined redirects

Parameters

int|null $current_website_id
bool $reset

Throws

\Degami\Basics\Exceptions\BasicException
\Phpfastcache\Exceptions\PhpfastcacheSimpleCacheException

Returns

array|mixed —

getPageRegions()

getPageRegions() : array

get page regions list

Throws

\Degami\Basics\Exceptions\BasicException

Returns

array —

getBlockRegions()

getBlockRegions() : array

gets available block regions

Throws

\Degami\Basics\Exceptions\BasicException

Returns

array —

getAllPageBlocks()

getAllPageBlocks(string|null  $locale = null) : array

gets all blocks for current locale

Parameters

string|null $locale

Throws

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

Returns

array —

getSiteMenu()

getSiteMenu(string  $menu_name, int  $website_id, string  $locale, \App\Site\Models\Menu|null  $menu_element = null) : array

returns site menu

Parameters

string $menu_name
int $website_id
string $locale
\App\Site\Models\Menu|null $menu_element

Throws

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

Returns

array —

buildSiteMenu()

buildSiteMenu(array  $menu_items, \App\Site\Models\Menu|null  $menu_element = null) : array

returns site menu

Parameters

array $menu_items
\App\Site\Models\Menu|null $menu_element

Throws

\Degami\Basics\Exceptions\BasicException

Returns

array —

getService()

getService(string  $service_key) : mixed

gets registered service

Parameters

string $service_key

Throws

\Degami\Basics\Exceptions\BasicException

Returns

mixed —

menuElementToArray()

menuElementToArray(\App\Site\Models\Menu  $menu_element) : array

converts a menu element to array

Parameters

\App\Site\Models\Menu $menu_element

Throws

\Degami\Basics\Exceptions\BasicException

Returns

array —