Stud.IP  5.4
Course_StatusgroupsController Class Reference
Inheritance diagram for Course_StatusgroupsController:
AuthenticatedController StudipController

Public Member Functions

 before_filter (&$action, &$args)
 
 index_action ()
 
 export_action ()
 
 getgroup_action ($group_id)
 
 groupinfo_action ($group_id)
 
 joinables_action ()
 
 add_member_action ($group_id)
 
 edit_action ($group_id='')
 
 save_action ($group_id='')
 
 delete_action ($group_id)
 
 delete_member_action ($user_id, $group_id)
 
 move_member_action ($user_id, $group_id)
 
 create_groups_action ()
 
 join_action ($group_id='')
 
 leave_action ($group_id)
 
 batch_create_action ()
 
 batch_action_action ()
 
 batch_delete_groups_action ()
 
 batch_save_groups_size_action ()
 
 batch_save_groups_selfassign_action ()
 
 batch_move_members_action ()
 
 batch_copy_members_action ()
 
 batch_delete_members_action ($group_id)
 
 batch_cancel_members_action ()
 
 order_action ()
 
- Public Member Functions inherited from AuthenticatedController
 before_filter (&$action, &$args)
 
- Public Member Functions inherited from StudipController
 before_filter (&$action, &$args)
 
 erase_response ()
 
 perform ($unconsumed_path)
 
 after_filter ($action, $args)
 
 validate_args (&$args, $types=null)
 
 url_for ($to='')
 
 link_for ($to='')
 
 redirect ($to)
 
 relocate ($to)
 
 rescue ($exception)
 
 render_json ($data)
 
 render_csv ($data, $filename=null, $delimiter=';', $enclosure='"')
 
 render_file ( $file, $filename=null, $content_type=null, $content_disposition='attachment', Closure $callback=null, $chunk_size=262144)
 
 render_temporary_file ( $file, $filename=null, $content_type=null, $content_disposition='attachment', Closure $callback=null, $chunk_size=262144)
 
 render_form (\Studip\Forms\Form $form)
 
 relay ($to_uri)
 
 relayWithRedirect (... $args)
 
 perform_relayed ($unconsumed)
 
 render_template_as_string ($template, $layout=null)
 
 __call ($method, $arguments)
 
 has_action ($action)
 
 action_url ($action)
 
 action_link ($action)
 
 validate_datetime ($datetime, $format='H:i')
 
 render_spreadsheet (array $header, array $data, string $format, string $filename, ?string $filepath=null)
 

Additional Inherited Members

- Protected Member Functions inherited from AuthenticatedController
 keepRequest ()
 
- Protected Member Functions inherited from StudipController
 render_pdf (TCPDF $pdf, $filename, $inline=false)
 
 controller_path ()
 
 getBodyElementIdForControllerAndAction ($unconsumed_path)
 
- Protected Attributes inherited from AuthenticatedController
 $with_session = true
 
 $allow_nobody = false
 
- Protected Attributes inherited from StudipController
 $with_session = false
 
 $allow_nobody = true
 
 $_autobind = false
 

Member Function Documentation

◆ add_member_action()

add_member_action (   $group_id)

Adds selected persons to given group. user_ids to add come from a MultiPersonSearch object which was triggered in group actions.

Parameters
String$group_id

◆ batch_action_action()

batch_action_action ( )

Batch action for several groups or group members at once.

Exceptions
AccessDeniedExceptionif access not allowed with current permission level.

◆ batch_cancel_members_action()

batch_cancel_members_action ( )

Removes selected group members from the course (cancels their admission).

Exceptions
AccessDeniedExceptionif access not allowed with current permission level.

◆ batch_copy_members_action()

batch_copy_members_action ( )

Copies selected group members to another group.

Exceptions
AccessDeniedExceptionif access not allowed with current permission level.

◆ batch_create_action()

batch_create_action ( )

Batch creation of statusgroups according to given settings.

Exceptions
AccessDeniedExceptionif access not allowed with current permission level.

◆ batch_delete_groups_action()

batch_delete_groups_action ( )

Deletes several groups at once.

Exceptions
AccessDeniedExceptionif access not allowed with current permission level.

◆ batch_delete_members_action()

batch_delete_members_action (   $group_id)

Removes selected group members from given group.

Parameters
String$group_idgroup to remove members from.
Exceptions
AccessDeniedExceptionif access not allowed with current permission level.

◆ batch_move_members_action()

batch_move_members_action ( )

Moves selected group members to another group.

Exceptions
AccessDeniedExceptionif access not allowed with current permission level.

◆ batch_save_groups_selfassign_action()

batch_save_groups_selfassign_action ( )

Sets data for several groups at once.

Exceptions
AccessDeniedExceptionif access not allowed with current permission level.

◆ batch_save_groups_size_action()

batch_save_groups_size_action ( )

Sets data for several groups at once.

Exceptions
AccessDeniedExceptionif access not allowed with current permission level.

◆ before_filter()

before_filter ( $action,
$args 
)

◆ create_groups_action()

create_groups_action ( )

Provides the possibility to batch create several groups at once.

Exceptions
AccessDeniedExceptionif access not allowed with current permission level.

◆ delete_action()

delete_action (   $group_id)

Deletes the given statusgroup.

Parameters
String$group_idID of the group to delete
Exceptions
AccessDeniedExceptionif access not allowed with current permission level.

◆ delete_member_action()

delete_member_action (   $user_id,
  $group_id 
)

Removes the given user from the given statusgroup.

Parameters
String$user_iduser to remove
String$group_idaffected group

◆ edit_action()

edit_action (   $group_id = '')

Allows editing of a given statusgroup or creating a new one.

Parameters
String$group_idID of the group to edit
Exceptions
AccessDeniedExceptionif access not allowed with current permission level.

◆ export_action()

export_action ( )

◆ getgroup_action()

getgroup_action (   $group_id)

Fetches the members of the given group.

Parameters
String$group_idthe statusgroup to get members for.

◆ groupinfo_action()

groupinfo_action (   $group_id)

Provides extended info about a status group, like maximum number of participants, selfassign, exclusive entry, selfassign start and end times.

Parameters
String$group_idThe group to show info for.

◆ index_action()

index_action ( )

Lists all available statusgroups.

◆ join_action()

join_action (   $group_id = '')

Adds the current user to the given group.

Exceptions
AccessDeniedExceptionif current user may not join the given group.

◆ joinables_action()

joinables_action ( )

Shows a list of all groups that can be joined by current user and allows the user to select one.

◆ leave_action()

leave_action (   $group_id)

Removes the current user from the given group.

Exceptions
AccessDeniedExceptionif current user may not join the given group.

◆ move_member_action()

move_member_action (   $user_id,
  $group_id 
)

◆ order_action()

order_action ( )

◆ save_action()

save_action (   $group_id = '')

Saves changes to given statusgroup or creates a new entry.

Parameters
String$group_idID of the group to edit
Exceptions
AccessDeniedExceptionif access not allowed with current permission level.

The documentation for this class was generated from the following file: