XenForo Reference Guide for Developer
Back to top  

Base (abstract) report handler for reporting specific content types.

package XenForo_Report

 Methods

Gets the link to the content in the specified report.

getContentLink(array $report, array $contentInfo) : string

Parameters

$report

array

Report info

$contentInfo

array

Extra content with report

Returns

string

Gets the title of the content in the specified report.

getContentTitle(array $report, array $contentInfo) : string | \XenForo_Phrase

Parameters

$report

array

Report info

$contentInfo

array

Extra content with report

Returns

string\XenForo_Phrase

Gets report-related details from list of info about content being reported.

getReportDetailsFromContent(array $content) : array

Returns 3 values (as array): * content ID * content user ID * array of info about content to store with report

Parameters

$content

array

Returns

arraySee above.

Returns all the reports for this content type that are visible/manageable to the viewing user.

getVisibleReportsForUser(array $reports, array $viewingUser) : array

Parameters

$reports

array

Format: [report id] => report info

$viewingUser

array

Viewing user array

Returns

arrayList of reports that can be seen/managed, [report id] => info

Prepares the extra content for display.

prepareExtraContent(array $contentInfo) : array

Parameters

$contentInfo

array

Returns

array

Prepares a report for display.

prepareReport(array $report) : array

Parameters

$report

array

Returns

arrayPrepared report

Prepares a collection of reports.

prepareReports(array $reports) : array

Parameters

$reports

array

Returns

array

A callback that is called when viewing the full report.

viewCallback(\XenForo_View $view, array $report, array $contentInfo) : \XenForo_Template_Abstract | string

Parameters

$view

\XenForo_View

$report

array

$contentInfo

array

Returns

\XenForo_Template_Abstractstring