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

FieldRow

class FieldRow

This class allows the storage and retrieval of the attributes of a field row.

A field row contains fields that make up the cells in the row.

The field row is linked to a data group that contains the data associated to the cells of this field row

Properties

private FieldSet $fieldset
private int $id
private string $label
private bool $help
private bool $colon
private bool $emphasize
private string $datagroup
private array $fields

Methods

void
__construct(FieldSet $fieldset, int $id, string $label)

Constructor of class FieldRow

FieldSet
getFieldSet()

Returns the FieldSet object that contains this field row

int
getId()

Returns the ID of this field row

void
setId(int $id)

Sets the ID of this field row

string
getDataGroup()

Returns the ID of the data group that contains the data associated to the cells of this field row

void
setDataGroup(string $datagroup)

Sets the ID of the data group that contains the data associated to the cells of this field row

string
getLabel()

Returns the label of this field row

void
setLabel(string $label)

Sets the label of this field row

bool
hasColon()

Returns the colon attribute of this field row.

bool
getColon()

Returns the colon attribute of this field row.

void
setColon(bool $colon)

Determines whether a colon should be displayed after the label of this field row.

bool
hasHelp() deprecated

Returns the help attribute of this field.

bool
getHelp() deprecated

Returns the help attribute of this field.

void
setHelp(bool $help) deprecated

Determines whether the description of the data linked to this field should be displayed as help text

bool
isEmphasized()

Returns the emphasize attribute of this field row.

bool
getEmphasize()

Returns the emphasize attribute of this field row.

void
setEmphasize(bool $emphasize)

Determines whether the label of this field row should be emphasized or not.

array
getFields()

Returns the list of fields contained in this field row.

void
setFields(array $fields)

Sets the list of fields contained in this field row.

void
addField(Field $field)

Adds a Field object to the list of fields contained in this field row.

void
removeField(int $index)

Removes a Field object from the list of fields contained in this field row.

Field|null
getFieldByPosition(int $position)

Retrieves a Field object by its position in the list of fields of this field row.

string
getClass()

Returns the class name of this FieldRow object

Details

at line 116
void __construct(FieldSet $fieldset, int $id, string $label)

Constructor of class FieldRow

Parameters

FieldSet $fieldset The FieldSet object that contains this field row
int $id The ID of this field row
string $label The label of this field row

Return Value

void

at line 129
FieldSet getFieldSet()

Returns the FieldSet object that contains this field row

Return Value

FieldSet The FieldSet Object

at line 140
int getId()

Returns the ID of this field row

Return Value

int The ID of this field row

at line 152
void setId(int $id)

Sets the ID of this field row

Parameters

int $id The ID of this field row

Return Value

void

at line 163
string getDataGroup()

Returns the ID of the data group that contains the data associated to the cells of this field row

Return Value

string The ID of the data group

at line 175
void setDataGroup(string $datagroup)

Sets the ID of the data group that contains the data associated to the cells of this field row

Parameters

string $datagroup The ID of the data group

Return Value

void

at line 186
string getLabel()

Returns the label of this field row

Return Value

string The label of this field row

at line 198
void setLabel(string $label)

Sets the label of this field row

Parameters

string $label The label of this field row

Return Value

void

at line 209
bool hasColon()

Returns the colon attribute of this field row.

Return Value

bool true if a colon should be displayed after the label, false otherwise

at line 220
bool getColon()

Returns the colon attribute of this field row.

Return Value

bool true if a colon should be displayed after the label, false otherwise

at line 232
void setColon(bool $colon)

Determines whether a colon should be displayed after the label of this field row.

Parameters

bool $colon true if a colon should be displayed after the label, false otherwise

Return Value

void

at line 246
bool hasHelp() deprecated

deprecated

Returns the help attribute of this field.

If the value is true, the description of the data group is displayed in a foldable area below the field row, visible after the user clicks on an icon.

Return Value

bool $help true if the description of the data group will be displayed as help text, false otherwise

at line 260
bool getHelp() deprecated

deprecated

Returns the help attribute of this field.

If the value is true, the description of the data group is displayed in a foldable area below the field row, visible after the user clicks on an icon.

Return Value

bool true if the description of the data group will be displayed as help text, false otherwise

at line 275
void setHelp(bool $help) deprecated

deprecated

Determines whether the description of the data linked to this field should be displayed as help text

If the value is true, the description of the data group is displayed in a foldable area below the field row, visible after the user clicks on an icon.

Parameters

bool $help true if the description of the data group will be displayed as help text, false otherwise

Return Value

void

at line 286
bool isEmphasized()

Returns the emphasize attribute of this field row.

Return Value

bool true if the label of this field row is emphasized, false otherwise

at line 297
bool getEmphasize()

Returns the emphasize attribute of this field row.

Return Value

bool true if the label of this field row is emphasized, false otherwise

at line 309
void setEmphasize(bool $emphasize)

Determines whether the label of this field row should be emphasized or not.

Parameters

bool $emphasize true if the label of this field row should be emphasized, false otherwise

Return Value

void

at line 320
array getFields()

Returns the list of fields contained in this field row.

Return Value

array The list of fields contained in this field row.

at line 332
void setFields(array $fields)

Sets the list of fields contained in this field row.

Parameters

array $fields The list of fields contained in this field row.

Return Value

void

at line 344
void addField(Field $field)

Adds a Field object to the list of fields contained in this field row.

Parameters

Field $field The Field object

Return Value

void

at line 356
void removeField(int $index)

Removes a Field object from the list of fields contained in this field row.

Parameters

int $index The index of the field in the list of fields

Return Value

void

at line 368
Field|null getFieldByPosition(int $position)

Retrieves a Field object by its position in the list of fields of this field row.

Parameters

int $position The position of the field

Return Value

Field|null the Field object

at line 384
string getClass()

Returns the class name of this FieldRow object

Return Value

string The class name