1. class
  2. EUREKA
  3. \
  4. G6KBundle
  5. \
  6. Entity
  7. \
  8. BlockInfo

BlockInfo

class BlockInfo

This class allows the storage and retrieval of the attributes of a block of information (blockinfo)

The blockinfo is an element of the simulation page of the same level as the field group but does not contain any input or output fields. It contains textual information that can be useful to the user in the simulation process. It can be contextualized by showing / hiding it totally or partially using the actions of business rules depending on certain conditions.

Properties

private Panel $panel
private int $id
private string $name
private string $label
private array $chapters
private bool $displayable

Methods

void
__construct(Panel $panel, int $id)

Constructor of class BlockInfo

Panel
getPanel()

Returns the Panel object that contains this BlockInfo object

int
getId()

Returns the ID of this BlockInfo object

void
setId(int $id)

Sets the ID of this BlockInfo object

string
getName()

Returns the name of this BlockInfo object

void
setName(string $name)

Sets the name of this BlockInfo object

string
getLabel()

Returns the label of this BlockInfo object

void
setLabel(string $label)

Sets the label of this BlockInfo object

array
getChapters()

Returns the list of chapters contained in this BlockInfo object

void
setChapters(array $chapters)

Sets the list of chapters contained in this BlockInfo object

void
addChapter(Chapter $chapter)

Adds a chapter to the list of chapters contained in this BlockInfo object

void
removeChapter(int $index)

Removes a chapter from the list of chapters contained in this BlockInfo object

Chapter|null
getChapterById(int $id)

Retrieves a chapter by its ID in the chapter list of this BlockInfo object

bool
isDisplayable()

Returns the displayable attribute of this BlockInfo object

bool
getDisplayable()

Returns the displayable attribute of this BlockInfo object

void
setDisplayable(bool $displayable)

Determines whether this BlockInfo can be displayed or not

string
getClass()

Returns the class name of this BlockInfo object

Details

at line 98
void __construct(Panel $panel, int $id)

Constructor of class BlockInfo

Parameters

Panel $panel Panel that contains this blockinfo
int $id Blockinfo id

Return Value

void

at line 110
Panel getPanel()

Returns the Panel object that contains this BlockInfo object

Return Value

Panel The container Panel of this BlockInfo object

at line 121
int getId()

Returns the ID of this BlockInfo object

Return Value

int the value of id

at line 133
void setId(int $id)

Sets the ID of this BlockInfo object

Parameters

int $id Blockinfo id

Return Value

void

at line 144
string getName()

Returns the name of this BlockInfo object

Return Value

string the value of name

at line 156
void setName(string $name)

Sets the name of this BlockInfo object

Parameters

string $name Blockinfo name without spaces or special or accented characters

Return Value

void

at line 167
string getLabel()

Returns the label of this BlockInfo object

Return Value

string the value of label

at line 179
void setLabel(string $label)

Sets the label of this BlockInfo object

Parameters

string $label Blockinfo label

Return Value

void

at line 190
array getChapters()

Returns the list of chapters contained in this BlockInfo object

Return Value

array the value of chapters

at line 202
void setChapters(array $chapters)

Sets the list of chapters contained in this BlockInfo object

Parameters

array $chapters Array of Chapter objects

Return Value

void

at line 214
void addChapter(Chapter $chapter)

Adds a chapter to the list of chapters contained in this BlockInfo object

Parameters

Chapter $chapter

Return Value

void

at line 226
void removeChapter(int $index)

Removes a chapter from the list of chapters contained in this BlockInfo object

Parameters

int $index Index of the chapter to remove

Return Value

void

at line 238
Chapter|null getChapterById(int $id)

Retrieves a chapter by its ID in the chapter list of this BlockInfo object

Parameters

int $id Chapter id

Return Value

Chapter|null The chapter with this ID

at line 254
bool isDisplayable()

Returns the displayable attribute of this BlockInfo object

Return Value

bool the value of displayable

at line 265
bool getDisplayable()

Returns the displayable attribute of this BlockInfo object

Return Value

bool the value of displayable

at line 277
void setDisplayable(bool $displayable)

Determines whether this BlockInfo can be displayed or not

Parameters

bool $displayable Blockinfo displayable or not

Return Value

void

at line 288
string getClass()

Returns the class name of this BlockInfo object

Return Value

string the class name