Open Journal Systems  2.4.4
 All Classes Namespaces Functions Variables Groups Pages
StopForumSpamPlugin Class Reference
Inheritance diagram for StopForumSpamPlugin:

Public Member Functions

 getManagementVerbs ()
 manage ($verb, $args, &$message, &$messageParams)
 register ($category, $path)
 setBreadcrumbs ($isSubclass=false)
 smartyPluginUrl ($params, &$smarty)
 validateExecute ($hookName, $params)
- Public Member Functions inherited from GenericPlugin
 GenericPlugin ()
 getManagementVerbs ($verbs=array())
 manage ($verb, $args, &$message, &$messageParams)
- Public Member Functions inherited from LazyLoadPlugin
 getEnabled ()
 getName ()
 LazyLoadPlugin ()
 register ($category, $path)
 setEnabled ($enabled)
- Public Member Functions inherited from Plugin
 getContextSpecificPluginSettingsFile ()
 getNewJournalPluginSettingsFile ()
 getSetting ($journalId, $name)
 Plugin ()
 updateSetting ($journalId, $name, $value, $type=null)
- Public Member Functions inherited from PKPPlugin
 _getContextSpecificInstallationHook ()
 addHelpData ($locale=null)
 addLocaleData ($locale=null)
 getCategory ()
 getContextSpecificPluginSettingsFile ()
 getContextSpecificSetting ($context, $name)
 getCurrentVersion ()
 getDescription ()
 getDisplayName ()
 getHelpMappingFilename ()
 getHideManagement ()
 getInstallDataFile ()
 getInstallEmailTemplateDataFile ()
 getInstallEmailTemplatesFile ()
 getInstallFilterConfigFiles ()
 getInstallSchemaFile ()
 getInstallSitePluginSettingsFile ()
 getLocaleFilename ($locale)
 getManagementVerbs ()
 getName ()
 getPluginPath ()
 getSeq ()
 getSettingMainContext ()
 getTemplatePath ()
 import ($class)
 installContextSpecificSettings ($hookName, $args)
 installData ($hookName, $args)
 installEmailTemplateData ($hookName, $args)
 installEmailTemplates ($hookName, $args)
 installFilters ($hookName, $args)
 installLocale ($hookName, $args)
 installSiteSettings ($hookName, $args)
 isSitePlugin ()
 manage ($verb, $args, &$message, &$messageParams, $request=null)
 PKPPlugin ()
 register ($category, $path)
 smartyPluginUrl ($params, &$smarty)
 updateContextSpecificSetting ($context, $name, $value, $type=null)
 updateSchema ($hookName, $args)

Detailed Description

Stop Forum Spam plugin class.

Definition at line 20 of file

Member Function Documentation

StopForumSpamPlugin::getManagementVerbs ( )

Display verbs for the management interface.

Definition at line 93 of file

StopForumSpamPlugin::manage (   $verb,

Execute a management verb on this plugin

$messagestring Result status message
$messageParamsarray Parameters for the message key

Definition at line 173 of file

References Request\getJournal(), PKPRequest\getUserVar(), StopForumSpamSettingsForm\readInputData(), and PKPRequest\redirect().

StopForumSpamPlugin::register (   $category,

Called as a plugin is registered to the registry

$categoryString Name of category plugin was registered to
boolean True iff plugin initialized successfully; if false, the plugin will not be registered.

Definition at line 27 of file

References Config\getVar(), and HookRegistry\register().

StopForumSpamPlugin::setBreadcrumbs (   $isSubclass = false)

Set the page's breadcrumbs, given the plugin's tree of items to append.


Definition at line 70 of file

References Request\url().

StopForumSpamPlugin::smartyPluginUrl (   $params,

Extend the {url ...} smarty to support this plugin.

Definition at line 48 of file

References PKPPlugin\getCategory(), and PKPPlugin\getName().

StopForumSpamPlugin::validateExecute (   $hookName,

Provides a hook against the validate() method in the RegistrationForm class. This function initiates a curl() call to the Stop Forum Spam API and submits the new user data for querying. If there is a positive match, the method inserts a form validation error and returns true, preventing the form from validating successfully.

The first element in the $params array is the form object being submitted.


Definition at line 114 of file

References Request\getJournal(), PKPRequest\getRemoteAddr(), and Plugin\getSetting().

The documentation for this class was generated from the following file: