Procedural File: functions.inc

Source Location: /plugins/spamx/functions.inc

Page Details:

File: functions.inc This is the functions.inc for the Geeklog Spam-X plugin

Licensed under GNU General Public License

Includes:

include_once($plugin_path.'language/english.php') [line 29]
include_once($langfile) [line 27]
Language file include

require_once($_CONF['path_system'].'classes/config.class.php') [line 36]
Check and see if we need to load the plugin configuration

plugin_autouninstall_spamx [line 432]

array plugin_autouninstall_spamx(
)

Automatic uninstall function for plugins

This code is automatically uninstalling the plugin. It passes an array to the core code function that removes tables, groups, features and php blocks from the tables. Additionally, this code can perform special actions that cannot be foreseen by the core code (interactions with other plugins for example)

Tags:

return:

Plugin information

[ Top ]

plugin_cclabel_spamx [line 115]

array plugin_cclabel_spamx(
)

This will put an option for the plugin in the command and control block on moderation.php

Add the plugin name, icon and link to the command and control block in moderation.php

Tags:

return:

Array containing (plugin name, admin url, url of plugin icon)

[ Top ]

plugin_checkforSpam_spamx [line 293]

int plugin_checkforSpam_spamx(
string $comment, [int $action = -1])

Check a post for spam

Tags:

return:

> 0: spam detected, == 0: no spam

Parameters

string	$comment	comment text
int	$action	(former spam action - not used any more)

[ Top ]

plugin_chkVersion_spamx [line 151]

string plugin_chkVersion_spamx(
)

Returns the current plugin code version

Tags:

return:

plugin version

[ Top ]

plugin_getadminoption_spamx [line 136]

array plugin_getadminoption_spamx(
)

Returns the administrative option for this plugin

Adds the plugin to the Admin menu

Tags:

return:

Array containing (plugin name, plugin admin url, # of items in plugin or '')

[ Top ]

plugin_getconfigtooltip_spamx [line 499]

mixed plugin_getconfigtooltip_spamx(
string $id)

Provides text for a Configuration tooltip

Tags:

return:

Text to use regular tooltip, NULL to use config tooltip hack, or empty string when not available

Parameters

string

$id

Id of config value

[ Top ]

plugin_getdocumentationurl_spamx [line 460]

mixed plugin_getdocumentationurl_spamx(
string $file)

Provide URL of a documentation file

Tags:

return:

URL or false when not available

Parameters

string

$file

documentation file being requested, e.g. 'config'

[ Top ]

plugin_geticon_spamx [line 413]

string plugin_geticon_spamx(
)

Returns the URL of the plugin's icon

Tags:

return:

URL of the icon

[ Top ]

plugin_migrate_spamx [line 260]

void plugin_migrate_spamx(
array $old_conf, boolean 1)

Called during site migration - handle changed URLs or paths

Parameters

array	$old_conf	contents of the $_CONF array on the old site
boolean	1	true on success, otherwise false

[ Top ]

plugin_showstats_spamx [line 57]

string plugin_showstats_spamx(
int $showsitestats)

Shows the statistics for the plugin on stats.php. If $showsitestats is 1 then we are to only print the overall stats in the 'site statistics' box otherwise we show the detailed stats for the plugin

Tags:

return:	returns formatted HTML to insert in stats page
see:	plugin_statssummary_spamx()

Parameters

int

$showsitestats

Flag to let us know which stats to get

[ Top ]

plugin_spamaction_spamx [line 340]

int plugin_spamaction_spamx(
string $comment, int $action)

Perform action after spam has been detected

Tags:

return:

number of message to display to the spammer

Parameters

string	$comment	comment text
int	$action	which action modules to call (sum of module numbers)

[ Top ]

plugin_statssummary_spamx [line 99]

array(item plugin_statssummary_spamx(
)

New stats plugin API function for proper integration with the site stats

Tags:

return:	text, item count);
see:	plugin_showstats_spamx()

[ Top ]

plugin_upgrade_spamx [line 168]

int plugin_upgrade_spamx(
)

Update the Spam-X plugin

Tags:

return:

Number of message to display

[ Top ]

SPAMX_log [line 387]

void SPAMX_log(
string $logentry)

Logs message to spamx.log

This will print a message to the spamx log

Parameters

string

$logentry

Message to write to log

[ Top ]

Documentation generated on Fri, 25 May 2012 02:08:32 -0400 by phpDocumentor 1.4.3