EventMessageThemeCompiler
Table of Contents
Methods
- __construct() : EventMessageThemeCompiler
- Constructor.
- createInstance() : EventMessageThemeCompiler
- Create instance.
- execute() : mixed
- Execute prolog, body and epilog.
- getInstance() : EventMessageThemeCompiler
- Returns current instance of the EventMessageThemeCompiler.
- getLanguageId() : mixed
- Get language id.
- getResult() : string
- Return result.
- getSiteId() : string
- Return site id.
- getSiteTemplateId() : mixed
- Get site template id.
- getStyles() : array<string|int, mixed>
- Return style list that will be added by template.
- getStylesString() : string
- Return styles as string that will be added by template.
- getThemeEpilog() : mixed
- Return theme epilog.
- getThemeProlog() : mixed
- Return theme prolog.
- includeComponent() : mixed
- Include mail component.
- includeThemeLang() : void
- Function includes language files from within the theme directory.
- setLanguageId() : mixed
- Set language id.
- setParams() : mixed
- Set params that will be used for replacing placeholders.
- setSiteId() : void
- Set site id.
- setSiteTemplateId() : mixed
- Set site template id.
- setStyle() : void
- Set style.
- setStyleArray() : void
- Set style list.
- setThemeEpilog() : mixed
- Set theme epilog.
- setThemeProlog() : mixed
- Set theme prolog.
- showStyles() : string
- Show styles that will be added by template.
- stop() : void
- Stop execution of template. Throws an exception if instance is exists.
- unsetInstance() : void
- Unset current instance of the EventMessageThemeCompiler.
Methods
__construct()
Constructor.
public
__construct([string|null $siteTemplateId = null ], string $body[, bool $isHtml = true ]) : EventMessageThemeCompiler
Parameters
- $siteTemplateId : string|null = null
- $body : string
- $isHtml : bool = true
Return values
EventMessageThemeCompilercreateInstance()
Create instance.
public
static createInstance([string|null $siteTemplateId = null ], string $body[, bool $isHtml = true ]) : EventMessageThemeCompiler
Parameters
- $siteTemplateId : string|null = null
- $body : string
- $isHtml : bool = true
Return values
EventMessageThemeCompilerexecute()
Execute prolog, body and epilog.
public
execute() : mixed
getInstance()
Returns current instance of the EventMessageThemeCompiler.
public
static getInstance() : EventMessageThemeCompiler
Tags
Return values
EventMessageThemeCompilergetLanguageId()
Get language id.
public
getLanguageId() : mixed
getResult()
Return result.
public
getResult() : string
Return values
stringgetSiteId()
Return site id.
public
getSiteId() : string
Return values
stringgetSiteTemplateId()
Get site template id.
public
getSiteTemplateId() : mixed
getStyles()
Return style list that will be added by template.
public
getStyles() : array<string|int, mixed>
Return values
array<string|int, mixed>getStylesString()
Return styles as string that will be added by template.
public
getStylesString() : string
Return values
stringgetThemeEpilog()
Return theme epilog.
public
getThemeEpilog() : mixed
getThemeProlog()
Return theme prolog.
public
getThemeProlog() : mixed
includeComponent()
Include mail component.
public
static includeComponent(mixed $componentName, mixed $componentTemplate[, mixed $arParams = array() ][, mixed $parentComponent = null ][, mixed $arFunctionParams = array() ]) : mixed
Parameters
- $componentName : mixed
- $componentTemplate : mixed
- $arParams : mixed = array()
- $parentComponent : mixed = null
- $arFunctionParams : mixed = array()
includeThemeLang()
Function includes language files from within the theme directory.
public
final includeThemeLang([string $relativePath = "" ]) : void
For example: $this->includeThemeLang("header.php") will include "lang/en/header.php" file.
Note: theme must be inited by setTheme method.
Parameters
- $relativePath : string = ""
setLanguageId()
Set language id.
public
setLanguageId(mixed $languageId) : mixed
Parameters
- $languageId : mixed
setParams()
Set params that will be used for replacing placeholders.
public
setParams(array<string|int, mixed> $params) : mixed
Parameters
- $params : array<string|int, mixed>
setSiteId()
Set site id.
public
setSiteId(mixed $siteId) : void
Parameters
- $siteId : mixed
setSiteTemplateId()
Set site template id.
public
setSiteTemplateId(mixed $siteTemplateId) : mixed
Parameters
- $siteTemplateId : mixed
setStyle()
Set style.
public
setStyle(mixed $path[, bool $sort = false ]) : void
Parameters
- $path : mixed
- $sort : bool = false
setStyleArray()
Set style list.
public
setStyleArray(array<string|int, mixed> $arPaths[, bool $sort = false ]) : void
Parameters
- $arPaths : array<string|int, mixed>
- $sort : bool = false
setThemeEpilog()
Set theme epilog.
public
setThemeEpilog(mixed $themeEpilog) : mixed
Parameters
- $themeEpilog : mixed
setThemeProlog()
Set theme prolog.
public
setThemeProlog(mixed $themeProlog) : mixed
Parameters
- $themeProlog : mixed
showStyles()
Show styles that will be added by template.
public
showStyles() : string
Return values
stringstop()
Stop execution of template. Throws an exception if instance is exists.
public
static stop() : void
Tags
unsetInstance()
Unset current instance of the EventMessageThemeCompiler.
public
static unsetInstance() : void