Stud.IP  4.0
 All Data Structures Namespaces Files Functions Variables Groups
Course_StudygroupController Class Reference
Inheritance diagram for Course_StudygroupController:
AuthenticatedController StudipController

Public Member Functions

 before_filter (&$action, &$args)
 
 details_action ($id=null)
 
 create_action ()
 
 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 ()
 
- 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)
 
 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')
 

Additional Inherited Members

- 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
 

Detailed Description

This controller realises the basal functionalities of a studygroup.

GPL2 or any later version

Member Function Documentation

before_filter ( $action,
$args 
)
create_action ( )

creates a new studygroup with respect to given form data

Triggers a StudygroupDidCreate notification using the ID of the new studygroup as subject.

Returns
void
deactivate_action ( )

globally deactivates the studygroups

Returns
void
delete_action (   $approveDelete = false)

deletes a studygroup

Parameters
stringid of a studypgroup
booleanapproveDelete
stringstudipticket
Returns
void
details_action (   $id = null)

shows details of a studygroup

Parameters
stringid of a studygroup
Returns
void
edit_action ( )

displays a form for editing studygroups with corresponding data

Parameters
stringid of a studygroup
Returns
void
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 ( )

invites members to a studygroup.

globalmodules_action ( )

Displays admin settings concerning the studygroups

Returns
void
members_action ( )

displays a paginated member overview of a studygroup

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

sends a message to all members of a studygroup

Parameters
stringid of a studygroup
Returns
void
savemodules_action ( )

sets the global module and plugin settings for studygroups

Returns
void
update_action ( )

updates studygroups with respect to the corresponding form data

Parameters
stringid of a studygroup
Returns
void

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