silverstripe-spamprotection/INSTALL

39 lines
1.6 KiB
Plaintext
Raw Normal View History

2009-02-04 05:41:14 +01:00
SilverStripe SpamProtection Module 0.1 beta
=======================================
INSTALLATION
------------
1. Unzip this file (spamprotection-0.1.tar.gz) inside your SilverStripe installation directory.
It should be at the same level as 'jsparty', 'cms' and 'sapphire' modules.
2. Ensure the directory name for the module is 'spamprotection'.
2009-07-10 05:32:27 +02:00
3. Visit your SilverStripe site in a webbrowser and run www.yoursite.com/dev/build
2009-02-04 05:41:14 +01:00
5. We now need to setup some basic features to get the module up and running. Open up _config.php
inside project directory (typically 'mysite/_config.php') with your favourite text editor.
Read the instructions below to setup the initial configuration of the module.
SETTING UP THE MODULE (in 'mysite/_config.php')
------------------------------------------------------
Before putting the following code in '_config.php', make sure you have a subclass of 'SpamProtectorField' installed or written. One
example of 'SpamProtector' subclass is 'MollomField'.
2009-02-04 05:41:14 +01:00
SpamProtectorManager::set_spam_protector('MollomSpamProtector');
2009-02-04 05:41:14 +01:00
UPDATING A FORM TO INCLUDE THE SPAM PROTECTOR FIELD
2009-02-04 05:41:14 +01:00
---------------------------------------------------
This following code should appear after the form creation.
$protector = SpamProtectorManager::update_form($form, 'Message');
2009-02-04 05:41:14 +01:00
This code add an instance of a 'SpamProtectorField' class specified in SETTING UP THE MODULE section. The newly created field will have
MollomField field. The first parameter is a Form object in which the field will be added into and the second parameter tells
SpamProtectorManagor to place the new field before a field named 'Message'.