Unofficial SMF API Documentation

./Sources/ManageBans.php

• Ban
• BanList
• list_getBans
• list_getNumBans
• BanEdit
• list_getBanItems
• list_getNumBanItems
• banLoadAdditionalIPs
• banLoadAdditionalIPsMember
• banLoadAdditionalIPsError
• banEdit2
• saveTriggers
• removeBanTriggers
• removeBanGroups
• removeBanLogs
• validateTriggers
• addTriggers
• updateTriggers
• logTriggersUpdates
• updateBanGroup
• insertBanGroup
• BanEditTrigger
• BanBrowseTriggers
• list_getBanTriggers
• list_getNumBanTriggers
• BanLog
• list_getBanLogEntries
• list_getNumBanLogEntries
• range2ip
• checkExistingTriggerIP
• updateBanMembers
• getMemberData

Ban

function Ban(): void

Ban center. The main entrance point for all ban center functions.

It is accesssed by ?action=admin;area=ban. It choses a function based on the ‘sa’ parameter, like many others. The default sub-action is BanList(). It requires the ban_members permission. It initializes the admin tabs.

Uses ManageBans template.

Integration hooks

integrate_manage_bans

BanList

function BanList(): void

Shows a list of bans currently set.

It is accessed by ?action=admin;area=ban;sa=list. It removes expired bans. It allows sorting on different criteria. It also handles removal of selected ban items.

Uses the main ManageBans template.

list_getBans

function list_getBans(int $start, int $items_per_page, string $sort): array

Get bans, what else? For the given options.

list_getNumBans

function list_getNumBans(): int

Get the total number of ban from the ban group table

BanEdit

function BanEdit(): void

This function is behind the screen for adding new bans and modifying existing ones.

Adding new bans: - is accessed by ?action=admin;area=ban;sa=add. - uses the ban_edit sub template of the ManageBans template. Modifying existing bans:

• is accessed by ?action=admin;area=ban;sa=edit;bg=x
• uses the ban_edit sub template of the ManageBans template.
• shows a list of ban triggers for the specified ban.

Integration hooks

integrate_ban_edit_list

integrate_ban_edit_new

list_getBanItems

function list_getBanItems(int $start = 0, int $items_per_page = 0, int $sort = 0, int $ban_group_id = 0): array

Retrieves all the ban items belonging to a certain ban group

Integration hooks

integrate_ban_list

list_getNumBanItems

function list_getNumBanItems(): int

Gets the number of ban items belonging to a certain ban group

banLoadAdditionalIPs

function banLoadAdditionalIPs(int $member_id): array

Finds additional IPs related to a certain user

Integration hooks

integrate_load_addtional_ip_ban

banLoadAdditionalIPsMember

function banLoadAdditionalIPsMember(int $member_id): array

Loads additional IPs used by a specific member

banLoadAdditionalIPsError

function banLoadAdditionalIPsError(int $member_id): array

Loads additional IPs used by a member from the error log

banEdit2

function banEdit2(): void

This function handles submitted forms that add, modify or remove ban triggers.

Integration hooks

integrate_edit_bans

integrate_edit_bans_post

saveTriggers

function saveTriggers(array $suggestions, int $ban_group, int $member = 0, int $ban_id = 0): array|bool

Saves one or more ban triggers into a ban item: according to the suggestions checks the $_POST variable to verify if the trigger is present

Integration hooks

integrate_save_triggers

removeBanTriggers

function removeBanTriggers(int[]|int $items_ids = array(), bool|int $group_id = false): bool

This function removes a bunch of triggers based on ids Doesn’t clean the inputs

Integration hooks

integrate_remove_triggers

removeBanGroups

function removeBanGroups(array $group_ids): bool

This function removes a bunch of ban groups based on ids Doesn’t clean the inputs

removeBanLogs

function removeBanLogs(array $ids = array()): bool

Removes logs - by default truncate the table Doesn’t clean the inputs

validateTriggers

function validateTriggers(array &$triggers): array

This function validates the ban triggers

Errors in $context[‘ban_errors’]

addTriggers

function addTriggers(int $group_id = 0, array $triggers = array(), array $logs = array()): bool

This function actually inserts the ban triggers into the database

Errors in $context[‘ban_errors’]

updateTriggers

function updateTriggers(int $ban_item = 0, int $group_id = 0, array $trigger = array(), array $logs = array()): void

This function updates an existing ban trigger into the database

Errors in $context[‘ban_errors’]

logTriggersUpdates

function logTriggersUpdates(array $logs, bool $new = true, bool $removal = false): void

A small function to unify logging of triggers (updates and new)

updateBanGroup

function updateBanGroup(array $ban_info = array()): int

Updates an existing ban group

Errors in $context[‘ban_errors’]

insertBanGroup

function insertBanGroup(array $ban_info = array()): int

Creates a new ban group If the group is successfully created the ID is returned On error the error code is returned or false

Errors in $context[‘ban_errors’]

BanEditTrigger

function BanEditTrigger(): void

This function handles the ins and outs of the screen for adding new ban triggers or modifying existing ones.

Adding new ban triggers: - is accessed by ?action=admin;area=ban;sa=edittrigger;bg=x - uses the ban_edit_trigger sub template of ManageBans. Editing existing ban triggers:

• is accessed by ?action=admin;area=ban;sa=edittrigger;bg=x;bi=y
• uses the ban_edit_trigger sub template of ManageBans.

BanBrowseTriggers

function BanBrowseTriggers(): void

This handles the screen for showing the banned entities It is accessed by ?action=admin;area=ban;sa=browse It uses sub-tabs for browsing by IP, hostname, email or username.

Uses a standard list (@see createList())

list_getBanTriggers

function list_getBanTriggers(int $start, int $items_per_page, string $sort, string $trigger_type): array

Get ban triggers for the given parameters. Callback from $listOptions[‘get_items’] in BanBrowseTriggers()

list_getNumBanTriggers

function list_getNumBanTriggers(string $trigger_type): int

This returns the total number of ban triggers of the given type. Callback for $listOptions[‘get_count’] in BanBrowseTriggers().

BanLog

function BanLog(): void

This handles the listing of ban log entries, and allows their deletion.

Shows a list of logged access attempts by banned users. It is accessed by ?action=admin;area=ban;sa=log. How it works:

• allows sorting of several columns.
• also handles deletion of (a selection of) log entries.

list_getBanLogEntries

function list_getBanLogEntries(int $start, int $items_per_page, string $sort): array

Load a list of ban log entries from the database.

(no permissions check). Callback for $listOptions[‘get_items’] in BanLog()

list_getNumBanLogEntries

function list_getNumBanLogEntries(): int

This returns the total count of ban log entries. Callback for $listOptions[‘get_count’] in BanLog().

range2ip

function range2ip(string $low, string $high): string

Convert a range of given IP number into a single string.

It’s practically the reverse function of ip2range().

checkExistingTriggerIP

function checkExistingTriggerIP(array $ip_array, string $fullip = ''): bool|array

Checks whether a given IP range already exists in the trigger list.

If yes, it returns an error message. Otherwise, it returns an array optimized for the database.

updateBanMembers

function updateBanMembers(): void

As it says… this tries to review the list of banned members, to match new bans.

Note: is_activated >= 10: a member is banned.

getMemberData

function getMemberData(int $id): array

Gets basic member data for the ban

Suggest an edit to this page on GitHub