Stud.IP  6.0
Course_StudygroupController Class Reference
Inheritance diagram for Course_StudygroupController:
AuthenticatedController StudipController Controller

Public Member Functions

 before_filter (&$action, &$args)
 
 details_action ($id=null)
 
 edit_action ()
 
 update_action ()
 
 members_action ()
 
 edit_members_action ($action, $from_status='')
 
 execute_invite_action ()
 
 delete_action ($approveDelete=false)
 
 globalmodules_action ()
 
 savemodules_action ()
 
 deactivate_action ()
 
 message_action ()
 
 avatar_action ()
 
 widget_action ($range_id)
 
- Public Member Functions inherited from AuthenticatedController
 before_filter (&$action, &$args)
 
- Public Member Functions inherited from StudipController
 __construct (\Trails\Dispatcher $dispatcher)
 
 before_filter (&$action, &$args)
 
 injectResponse (Psr\Http\Message\ResponseInterface $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 (string $file, ?string $filename=null, ?string $content_type=null, string $content_disposition='attachment', ?Closure $callback=null)
 
 render_temporary_file (string $file, ?string $filename=null, ?string $content_type=null, string $content_disposition='attachment', ?Closure $callback=null)
 
 render_form (\Studip\Forms\Form $form)
 
 render_vue_app (\Studip\VueApp $app)
 
 relay ($to_uri)
 
 relayWithRedirect (... $args)
 
 perform_relayed ($unconsumed)
 
 render_template ($template_name, $layout=null)
 
 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)
 
- Public Member Functions inherited from Controller
 __construct (Dispatcher $dispatcher)
 
 erase_response ()
 
 get_response ()
 
 perform ($unconsumed)
 
 extract_action_and_args ($string)
 
 default_action_and_args ()
 
 map_action ($action)
 
 before_filter (&$action, &$args)
 
 after_filter ($action, $args)
 
 does_not_understand ($action, $args)
 
 redirect ($to)
 
 render_text ($text=' ')
 
 render_nothing ()
 
 render_action ($action)
 
 get_default_template ($action)
 
 render_template ($template_name, $layout=null)
 
 get_template_factory ()
 
 get_assigned_variables ()
 
 set_layout ($layout)
 
 url_for ($to)
 
 set_status ($status, $reason_phrase=null)
 
 set_content_type ($type)
 
 rescue ($exception)
 
 respond_to ($ext)
 

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
 
- Protected Attributes inherited from Controller
Dispatcher $dispatcher
 
Response $response
 
bool $performed = false
 
Template string null $layout = null
 

Detailed Description

This controller realises the basal functionalities of a studygroup.

GPL2 or any later version

Member Function Documentation

◆ avatar_action()

avatar_action ( )

◆ before_filter()

before_filter ( $action,
$args 
)

◆ deactivate_action()

deactivate_action ( )

globally deactivates the studygroups

Returns
void

◆ delete_action()

delete_action (   $approveDelete = false)

deletes a studygroup

Parameters
stringid of a studypgroup
booleanapproveDelete
stringstudipticket
Returns
void

◆ details_action()

details_action (   $id = null)

shows details of a studygroup

Parameters
string$idof a studygroup
Returns
void

◆ edit_action()

edit_action ( )

displays a form for editing studygroups with corresponding data

Parameters
stringid of a studygroup
Returns
void

◆ edit_members_action()

edit_members_action (   $action,
  $from_status = '' 
)

offers specific member functions wrt perms

Parameters
string$actionthat has to be performed
string$from_statusif applicable (e.g. tutor)

◆ execute_invite_action()

execute_invite_action ( )

invites members to a studygroup.

◆ globalmodules_action()

globalmodules_action ( )

Displays admin settings concerning the studygroups

Returns
void

◆ members_action()

members_action ( )

displays a paginated member overview of a studygroup

Parameters
stringid of a studypgroup
stringpage number the current page
Returns
void

◆ message_action()

message_action ( )

sends a message to all members of a studygroup

Parameters
stringid of a studygroup
Returns
void

◆ savemodules_action()

savemodules_action ( )

sets the global module and plugin settings for studygroups

Returns
void

◆ update_action()

update_action ( )

updates studygroups with respect to the corresponding form data

Parameters
stringid of a studygroup
Returns
void

◆ widget_action()

widget_action (   $range_id)

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