Loader
extends Loader
in package
Loader class for the Surikata engine. Encapsulates CASCADA for website presentation and ADIOS for administration
Table of Contents
- $adminPanel : mixed
- Reference to ADIOS object. Enables API of the administration panel.
- $controllers : mixed
- $currentPage : mixed
- $currentRenderedPlugin : mixed
- $deliveryPlugins : mixed
- $domain : mixed
- $pages : mixed
- $paymentPlugins : mixed
- $pluginObjects : mixed
- List of already loaded and created content plugins for the website presentation
- $pluginsDir : mixed
- $themeDir : mixed
- Stores the path to the folder with Theme's files
- $themeName : mixed
- Stores the name of the theme chosen in the administration panel
- $translationCache : mixed
- $userLogged : mixed
- __construct() : mixed
- Class constructor.
- getCurrentPagePluginSettings() : mixed
- getCustomerUID() : string
- Returns unique identifier of the customer / visitor of the website.
- getDeliveryPlugins() : mixed
- getPaymentPlugins() : mixed
- getPlugin() : object
- Returns the object of the content plugin.
- getSiteMap() : array<string|int, mixed>
- Loads the site map for CASCADA router.
- loadPublishedPages() : array<string|int, mixed>
- Loads the list of published sites of the website managed by the user in the administration panel.
- loadSurikataSettings() : array<string|int, mixed>
- Loads settings of the website configured by the user in the administration panel.
- onGeneralControllerAfterRouting() : mixed
- registerDeliveryPlugin() : mixed
- registerPaymentPlugin() : mixed
- render() : mixed
Properties
$adminPanel
Reference to ADIOS object. Enables API of the administration panel.
public
mixed
$adminPanel
$controllers
public
mixed
$controllers
$currentPage
public
mixed
$currentPage
$currentRenderedPlugin
public
mixed
$currentRenderedPlugin
= NULL
$deliveryPlugins
public
mixed
$deliveryPlugins
= []
$domain
public
mixed
$domain
$pages
public
mixed
$pages
$paymentPlugins
public
mixed
$paymentPlugins
= []
$pluginObjects
List of already loaded and created content plugins for the website presentation
public
mixed
$pluginObjects
= []
$pluginsDir
public
mixed
$pluginsDir
= ""
$themeDir
Stores the path to the folder with Theme's files
public
mixed
$themeDir
= ""
$themeName
Stores the name of the theme chosen in the administration panel
public
mixed
$themeName
= ""
$translationCache
public
mixed
$translationCache
= NULL
$userLogged
public
mixed
$userLogged
= NULL
Methods
__construct()
Class constructor.
public
__construct(array<string|int, mixed> $config[, mixed $adminPanel = NULL ]) : mixed
Does following:
- create the ADIOS object into the $surikata property
- load list of published sites (pages) from the database (uses Widgets/Website/Models/WebPage model)
- loads the settings of the website from the database (uses Core/Models/Config model)
- sets $themeName and $themeDir properties
- initalizes CASCADA's Twig and introduces own Twig functions 'callSurikataMethod' and 'callPluginMethod'
Parameters
- $config : array<string|int, mixed>
-
Configuration for the Surikata engine.
- $adminPanel : mixed = NULL
Return values
mixed —getCurrentPagePluginSettings()
public
getCurrentPagePluginSettings(mixed $pluginName[, mixed $panelName = "" ]) : mixed
Parameters
- $pluginName : mixed
- $panelName : mixed = ""
Return values
mixed —getCustomerUID()
Returns unique identifier of the customer / visitor of the website.
public
getCustomerUID() : string
Not implemented yet. Returns 'CustUID'.
Return values
string —Unique identifier of the customer
getDeliveryPlugins()
public
getDeliveryPlugins() : mixed
Return values
mixed —getPaymentPlugins()
public
getPaymentPlugins() : mixed
Return values
mixed —getPlugin()
Returns the object of the content plugin.
public
getPlugin(mixed $pluginName) : object
First checks if the object has already been created. If yes, simply returns it. If not, creates it, stores it into the $plugins property and returns.
Parameters
- $pluginName : mixed
Return values
object —Of class \Surikata\Plugin.
getSiteMap()
Loads the site map for CASCADA router.
public
getSiteMap() : array<string|int, mixed>
Return values
array<string|int, mixed> —Site map definition for CASCADA router.
loadPublishedPages()
Loads the list of published sites of the website managed by the user in the administration panel.
public
loadPublishedPages() : array<string|int, mixed>
Return values
array<string|int, mixed> —List of published sites.
loadSurikataSettings()
Loads settings of the website configured by the user in the administration panel.
public
loadSurikataSettings(mixed $group) : array<string|int, mixed>
Parameters
- $group : mixed
Return values
array<string|int, mixed> —Website settings configured in the administration panel.
onGeneralControllerAfterRouting()
public
onGeneralControllerAfterRouting() : mixed
Return values
mixed —registerDeliveryPlugin()
public
registerDeliveryPlugin(mixed $pluginName) : mixed
Parameters
- $pluginName : mixed
Return values
mixed —registerPaymentPlugin()
public
registerPaymentPlugin(mixed $pluginName) : mixed
Parameters
- $pluginName : mixed
Return values
mixed —render()
public
render() : mixed