\FML\ElementsFrameModel

Class representing a Frame Model

Summary

Methods
Properties
Constants
create()
__construct()
getId()
setId()
checkId()
getChildren()
addChild()
add()
addChildren()
removeAllChildren()
removeChildren()
getFormat()
setFormat()
render()
No public properties found
No constants found
createId()
$modelId
$children
$format
N/A
No private methods found
No private properties found
N/A

Properties

$modelId

$modelId : string

Type

string — Model id

$children

$children : array<mixed,\FML\Types\Renderable>

Type

array<mixed,\FML\Types\Renderable> — Children

Methods

create()

create(string  $modelId = null, array<mixed,\FML\Types\Renderable>  $children = null) : static

Create a new Frame Model

Parameters

string $modelId

Model id

array<mixed,\FML\Types\Renderable> $children

Children

Returns

static

__construct()

__construct(string  $modelId = null, array<mixed,\FML\Types\Renderable>  $children = null) 

Construct a new Frame Model

Parameters

string $modelId

Model id

array<mixed,\FML\Types\Renderable> $children

Children

getId()

getId() : string

Get the Id

Returns

string

setId()

setId(  $modelId) : static

Set the Id

Parameters

$modelId

Returns

static

checkId()

checkId() : string

Check and return the Id

Returns

string

getChildren()

getChildren() : array<mixed,\FML\Types\Renderable>

Get the children

Returns

array<mixed,\FML\Types\Renderable>

addChild()

addChild(\FML\Types\Renderable  $child) : static

Add a new child

Parameters

\FML\Types\Renderable $child

Child Control to add

Returns

static

add()

add(\FML\Types\Renderable  $child) : static

Add a new child

Parameters

\FML\Types\Renderable $child

Child Control to add

Returns

static

addChildren()

addChildren(array  $children) : static

Add new children

Parameters

array $children

Child Controls to add

Returns

static

removeAllChildren()

removeAllChildren() : static

Remove all children

Returns

static

removeChildren()

removeChildren() : static

Remove all children

Returns

static

getFormat()

getFormat(boolean  $createIfEmpty = true) : \FML\Elements\Format

Get the Format

Parameters

boolean $createIfEmpty

If the format should be created if it doesn't exist yet

Returns

\FML\Elements\Format

setFormat()

setFormat(\FML\Elements\Format  $format = null) : static

Set the Format

Parameters

\FML\Elements\Format $format

New Format

Returns

static

render()

render(\DOMDocument  $domDocument) : \DOMElement

Render the XML element

Parameters

\DOMDocument $domDocument

DOMDocument for which the XML element should be rendered

Returns

\DOMElement

createId()

createId() : string

Create a new model id

Returns

string