Arikaim CMS

ArikaimComponent extends BaseComponent

in package

• View

implements HtmlComponentInterface, RequireAccessInterface Uses Options, ComponentEditor, Properties, Data, IncludeOption

Arikaim html component

Table of Contents

Interfaces

HtmlComponentInterface

Extension interface

RequireAccessInterface

Require access interface

Constants

NAME_SEPARATORS  = ['::' => \Arikaim\Core\Interfaces\View\ComponentInterface::EXTENSION_COMPONENT, '>' => \Arikaim\Core\Interfaces\View\ComponentInterface::PRIMARY_TEMLATE, ':' => \Arikaim\Core\Interfaces\View\ComponentInterface::TEMPLATE_COMPONENT, '~' => \Arikaim\Core\Interfaces\View\ComponentInterface::COMPONENTS_LIBRARY]

Properties

$id  : string|null

Component Id

$basePath  : string

Base path

$componentType  : string

Component type

$context  : array<string|int, mixed>

Component context used in render

$data  : array<string|int, mixed>

Component data file content

$dataFile  : string|null

Component data file

$editorOptions  : array<string|int, mixed>

Editor options

$editorOptionsFile  : string

Optins file

$error  : string|null

Component error code

$extensionsPath  : string

Extensions path

$filePath  : string

File path

$files  : array<string|int, mixed>

Component files

$fullName  : string

Component full name

$fullPath  : string

Component full path

$hasHtmlContent  : mixed

Return true if compoent has html file

$htmlCode  : string

Html code

$htmlFileName  : string|null

Html file name

$includedComponents  : array<string|int, mixed>

Included compoents

$language  : string

Language code

$location  : int

Component Location

$name  : string

Component name

$options  : array<string|int, mixed>

Options

$optionsFile  : string

Optins file

$parent  : array<string|int, mixed>

Parent component info

$path  : string

Component path

$primaryTemplate  : string

Primary template name

$properties  : array<string|int, mixed>

Properies

$removeIncludeOptions  : bool

Remove include options

$renderMode  : int

Render mode

$styles  : array<string|int, mixed>

Component styles file content

$templateName  : string

Template, extension or components library name

$templatePath  : string|null

Template path

$templateUrl  : string

Template url

$url  : string

Component url

$viewPath  : string

View path

Methods

__construct()  : mixed

Constructor

addComponentFile()  : mixed

Add component file

addFile()  : void

Add file

addIncludedComponent()  : void

Add included component

clearContent()  : void

Clear content

create()  : ComponentInterface

Create component

getBasePath()  : string

Return base path

getComponentFile()  : string|false

Get component file

getComponentFullPath()  : string

Get component full path

getComponentType()  : string

Get component type

getContext()  : array<string|int, mixed>

Get context

getDataFile()  : string|null

Get component data file.

getEditorOption()  : mixed

Get editor option

getError()  : string|null

Get error

getFiles()  : array<string|int, mixed>

Return files

getFileUrl()  : string

Convert file path to url

getFullName()  : string

Get component full name

getFullPath()  : string

Get full path

getHtmlCode()  : string

Get html code

getIncludedComponents()  : array<string|int, mixed>

Get included components

getIncludeFile()  : string|null

Get include file url

getLanguage()  : string

Get language

getLocation()  : int

Get location

getName()  : string

Get component name

getOption()  : mixed

Get option

getOptions()  : array<string|int, mixed>

Get options

getPath()  : string

Get path

getPrimaryTemplate()  : string

Get primary template

getProperties()  : array<string|int, mixed>

Get properties

getPropertiesFileName()  : string|null

Get properties file name

getRenderMode()  : int

Undocumented function

getRootPath()  : string

Get root componetn path

getTemplateFile()  : string

Get template file

getTemplateName()  : string

Get template or extension name

getTemplatePath()  : string

Get template path

getTemplateUrl()  : string

Get template url

hasContent()  : bool

Return true if component have html content

hasError()  : bool

Return true if have error

hasFiles()  : bool

Return true if component have files

hasParent()  : bool

Return true if component has child

hasProperties()  : bool

Return true if component have properties

init()  : void

Init component

isIncludedComponent()  : mixed

isValid()  : bool

Return true if component is valid

loadEditorOptions()  : void

Load editor options json file

loadOptions()  : void

Load options json file

loadProperties()  : void

Load properties json file

mergeContext()  : void

Merge context

mergeData()  : void

Add data to context array

mergeEditorOptions()  : void

Add editor options to context array

mergeProperties()  : void

Add properties to context array

mergeRecursiveContext()  : void

Merge recursive context

mergeStyles()  : void

Add styles to context array

resolve()  : bool

Render component data

setComponentType()  : void

Set component type

setContext()  : void

Set context

setEditorOption()  : void

Set editor option value

setError()  : void

Set error

setHtmlCode()  : void

Set html code

setOption()  : void

Set option value

setOptionFile()  : void

Set option file name

setParent()  : void

Set parent component info

setPrimaryTemplate()  : void

Set primary template name

setPropertiesFileName()  : void

Set properties file name

setRenderMode()  : void

Set render mode

toArray()  : array<string|int, mixed>

Convert to array

url()  : string

Get url

componentTypeOption()  : void

Component type option

getEditorOptionsFileName()  : string|null

Get editor options file name

getOptionsFileName()  : string|null

Get options file name

loadJsonFile()  : bool

Load styles json file

parseName()  : void

Parse component name

processDataFile()  : bool

Process daat file

processDataOption()  : void

Process component include data file option

processIncludeOption()  : void

Process component include js files option

processStylesOption()  : void

Process component include styles option

resolveDataFile()  : void

Resolve component data file

resolveEditorOptionsFileName()  : void

Resolve editor options file name

resolveHtmlContent()  : void

Resolev html content

resolveIncludeFile()  : array<string|int, mixed>

Resolve include file

resolveOptionsFileName()  : void

Resolve options file name

resolvePath()  : void

Resolve component path

setEditorOptionsFileName()  : void

Set editor options file name

setOptionsFileName()  : void

Set options file name

resolvePropertiesFileName()  : void

Resolve properties file name