class FieldNote

This class allows the storage and retrieval of the attributes of a note attached to a field.

Properties

private Field $field
private bool $displayable
private RichText $text

Methods

void
__construct(Field $field)

Constructor of class FieldNote

getField()

Returns the Field object to which this note is attached

bool
isDisplayable()

Returns the displayable attribute of this note

bool
getDisplayable()

Returns the displayable attribute of this note

void
setDisplayable(bool $displayable)

Determines whether this note can be displayed or not

getText()

Returns the text of this note

void
setText(RichText $text)

Sets the text of this note

Details

at line 70
void __construct(Field $field)

Constructor of class FieldNote

Parameters

Field $field The Field object to which this note is attached

Return Value

void

at line 81
Field getField()

Returns the Field object to which this note is attached

Return Value

Field The Field object

at line 92
bool isDisplayable()

Returns the displayable attribute of this note

Return Value

bool true if this note can be displayed, false otherwise

at line 103
bool getDisplayable()

Returns the displayable attribute of this note

Return Value

bool true if this note can be displayed, false otherwise

at line 115
void setDisplayable(bool $displayable)

Determines whether this note can be displayed or not

Parameters

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

Return Value

void

at line 126
RichText getText()

Returns the text of this note

Return Value

RichText The text of this note

at line 138
void setText(RichText $text)

Sets the text of this note

Parameters

RichText $text The text of this note

Return Value

void