default_plugin Class Reference

Public Member Functions
	__construct (ipsRegistry $registry)
	displayAdminForm ($plugin_data, &$html)
	formatReportData ($report_data)
	getNotificationList ($group_ids, $report_data)
	getReportPermissions ($check, $com_dat, $group_ids, &$to_return)
	giveSectionLinkTitle ($report_row)
	processAdminForm (&$save_data_array)
	processBasicForumData ($com_dat, &$url, &$title, &$ex_form_data)
	processReport ($com_dat)
	reportForm ($com_dat)
	reportRedirect ($report_data)
	updateReportsTimestamp ($new_reports, &$new_members_cache)
Data Fields
	$_extra
Protected Member Functions
	_getPageTitle ($URL)
Protected Attributes
	$cache
	$caches
	$DB
	$lang
	$member
	$memberData
	$registry
	$request
	$settings

---

Constructor & Destructor Documentation

__construct

(

ipsRegistry $

registry

)

Constructor

Parameters:

object

$registry

Registry object

Returns:

void

---

Member Function Documentation

_getPageTitle

(

$

URL

)

[protected]

Loads an HTML page and grabs its title

Parameters:

string

Web URL

Returns:

string

displayAdminForm	(	$	plugin_data,
		&$	html
	)

Display the form for extra data in the ACP

Parameters:

array	Plugin data
object	HTML object

Returns:

string HTML to add to the form

formatReportData

(

$

report_data

)

Accepts an array of data from rc_reports_index and returns an array formatted nearly identical to processReport()

Parameters:

array

Report data

Returns:

array Formatted report data

getNotificationList	(	$	group_ids,
		$	report_data
	)

Retrieve list of users to send notifications to

Parameters:

string	Group ids
array	Report data

Returns:

array Array of users to PM/Email

getReportPermissions	(	$	check,
		$	com_dat,
		$	group_ids,
		&$	to_return
	)

Get report permissions

Parameters:

string	Type of perms to check
array	Permissions data
array	group ids
string	Special permissions

Returns:

boolean

giveSectionLinkTitle

(

$

report_row

)

Get section and link

Parameters:

array

Report data

Returns:

array Section/link

processAdminForm

(

&$

save_data_array

)

Process the plugin's form fields for saving

Parameters:

array

Plugin data for save

Returns:

string Error message

processBasicForumData	(	$	com_dat,
		&$	url,
		&$	title,
		&$	ex_form_data
	)

Process the basic forum data

Parameters:

array	Application data
string	URL
string	Title
array	Extra form data

Returns:

mixed Could show page error, or set $url, $title and $ex_form_data

processReport

(

$

com_dat

)

Process a report and save the data appropriate

Parameters:

array

Report data

Returns:

array Data from saving the report

reportForm

(

$

com_dat

)

Show the report form for this module

Parameters:

array

Application data

Returns:

string HTML form information

reportRedirect

(

$

report_data

)

Where to send user after report is submitted

Parameters:

array

Report data

Returns:

void

updateReportsTimestamp	(	$	new_reports,
		&$	new_members_cache
	)

Update timestamp for report

Parameters:

array	New reports
array	New members cache

Returns:

boolean

---

Field Documentation

$registry [protected]

Registry Object Shortcuts

---

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

• admin/applications/core/extensions/reportPlugins/default.php