\app_core_component_overlay

__construct()

__construct(string|\Fuman_Response_Data  $linkComponent, string|\Fuman_Response_Data  $contentComponent, null|string  $name = null) : \Fuman_Response_Data

Constructor. Creates the correct overlay html structure.

the name of the element has to be unique in the whole layout.

Parameters

Returns

setAttribute()

setAttribute(string  $key, string  $value, boolean  $appendValue = true, string  $appendSpacer = ' ') : void

Sets an attribute. If $appendValue is true, the value is going to be appended with the $appendSpacer argument.

Parameters

setAttributes()

setAttributes(array  $attributes, boolean  $appendValue = true, string  $appendSpacer = ' ') 

Sets an array of attributes. If $appendValue is true, the value is going to be appended with the $appendSpacer argument.

Parameters

setDataAttribute()

setDataAttribute(string  $key, string  $value) : void

Sets a data attribute. Data attributes will always be overwritten.

Parameters

hasAttribute()

hasAttribute(string  $key) : boolean

Returns true if attribute is set.

Parameters

Returns

hasDataAttribute()

hasDataAttribute(string  $key) : boolean

Returns true if data attribute is set.

Parameters

Returns

getAttribute()

getAttribute(string  $key) : string|object

Returns attribute.

Parameters

Returns

getAttributeValue()

getAttributeValue(  $key) : string|null

Returns attribute value

Parameters

Returns

getDataAttribute()

getDataAttribute(string  $key) : string

Returns data attribute.

Parameters

Returns

removeAttribute()

removeAttribute(string  $key) : void

Removes an attribute.

Parameters

removeDataAttribute()

removeDataAttribute(string  $key) : void

Removes a data attribute.

Parameters

createAttribute()

createAttribute(string  $key, string  $value) : \stdClass

Returns an attribute object.

Parameters

Returns

prepareAttribute()

prepareAttribute(string  $value) : string

Prepares an attribute (strips double quotes)

Parameters

Returns

setFrontend()

setFrontend(boolean  $flag) 

Sets frontend flag for object If already set, method call will be ignored

Parameters

isFrontend()

isFrontend() : boolean

Is object for a frontend request

Returns

addCssFile()

addCssFile(string  $path, string  $media = 'all', string|null  $packageName = null) : \Fuman_Response_Data

Add a CSS file

Parameters

Returns

addCssFiles()

addCssFiles(array  $cssFiles) : void

Adds an array of cssFiles the files will be internally added to the root response data object

Parameters

getCssFiles()

getCssFiles() : array

Returns all CSS files

Returns

hasCssFiles()

hasCssFiles() : boolean

Returns true when more than 0 css files are set

Returns

addJsFile()

addJsFile(string  $path, integer  $javaScriptLoadType, string|null  $packageName = null) : \Fuman_Response_Data

Add a Js file

Parameters

Returns

addJsFiles()

addJsFiles(array  $jsFiles, boolean  $toTop = false) : void

Adds an array of jsFiles the files will be internally added to the root response data object

Parameters

setJsFiles()

setJsFiles(array  $jsFiles) 

Set js files

Parameters

getJsFiles()

getJsFiles() : array

Returns all js files

Returns

hasJsFiles()

hasJsFiles() : boolean

Does the object contains js files

Returns

addJsClass()

addJsClass(string  $jsClassName, null|\stdClass  $options = null) : void

Adds an array of jsFiles the files will be internally added to the root response data object

Parameters

addJsClasses()

addJsClasses(array  $jsClasses) : void

Adds js classes

Parameters

hasJSClasses()

hasJSClasses() : boolean

Has javascript class

Returns

getJsClasses()

getJsClasses() : array

Get javascript classes

Returns

setJsClasses()

setJsClasses(array  $jsClasses) 

Set javascript classes

Parameters

addJsProperty()

addJsProperty(string  $key, \stdClass|string  $value) : void

Adds JS properties the properties will be internally added to the root response data object

Parameters

getJsProperties()

getJsProperties() : array

Returns all js properties

Returns

hasJsProperties()

hasJsProperties() : boolean

Does the object contains js properties

Returns

addLockId()

addLockId(integer  $lockId) : void

Add lock id

Parameters

hasLockIds()

hasLockIds() : boolean

Has lock ids

Returns

getLockIds()

getLockIds() : \array[int]

Get lock ids

Returns

getTemplatePath()

getTemplatePath() : string

Gets the script path

Returns

hasTemplatePath()

hasTemplatePath() : boolean

Has script path

Returns

setTemplatePath()

setTemplatePath(string  $templatePath) : \Fuman_Response_Data

Sets script path

Parameters

Returns

getData()

getData() : null|\stdClass

Gets data object

Returns

setData()

setData(\stdClass  $data) : void

Sets data object

Parameters

hasData()

hasData() : boolean

Has data object

Returns

getValue()

getValue(string  $key) : object|string

Gets value

Parameters

Returns

hasValue()

hasValue(string  $key) : boolean

Has value

Parameters

Returns

setValue()

setValue(string  $key, mixed|object  $value) : void

Sets value

Parameters

__set()

__set(string  $key, object  $value) : void

Sets value on data

Parameters

__get()

__get(string  $key) : null

Gets value from data

Parameters

Returns

__isset()

__isset(string  $key) : boolean

Is set key on data

Parameters

Returns

toObject()

toObject() : \stdClass

Creates stdClass/object ot data object

Returns

addToToolbar()

addToToolbar() 

Adds this to toolbar

open()

open() : void

Sets the status of overlay to open.

_getTemplatePath()

_getTemplatePath() : string

Returns path to template.

Returns

_compareCssFiles()

_compareCssFiles(\stdClass  $a, \stdClass  $b) : integer

Compares css files

Parameters

Returns

_compareJsFiles()

_compareJsFiles(\stdClass  $a, \stdClass  $b) : integer

Compares JS files

Parameters

Returns