Unofficial SMF API Documentation

./Sources/Reports.php

• ReportsMain
• BoardReport
• BoardPermissionsReport
• MemberGroupsReport
• GroupPermissionsReport
• StaffReport
• newTable
• addData
• addSeparator
• finishTables
• setKeys

ReportsMain

function ReportsMain(): void

Handling function for generating reports.

Requires the admin_forum permission. Loads the Reports template and language files. Decides which type of report to generate, if this isn’t passed through the querystring it will set the report_type sub-template to force the user to choose which type. When generating a report chooses which sub_template to use. Depends on the cal_enabled setting, and many of the other cal_ settings. Will call the relevant report generation function. If generating report will call finishTables before returning. Accessed through ?action=admin;area=reports.

Integration hooks

integrate_report_types

integrate_report_buttons

BoardReport

function BoardReport(): void

Standard report about what settings the boards have.

functions ending with “Report” are responsible for generating data for reporting. they are all called from ReportsMain. never access the context directly, but use the data handling functions to do so.

BoardPermissionsReport

function BoardPermissionsReport(): void

Generate a report on the current permissions by board and membergroup.

functions ending with “Report” are responsible for generating data for reporting. they are all called from ReportsMain. never access the context directly, but use the data handling functions to do so.

Integration hooks

integrate_reports_boardperm

MemberGroupsReport

function MemberGroupsReport(): void

Show what the membergroups are made of.

functions ending with “Report” are responsible for generating data for reporting. they are all called from ReportsMain. never access the context directly, but use the data handling functions to do so.

GroupPermissionsReport

function GroupPermissionsReport(): void

Show the large variety of group permissions assigned to each membergroup.

functions ending with “Report” are responsible for generating data for reporting. they are all called from ReportsMain. never access the context directly, but use the data handling functions to do so.

Integration hooks

integrate_reports_groupperm

StaffReport

function StaffReport(): void

Report for showing all the forum staff members - quite a feat! functions ending with “Report” are responsible for generating data for reporting.

they are all called from ReportsMain. never access the context directly, but use the data handling functions to do so.

newTable

function newTable(string $title = '', string $default_value = '', string $shading = 'all', string $width_normal = 'auto', string $align_normal = 'center', string $width_shaded = 'auto', string $align_shaded = 'auto'): void

This function creates a new table of data, most functions will only use it once.

The core of this file, it creates a new, but empty, table of data in context, ready for filling using addData(). Fills the context variable current_table with the ID of the table created. Keeps track of the current table count using context variable table_count.

addData

function addData(array $inc_data, ?string $custom_table = null): void|false

Adds an array of data into an existing table.

if there are no existing tables, will create one with default attributes. if custom_table isn’t specified, it will use the last table created, if it is specified and doesn’t exist the function will return false. if a set of keys have been specified, the function will check each required key is present in the incoming data. If this data is missing the current tables default value will be used. if any key in the incoming data begins with ‘#sep#’, the function will add a separator across the table at this point. once the incoming data has been sanitized, it is added to the table.

addSeparator

function addSeparator(string $title = '', ?string $custom_table = null): void|bool

Add a separator row, only really used when adding data by rows.

finishTables

function finishTables(): void

This does the necessary count of table data before displaying them.

is (unfortunately) required to create some useful variables for templates. foreach data table created, it will count the number of rows and columns in the table. will also create a max_width variable for the table, to give an estimate width for the whole table * * if it can.

setKeys

function setKeys(string $method = 'rows', array $keys = array(), bool $reverse = false): void

Set the keys in use by the tables - these ensure entries MUST exist if the data isn’t sent.

sets the current set of “keys” expected in each data array passed to addData. It also sets the way we are adding data to the data table. method specifies whether the data passed to addData represents a new column, or a new row. keys is an array whose keys are the keys for data being passed to addData(). if reverse is set to true, then the values of the variable “keys” are used as opposed to the keys(!

Suggest an edit to this page on GitHub