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

FootNote

class FootNote

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

Properties

private Step $step
private int $id
private bool $displayable
private RichText|null $text

Methods

void
__construct(Step $step, int $id)

Constructor of class FootNote

Step
getStep()

Returns the Step object to which this footnote is attached

int
getId()

Returns the id of this footnote

void
setId(int $id)

Sets the id of this footnote

bool
isDisplayable()

Returns the displayable attribute of this footnote

bool
getDisplayable()

Returns the displayable attribute of this footnote

void
setDisplayable(bool $displayable)

Determines whether this footnote can be displayed or not

RichText|null
getText()

Returns the text of this footnote

void
setText(RichText $text)

Sets the text of this footnote

Details

at line 80
void __construct(Step $step, int $id)

Constructor of class FootNote

Parameters

Step $step The Step object to which this footnote is attached
int $id The id of this footnote

Return Value

void

at line 92
Step getStep()

Returns the Step object to which this footnote is attached

Return Value

Step The Step object

at line 103
int getId()

Returns the id of this footnote

Return Value

int The id of this footnote

at line 115
void setId(int $id)

Sets the id of this footnote

Parameters

int $id The id of this footnote

Return Value

void

at line 126
bool isDisplayable()

Returns the displayable attribute of this footnote

Return Value

bool true if this footnote can be displayed, false otherwise

at line 137
bool getDisplayable()

Returns the displayable attribute of this footnote

Return Value

bool true if this footnote can be displayed, false otherwise

at line 149
void setDisplayable(bool $displayable)

Determines whether this footnote can be displayed or not

Parameters

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

Return Value

void

at line 160
RichText|null getText()

Returns the text of this footnote

Return Value

RichText|null the The text of this footnote

at line 172
void setText(RichText $text)

Sets the text of this footnote

Parameters

RichText $text The text of this footnote

Return Value

void