legend
class legend implements groupposition_interface
Legend group position class
group_legend is an ascending list 1, 2, ..., n for groups which are displayed. 1 is the first group, n the last. If the value is 0 (self::GROUP_DISABLED) the group is not displayed.
Constants
GROUP_DISABLED |
Group is not displayed |
Properties
protected driver_interface | $db | Database object |
|
protected user | $user | User object |
Methods
Returns the group_legend for a given group, if the group exists.
Get number of groups, displayed on the legend
Addes a group by group_id
Deletes a group by setting the field to self::GROUP_DISABLED and closing the gap in the list.
Moves a group up by group_id
Moves a group down by group_id
Moves a group up/down
Get group type language var
Details
at line 47
__construct(driver_interface $db, user $user)
Constructor
at line 60
int
get_group_value(int $group_id)
Returns the group_legend for a given group, if the group exists.
at line 83
int
get_group_count()
Get number of groups, displayed on the legend
at line 98
bool
add_group(int $group_id)
Addes a group by group_id
at line 125
bool
delete_group(int $group_id, bool $skip_group = false)
Deletes a group by setting the field to self::GROUP_DISABLED and closing the gap in the list.
at line 157
bool
move_up(int $group_id)
Moves a group up by group_id
at line 165
bool
move_down(int $group_id)
Moves a group down by group_id
at line 173
bool
move(int $group_id, int $delta)
Moves a group up/down
at line 227
static string
group_type_language(int $group_type)
Get group type language var