interface ComponentInterface

View component interface

Constants

UNKNOWN_COMPONENT

TEMPLATE_COMPONENT

EXTENSION_COMPONENT

PRIMARY_TEMLATE

COMPONENTS_LIBRARY

ARIKAIM_COMPONENT_TYPE

VUE_COMPONENT_TYPE

REACT_COMPONENT_TYPE

STATIC_COMPONENT_TYPE

EMAIL_COMPONENT_TYPE

SVG_COMPONENT_TYPE

JSON_COMPONENT_TYPE

EMPTY_COMPONENT_TYPE

HTML_COMPONENT_TYPE

JS_COMPONENT_TYPE

Methods

array
getOptions()

Get options

void
addIncludedComponent(string $name, string $type)

Add included component

array
getIncludedComponents()

Get included components

void
setContext(array $context)

Set context

array
getContext()

Get context

string|null
getIncludeFile(string $fileType)

Get include file url

void
addFile(array $file, string $fileType)

Add file

string|false
getComponentFile(string $fileExt)

Get component file

string
getFullPath()

Get full path

array
toArray()

Convert to array

void
setPrimaryTemplate(string $name)

Set primary template name

string
getLanguage()

Get language code

string|null
getError()

Get error

bool
hasError()

Return true if component have error

bool
hasContent()

Return true if component is not empty

array
getFiles(string|null $fileType = null)

Return component files

string
getName()

Get name

int
getLocation()

Get component location

void
setComponentType(string $type)

Set component type

string
getComponentType()

Get component type

bool
isValid()

Check if component is valid

string
getHtmlCode()

Get component html code

string
url()

Get url

string|null
getTemplateFile()

Get template file

void
setHtmlCode(string $code)

Set html code

void
setError(string $code)

Set error

void
clearContent()

Clear content

string
getTemplateUrl()

Get template url

string|null
getFullName()

Get component full name

string|null
getTemplateName()

Get template or extension name

string
getBasePath()

Return base path

Details

at line 41
array getOptions()

Get options

Return Value

array

at line 50
void addIncludedComponent(string $name, string $type)

Add included component

Parameters

string $name
string $type

Return Value

void

at line 57
array getIncludedComponents()

Get included components

Return Value

array

at line 65
void setContext(array $context)

Set context

Parameters

array $context

Return Value

void

at line 72
array getContext()

Get context

Return Value

array

at line 80
string|null getIncludeFile(string $fileType)

Get include file url

Parameters

string $fileType

Return Value

string|null

at line 89
void addFile(array $file, string $fileType)

Add file

Parameters

array $file
string $fileType

Return Value

void

at line 97
string|false getComponentFile(string $fileExt)

Get component file

Parameters

string $fileExt

Return Value

string|false

at line 104
string getFullPath()

Get full path

Return Value

string

at line 111
array toArray()

Convert to array

Return Value

array

at line 119
void setPrimaryTemplate(string $name)

Set primary template name

Parameters

string $name

Return Value

void

at line 126
string getLanguage()

Get language code

Return Value

string

at line 133
string|null getError()

Get error

Return Value

string|null

at line 140
bool hasError()

Return true if component have error

Return Value

bool

at line 147
bool hasContent()

Return true if component is not empty

Return Value

bool

at line 155
array getFiles(string|null $fileType = null)

Return component files

Parameters

string|null $fileType

Return Value

array

at line 162
string getName()

Get name

Return Value

string

at line 169
int getLocation()

Get component location

Return Value

int

at line 177
void setComponentType(string $type)

Set component type

Parameters

string $type

Return Value

void

at line 184
string getComponentType()

Get component type

Return Value

string

at line 191
bool isValid()

Check if component is valid

Return Value

bool

at line 198
string getHtmlCode()

Get component html code

Return Value

string

at line 205
string url()

Get url

Return Value

string

at line 212
string|null getTemplateFile()

Get template file

Return Value

string|null

at line 220
void setHtmlCode(string $code)

Set html code

Parameters

string $code

Return Value

void

at line 228
void setError(string $code)

Set error

Parameters

string $code

Return Value

void

at line 235
void clearContent()

Clear content

Return Value

void

at line 242
string getTemplateUrl()

Get template url

Return Value

string

at line 249
string|null getFullName()

Get component full name

Return Value

string|null

at line 256
string|null getTemplateName()

Get template or extension name

Return Value

string|null

at line 263
string getBasePath()

Return base path

Return Value

string