1. class
  2. App
  3. \
  4. G6K
  5. \
  6. Model
  7. \
  8. FootNotes

FootNotes

class FootNotes

This class allows the storage and retrieval of the attributes of a footnote container attached to a step.

Properties

private Step $step
private string $position
private array $footnotes
private bool $displayable

Methods

void
__construct(Step $step)

Constructor of class FootNotes

Step
getStep()

Returns the Step object to which this footnote container is attached.

string
getPosition()

Returns the position of this footnote container relative to the action buttons.

void
setPosition(string $position)

Sets the position of this footnote container relative to the action buttons.

array
getFootNotes()

Returns the list of footnotes contained in this container

void
setFootNotes(array $footnotes)

Sets the list of footnotes contained in this container

void
addFootNote(FootNote $footnote)

Adds a FootNote Object to the list of footnotes contained in this container

FootNote|null
getFootNoteById(int $id)

Retrieves a FootNote object by its ID in the list of footnotes contained in this container

void
removeFootNote(int $index)

Removes a FootNote Object from the list of footnotes contained in this container

bool
isDisplayable()

Returns the displayable attribute of this footnote container

bool
getDisplayable()

Returns the displayable attribute of this footnote container

void
setDisplayable(bool $displayable)

Determines whether this footnote container can be displayed or not

Details

at line 79
void __construct(Step $step)

Constructor of class FootNotes

Parameters

Step $step The Step object to which this footnote container is attached

Return Value

void

at line 90
Step getStep()

Returns the Step object to which this footnote container is attached.

Return Value

Step The Step object

at line 106
string getPosition()

Returns the position of this footnote container relative to the action buttons.

Possible values are :

  • beforeActions: the footnote container is placed before the action buttons
  • afterActions: the footnote container is placed after the action buttons

Return Value

string the The position of this footnote container.

at line 123
void setPosition(string $position)

Sets the position of this footnote container relative to the action buttons.

Possible values are :

  • beforeActions: the footnote container is placed before the action buttons
  • afterActions: the footnote container is placed after the action buttons

Parameters

string $position The position of this footnote container.

Return Value

void

at line 134
array getFootNotes()

Returns the list of footnotes contained in this container

Return Value

array The list of footnotes

at line 146
void setFootNotes(array $footnotes)

Sets the list of footnotes contained in this container

Parameters

array $footnotes The list of footnotes

Return Value

void

at line 158
void addFootNote(FootNote $footnote)

Adds a FootNote Object to the list of footnotes contained in this container

Parameters

FootNote $footnote The FootNote Object

Return Value

void

at line 170
FootNote|null getFootNoteById(int $id)

Retrieves a FootNote object by its ID in the list of footnotes contained in this container

Parameters

int $id The ID of the footnote

Return Value

FootNote|null The FootNote object

at line 187
void removeFootNote(int $index)

Removes a FootNote Object from the list of footnotes contained in this container

Parameters

int $index The index of the FootNote Object in the list of data item

Return Value

void

at line 198
bool isDisplayable()

Returns the displayable attribute of this footnote container

Return Value

bool true if this footnote container can be displayed, false otherwise

at line 209
bool getDisplayable()

Returns the displayable attribute of this footnote container

Return Value

bool true if this footnote container can be displayed, false otherwise

at line 221
void setDisplayable(bool $displayable)

Determines whether this footnote container can be displayed or not

Parameters

bool $displayable true if this footnote container can be displayed, false otherwise

Return Value

void