Docs For Class Module_admin

Class Module_admin_wordfilter

Description

Module page class.

Located in /adminzone/pages/modules/admin_wordfilter.php (line 24)

Method Summary

tempcode add_word ()

?array get_entry_points ()

?array info ()

void install ([?integer $upgrade_from = NULL], [?integer $upgrade_from_hack = NULL])

tempcode remove_word ()

tempcode run ()

void uninstall ()

tempcode word_filter_interface ()

void _add_word (SHORT_TEXT $word, SHORT_TEXT $replacement, BINARY $substr)

void _remove_word (SHORT_TEXT $word)

Methods

add_word (line 161)

The actualiser to add a filtered-word.

return: The UI

tempcode add_word ()

get_entry_points (line 91)

Standard modular entry-point finder function.

return: A map of entry points (type-code=>language-code) (NULL: disabled).

?array get_entry_points ()

info (line 32)

Standard modular info function.

return: Map of module info (NULL: module is disabled).

?array info ()

install (line 59)

Standard modular install function.

void install ([?integer $upgrade_from = NULL], [?integer $upgrade_from_hack = NULL])

?integer $upgrade_from: What version we're upgrading from (NULL: new install)
?integer $upgrade_from_hack: What hack version we're upgrading from (NULL: new-install/not-upgrading-from-a-hacked-version)

remove_word (line 195)

The actualiser to delete a filtered-word.

return: The UI

tempcode remove_word ()

run (line 101)

Standard modular run function.

return: The result of execution.

tempcode run ()

uninstall (line 48)

Standard modular uninstall function.

void uninstall ()

word_filter_interface (line 122)

The UI to choose a filtered-word to edit, or to add a filtered-word.

return: The UI

tempcode word_filter_interface ()

_add_word (line 180)

Add a filtered-word.

void _add_word (SHORT_TEXT $word, SHORT_TEXT $replacement, BINARY $substr)

SHORT_TEXT $word: The filtered-word
SHORT_TEXT $replacement: Replacement (blank: block entirely)
BINARY $substr: Whether to perform a substring match

_remove_word (line 211)

Delete a filtered-word.

void _remove_word (SHORT_TEXT $word)

SHORT_TEXT $word: The filtered-word

Documentation generated on Sun, 02 Jan 2011 23:08:11 +0000 by phpDocumentor 1.4.3