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

Section

class Section

This class allows the storage and retrieval of the attributes of a section.

The section is a subdivision of a chapter. It is in the sections that the different texts of a block of information are inscribed. The text of a section can be annotated.

Properties

private Chapter $chapter
private int $id
private string $name
private string $label
private RichText|null $content
private RichText|null $annotations
private bool $displayable

Methods

void
__construct(Chapter $chapter, int $id)

Constructor of class Section

Chapter
getChapter()

Returns the Chapter object that contains this section.

int
getId()

Returns the ID of this section

void
setId(int $id)

Sets the ID of this section

string
getName()

Returns the name of this section

void
setName(string $name)

Sets the name of this section

string
getLabel()

Returns the label of this section

void
setLabel(string $label)

Sets the label of this section

RichText|null
getContent()

Returns the textual content of this section

void
setContent(RichText $content)

Sets the textual content of this section

RichText|null
getAnnotations()

Returns the annotations on the text of this section

void
setAnnotations(RichText $annotations)

Sets the annotations on the text of this section

bool
isDisplayable()

Returns the displayable attribute of this Section object

bool
getDisplayable()

Returns the displayable attribute of this Section object

void
setDisplayable(bool $displayable)

Determines whether this section can be displayed or not

Details

at line 106
void __construct(Chapter $chapter, int $id)

Constructor of class Section

Parameters

Chapter $chapter The Chapter object that contains this section.
int $id The Id of this section.

Return Value

void

at line 118
Chapter getChapter()

Returns the Chapter object that contains this section.

Return Value

Chapter The Chapter object

at line 129
int getId()

Returns the ID of this section

Return Value

int The ID of this section.

at line 141
void setId(int $id)

Sets the ID of this section

Parameters

int $id The ID of this section.

Return Value

void

at line 152
string getName()

Returns the name of this section

Return Value

string the The name of this section.

at line 164
void setName(string $name)

Sets the name of this section

Parameters

string $name The name of this section.

Return Value

void

at line 175
string getLabel()

Returns the label of this section

Return Value

string the The label of this section.

at line 187
void setLabel(string $label)

Sets the label of this section

Parameters

string $label The label of this section.

Return Value

void

at line 198
RichText|null getContent()

Returns the textual content of this section

Return Value

RichText|null The textual content of this section.

at line 210
void setContent(RichText $content)

Sets the textual content of this section

Parameters

RichText $content The textual content of this section.

Return Value

void

at line 221
RichText|null getAnnotations()

Returns the annotations on the text of this section

Return Value

RichText|null The annotations on the text of this section

at line 233
void setAnnotations(RichText $annotations)

Sets the annotations on the text of this section

Parameters

RichText $annotations The annotations on the text of this section

Return Value

void

at line 244
bool isDisplayable()

Returns the displayable attribute of this Section object

Return Value

bool true if this section can be displayed, false otherwise

at line 255
bool getDisplayable()

Returns the displayable attribute of this Section object

Return Value

bool true if this section can be displayed, false otherwise

at line 267
void setDisplayable(bool $displayable)

Determines whether this section can be displayed or not

Parameters

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

Return Value

void