Docs For Class Module_admin_ocf

Description

Module page class.

Located in /adminzone/pages/modules/admin_ocf_join.php (line 24)

Method Summary

tempcode delurk ()

void download_csv ()

array find_lurkers (integer $max_posts, integer $max_points, integer $max_logged_actions, integer $min_days_since_login, integer $min_days_since_join, array $usergroups)

?array get_entry_points ()

tempcode import_csv ()

?array info ()

tempcode menu ()

tempcode run ()

tempcode step1 ()

tempcode step2 ()

tempcode _delurk ()

array _get_csv_headings ()

tempcode _import_csv ()

tempcode __delurk ()

Methods

delurk (line 241)

The UI for choosing delurk criteria.

return: The UI

tempcode delurk ()

download_csv (line 455)

The actualiser to download a CSV of members.

void download_csv ()

find_lurkers (line 317)

Find a mapping of member IDs to usernames, of those who'll get delurked.

return: Mapping of lurkers

array find_lurkers (integer $max_posts, integer $max_points, integer $max_logged_actions, integer $min_days_since_login, integer $min_days_since_join, array $usergroups)

integer $max_posts: Maximum forum posts
integer $max_points: Maximum points
integer $max_logged_actions: Maximum logged actions
integer $min_days_since_login: Minimum days since last login
integer $min_days_since_join: Minimum days since joining
array $usergroups: List of usergroups

get_entry_points (line 49)

Standard modular entry-point finder function.

return: A map of entry points (type-code=>language-code) (NULL: disabled).

?array get_entry_points ()

import_csv (line 602)

The UI for importing a CSV file.

return: The UI

tempcode import_csv ()

info (line 32)

Standard modular info function.

return: Map of module info (NULL: module is disabled).

?array info ()

menu (line 88)

The do-next manager for choosing what to do

return: The UI

tempcode menu ()

run (line 59)

Standard modular run function.

return: The result of execution.

tempcode run ()

step1 (line 125)

The UI for adding a member.

return: The UI

tempcode step1 ()

step2 (line 145)

The actualiser for adding a member.

return: The UI

tempcode step2 ()

_delurk (line 362)

The UI for confirming the deletion results of delurk criteria.

return: The UI

tempcode _delurk ()

_get_csv_headings (line 428)

Get field mapping data for CSV import/export.

return: A map of heading information (human name to field name/encoding details)

array _get_csv_headings ()

_import_csv (line 631)

The actualiser for importing a CSV file.

return: The UI

tempcode _import_csv ()

__delurk (line 403)

The actualiser for deletion members according to delurk criteria.

return: The UI

tempcode __delurk ()

Class Module_admin_ocf_join