XenForo Reference Guide for Developer » \XenForo_ReportHandler

Methods

Handler for reported conversation messages.

package	XenForo_Report

Methods

Gets the link to the specified content.

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

see	\XenForo_ReportHandler_Abstract::getContentLink()

Parameters

$report

array

Report info

$contentInfo

array

Extra content with report

Returns

string

Gets the title of the specified content.

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

see	\XenForo_ReportHandler_Abstract:getContentTitle()

Parameters

$report

array

Report info

$contentInfo

array

Extra content with report

Returns

string\XenForo_Phrase

Gets report details from raw array of content (eg, a post record).

getReportDetailsFromContent(array $content) : array

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

see	\XenForo_ReportHandler_Abstract::getReportDetailsFromContent()

Parameters

$content

array

Returns

arraySee above.

Gets the visible reports of this content type for the viewing user.

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

see	\XenForo_ReportHandler_Abstract:getVisibleReportsForUser()

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

Inherited

inherited_from	\XenForo_ReportHandler_Abstract::prepareExtraContent()

Parameters

$contentInfo

array

Returns

array

Prepares a report for display.

prepareReport(array $report) : array

Inherited

inherited_from	\XenForo_ReportHandler_Abstract::prepareReport()

Parameters

$report

array

Returns

arrayPrepared report

Prepares a collection of reports.

prepareReports(array $reports) : array

Inherited

inherited_from	\XenForo_ReportHandler_Abstract::prepareReports()

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

see	\XenForo_ReportHandler_Abstract::viewCallback()

Parameters

$view

\XenForo_View

$report

array

$contentInfo

array

Returns

\XenForo_Template_Abstractstring