Stud.IP  4.0
 All Data Structures Namespaces Files Functions Variables Groups
ForumModule Interface Reference
Inheritance diagram for ForumModule:
StandardPlugin StudipModule CoreForum

Public Member Functions

 getLinkToThread ($issue_id)
 
 setThreadForIssue ($issue_id, $title, $content)
 
 getNumberOfPostingsForIssue ($issue_id)
 
 getNumberOfPostingsForUser ($user_id)
 
 getNumberOfPostingsForSeminar ($seminar_id)
 
 getNumberOfPostings ()
 
 getEntryTableInfo ()
 
 getTopTenSeminars ()
 
 migrateUser ($user_from, $user_to)
 
 deleteContents ($seminar_id)
 
 getDump ($seminar_id)
 
- Public Member Functions inherited from StudipModule
 getIconNavigation ($course_id, $last_visit, $user_id)
 
 getTabNavigation ($course_id)
 
 getMetadata ()
 
 getInfoTemplate ($course_id)
 

Member Function Documentation

deleteContents (   $seminar_id)

Clean up everything for the passed seminar, because the seminar is beeing deleted.

Parameters
string$seminar_id

Implemented in CoreForum.

getDump (   $seminar_id)

Return a complete HTML-Dump of all entries in the forum-module. This is used for archiving purposes, so make it pretty!

Parameters
string$seminar_id
Returns
string a single-page HTML-view of all contents in one string

Implemented in CoreForum.

getEntryTableInfo ( )

This function is called whenever Stud.IP needs to directly operate on your entries-table. Your entries-table MUST have at least fields for a date (a change-date is preferred, but make-date will suffice), posting-content, seminar_id and user_id.

The returning array must have the following structure: Array ( 'table' => 'your_entry_table, 'content' => 'your_content_field', 'chdate' => 'your_date_field', 'seminar_id' => 'your_seminar_id_field', 'user_id' => 'your_user_id_field' )

Returns
array

Implemented in CoreForum.

getLinkToThread (   $issue_id)

Issues can be connected with an entry in a forum. This method has to return an url to the connected topic for the passed issue_id. If no topic is connected, it has to return "false"

Parameters
string$issue_id
Returns
mixed URL or false

Implemented in CoreForum.

getNumberOfPostings ( )

Return the number of all postings served by your module. The results are used for statistics.

Returns
int

Implemented in CoreForum.

getNumberOfPostingsForIssue (   $issue_id)

Return the number of postings the connected topic contains for the issue with the passed id

Parameters
type$issue_id
Returns
int

Implemented in CoreForum.

getNumberOfPostingsForSeminar (   $seminar_id)

Return the number of postings for the passed seminar

Parameters
type$seminar_id
Returns
int

Implemented in CoreForum.

getNumberOfPostingsForUser (   $user_id)

Return the number of postings for the passed user

Parameters
type$user_id
Returns
int
getTopTenSeminars ( )

The caller expects an array of the ten seminars with the most postings in your module.

Return an array of the following structure: Array ( Array ( 'seminar_id' => 'display' => 'count' => ) )

Returns
array

Implemented in CoreForum.

migrateUser (   $user_from,
  $user_to 
)

Is called when the data of a user is moved to another user. Update all user_ids with the passed new one.

Parameters
string$user_fromthe user_id of the user who has the data
string$user_tothe user_id of the user who shall receive the data

Implemented in CoreForum.

setThreadForIssue (   $issue_id,
  $title,
  $content 
)

This method is called in case of an creation OR an update of an issue. Normally one would update the title and the content of the linked topic when called

Parameters
string$issue_id
string$titlethe title of the issue
string$contentthe description of the issue

Implemented in CoreForum.


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