Plugin
extends Plugin
in package
Table of Contents
- $adios : mixed
- Reference to ADIOS object
- $name : mixed
- Full name of the plugin. Useful for getPlugin() function
- $niceName : mixed
- __construct() : mixed
- convertUrlPatternToSiteMap() : array<string|int, mixed>
- Converts $urlPattern string with variables in it to a structured definition of sitemap used in getSitemap() method.
- getSettingsForWebsite() : array<string|int, mixed>
- Returns the definition of avaialable settings of the plugin for the website content management. Each usage of the plugin on each website of the e-commerce can have different settings stored.
- getSitemap() : array<string|int, mixed>
- Returns the structured definition of sitemap (compatible with CASCADA's sitemap definition) processed by the plugin
- init() : mixed
- install() : mixed
- loadModels() : mixed
- routing() : mixed
Properties
$adios
Reference to ADIOS object
public
mixed
$adios
$name
Full name of the plugin. Useful for getPlugin() function
public
mixed
$name
$niceName
public
mixed
$niceName
= "."
Methods
__construct()
public
__construct(mixed $adios) : mixed
Parameters
- $adios : mixed
Return values
mixed —convertUrlPatternToSiteMap()
Converts $urlPattern string with variables in it to a structured definition of sitemap used in getSitemap() method.
public
convertUrlPatternToSiteMap(mixed &$siteMap, mixed $urlPattern, mixed $variables) : array<string|int, mixed>
Used as a helper function in getSitemap().
Parameters
- $siteMap : mixed
- $urlPattern : mixed
- $variables : mixed
Return values
array<string|int, mixed> —Converted definition of sitemap (URLs) processed by the plugin.
getSettingsForWebsite()
Returns the definition of avaialable settings of the plugin for the website content management. Each usage of the plugin on each website of the e-commerce can have different settings stored.
public
getSettingsForWebsite() : array<string|int, mixed>
Return values
array<string|int, mixed> —Structured definition of available settings of the plugin for the specific web page.
getSitemap()
Returns the structured definition of sitemap (compatible with CASCADA's sitemap definition) processed by the plugin
public
getSitemap([mixed $pluginSettings = [] ][, mixed $webPageUrl = "" ]) : array<string|int, mixed>
Parameters
- $pluginSettings : mixed = []
- $webPageUrl : mixed = ""
Return values
array<string|int, mixed> —Structured sitemap definition compatible with CASCADA.
init()
public
init() : mixed
Return values
mixed —install()
public
install() : mixed
Return values
mixed —loadModels()
public
loadModels() : mixed
Return values
mixed —routing()
public
routing([array<string|int, mixed> $routing = [] ]) : mixed
Parameters
- $routing : array<string|int, mixed> = []