sammela.com » Uncategorized

Database Access in OpenCart

Sam Mela — Mon, 16 Nov 2009 22:22:02 +0000

The OpenCart Ecommerce software package is designed for database portability.

PHP, the native language of OpenCart, contains built in functions that are specific to different sql implementations, such as MySql, but these absolutely should not be used in any modules or add-ons that are written for OpenCart.

Instead, the DB class should be used, to preserve database portability.

The DB class is located in the db.php file contained in the system/library/ directory, under the OpenCart application directory.

The following example shows how the DB class is used to look at the contents of the setting database table and the coupon database table with its related coupon_description table.

The DB class provides a standard database implementation independent interface for the rest of the OpenCart application software.

constructor	Accepts the following parameters: $hostname, $username, $password, $database.Sets up a connection to the database.
destructor	Destroys the connection to the database.
query	Accepts a query, called $sql. Queries the database and returns the result, but does some other cool things too. If the result fromt the query is a database “resource”, this method reads all the rows from the resource, and returns them in an object that contains both and array of the database rows and the count of the database rows. See example later in this article.
escape	Makes data safe to insert in the database by prepending backslashes to unsafe characters such as single quote, double quote, and others. See the PHP documentation on the mysql_real_escape_string function, for more detail.
countAffected	Returns the number of affected rows in the previous query.
getLastId	Returns an id generated for the auto increment column from the most recent insert, or 0 if the previous query did not result in a new auto increment.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20

// Create the $db object of the DB Class
$db = new DB(DB_DRIVER, DB_HOSTNAME, DB_USERNAME, DB_PASSWORD, DB_DATABASE);

// Query the contents of the setting table
$query = $db->query("SELECT * FROM " . DB_PREFIX . "setting");

// Display the results of the query
foreach ($query->rows as $setting) {
echo($setting['key']." ".$setting['value']."
");
}

// Query the contents of the coupon table left joined to the coupon_description table
$coupon_query = $db->query("SELECT * FROM " . DB_PREFIX . "coupon c LEFT JOIN " . DB_PREFIX . "coupon_description cd ON (c.coupon_id = cd.coupon_id) WHERE c.status = '1'");

// Display the results of the query
foreach ($coupon_query->rows as $coupon)
{
echo("

"); print_r($coupon); echo("

");
}

Amazing Wordpress Hooks

Sam Mela — Mon, 12 Oct 2009 21:35:15 +0000

In thirty years of programming I have seen a lot of what were called “frameworks”.

Some frameworks were too complicated and abstract to use, some were poorly documented, some weren’t very well written; but in my mind the WordPress framework is superb, and a key feature of the WordPress framework is “hooks”.

What are Hooks

So just what exactly are WordPress hooks?

This is how the WordPress documentation defines hooks:

Hooks are provided by WordPress to allow your plugin to ‘hook into’ the rest of WordPress; that is, to call functions in your plugin at specific times, and thereby set your plugin in motion.

This is true, but let’s try to look at it another way.

Let’s say you have a guy who comes and fertilizes your lawn twice a year — once in the spring and once in the fall. You decide you’d like him to water your lawn after he fertilizes. You call him up and you say, “Hey, from now on when you fertilize my lawn in the spring, please water it afterwards; and when you fertilize my lawn in the fall, please water it .”

That’s it. You just hooked the activity of lawn watering into spring fertilizing and fall fertilizing. Note that you don’t need to know if spring fertilizing was on March 17 or April 7. It doesn’t matter. Same with fall fertilizing. If the lawn guy follows your instructions he just waters after he fertilizes. Furthermore, if you have a reliable lawn guy, you don’t need to pay attention to when he fertilizes and then remind him to water, because one activity follows another. It’s scheduled.

Tying One Activity to Another

Simply put, hooks tie one activity to another in WordPress. There are actually two types of hooks defined in WordPress — Actions and Filters. We’ll get into that more later in this article, but for now let us look at an example of the use of a hook. We’ll use the example given in the WordPress documentation.

Let us suppose that you want an E-mail sent to a friend of your friends John and Maureen every time you make a post. Here’s a handy function to do that:

1
2
3
4
5
6
7

function email_post_info($post_ID)
{
$addresses = "john@sam_example.org,maureen@sam_example.org";
mail( $addresses, "Sam blog entry",
"Please see blog entry: http://blog.sam_example.com");
return $post_ID;
}

Good function, but how does it get called?

Simple — attach the email_post_info function to the publish_post action; and fortunately WordPress offers a simple way to do that, shown below:

1	add_action ( "publish_post", "email_post_info");

Basically, that’s it. The WordPress add_action function above is used to register the email_post_info function to be called when WordPress executes the publish_post action.

Not that “publish_post” is one of many standard hook names defined in WordPress. For example, other post related actions are “comment_post”, “deleted_post”, “edit_post”. There are various compilations of these actions at Plugin API/Hooks 2.0.x , The WordPress Hooks Database, and Comprehensive List for Plugin and Theme Developers. The latter claims to included “documented as well as undocumented” hooks.

Action Hooks Versus Filter Hooks

Action hooks are designed to allow Wordpress to call a plugin function when specific events occur in WordPress. In other words, they cause an action to take place.

Filter hooks, on the other hand, are designed to make changes in specific types of data. In other words, they filter data.

We already looked at an action hook in the previous section. Now let’s look at a filter hook.

Filter Hook Example

Here is a simple example of a WordPress filter hook, taken from the WordPress default-filters.php file:

1	file add_filter('the_title', 'trim');

What does this do?

It applies the standard PHP Library trim function to the page title.

http://www.dinke.net/blog/2007/08/06/php-callback-functions-and-oop/en/

References

- Understanding Action Hooks In Wordpress
- Plugin API
- Writing a Plugin
- Plugin API/Hooks 2.0.x

Notes on Simpler CSS Plugin

Sam Mela — Mon, 12 Oct 2009 16:06:14 +0000

Creating An Options / Admin Page For Your WordPress Plugin

Installing JAM Affiliate Manager Software on HostGator

Sam Mela — Sat, 10 Oct 2009 19:41:14 +0000

I just installed the JROX JAM Affiliate Manager package onto HostGator account, and guess what? It was easy!

I admit HostGator is my host. I switched to Host Gator earlier this year from another large hosting company, and I have been very happy so far.

But on to how I did the installation.

Installation Options

JROX gives you multiple different options for how to do it. This article describes how I used the manual option, which means I unzipped the files and used FTP to upload them to my Web account. They also provide an exe file that does the install for you. See the documents referenced at the end of this article for more information on that method, as well as other authoritative information from JROX.COM.

Method of Installation

As stated above, I chose to unzip the JAM files to my PC and upload them using the Dreamweaver FTP capability.

The files as I downloaded them were all contained in a zip file called download.jam.zip .

Within that file is another zip file called affiliates.zip .

And finally within affiliates.zip is a folder called affiliates .

If you are installing the way I did, you will want to upload the entire affiliates folder to your site, and it will be located at something like http://www.yoursite.com/affiliates.

Overview of Installation

To install JAM manually, as I did,

Set Your FTP for Binary File Transfer

I can’t overemphasize the importance of using binary FTP as opposed to Text Mode. I used FileZilla , and it was a simple matter to set it for binary transfer. Your installation won’t work if you upload your files in text more.

Customize the Include File

You’ll need to make some modifications in the affiliates\includes\config.php file. This file contains a lot of PHP definition statements.

See an example version of the config.php file.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425

##############################################################################
# WARNING -- THIS IS NOT THE ACTUAL JROX CONFIG FILE
# THIS FILE IS FOR TEACHING PURPOSES ONLY
##############################################################################
## JROX.COM Affiliate Manager - config.php file ##
## Version 1.6.2 ##
## ##
## Author: Ryan Roxas(ryan@jrox.com) ##
## Homepage: http://jam.jrox.com ##
## Bug Reports: http://jam.jrox.com/bugzilla/ ##
## Release Notes: docs/READ_ME.txt ##
##############################################################################

##############################################################################
## COPYRIGHT NOTICE ##
## Copyright 2006 JROX Technologies, Inc. All Rights Reserved. ##
## ##
## This script may be only used and modified in accordance to the license ##
## agreement attached (license.txt) except where expressly noted within ##
## commented areas of the code body. This copyright notice and the ##
## comments above and below must remain intact at all times. By using this ##
## code you agree to indemnify JROX Technologies, Inc, its corporate agents ##
## and affiliates from any liability that might arise from its use. ##
## ##
## Selling the code for this program without prior written consent is ##
## expressly forbidden and in violation of Domestic and International ##
## copyright laws. ##
##############################################################################

if (!defined('JROX'))
die('Error');

##########################################################################################
## THIS FILE IS THE MAIN CONFIGURATION FILE FOR YOUR JAM INSTALLATION. PLEASE EDIT ##
## THE FOLLOWING SETTINGS TO CONNECT TO YOUR MYSQL DATABASE AND TO YOUR HOME DIRECTORY ##
##########################################################################################

//ENTER THE NAME OF THE DATABASE SERVER YOU ARE CONNECTING TO. NORMALLY SET TO "localhost"
define("JAM_DATABASE_SERVER", "localhost");

//ENTER THE NAME OF YOUR DATABASE
define("JAM_DATABASE_NAME", "your_database");

//ENTER THE USERNAME THAT CONNECTS TO YOUR DATABASE
define("JAM_DATABASE_USERNAME", "database_user");

//ENTER THE PASSWORD FOR YOUR DATABASE USER
define("JAM_DATABASE_PASSWORD", "database_password");

//ENTER THE PASSWORD FOR YOUR SCHEDULED CRON JOB
define("JAM_CRON_JOB_PASSWORD", "cron_password");

//ENTER THE DOMAIN NAME OF YOUR WEBSITE
//EXAMPLE WOULD BE: jrox.com
//DO NOT INCLUDE ANY TRAILING SLASH OR HTTP://
//DO NOT INCLUDE THE SUBDOMAIN, SUCH AS www.
define("JAM_DOMAIN_NAME", "yourdomain.com");

//ENTER THE SUBDOMAIN FOR YOUR SITE
//EXAMPLE WOULD BE www
define("JAM_SUBDOMAIN_NAME", "www");

//THIS IS THE ENTIRE DOMAIN NAME FOR SETTING COOKIES.
//DO NOT INCLUDE ANY SUBDOMAIN, SUCH AS "www".
//AN EXAMPLE WOULD BE: jrox.com
define("COOKIE_DOMAIN", "yourdomain.com");

//ENTER THE ABSOLUTE PATH TO YOUR AFFILIATES DIRECTORY
//AN EXAMPLE WOULD BE: /home/username/public_html/affiliates
//DO NOT INCLUDE A TRAILING SLASH
define("HOME_BASE_DIRECTORY", "/home/username/public_html/affiliates");

//ENTER THE NAME OF YOUR AFFILIATE PROGRAM DIRECTORY
//DO NOT INCLUDE A TRAILING SLASH
define("HOME_BASE_AFFILIATE_DIRECTORY", "/affiliates");

//CONFIGURE NUMBER FORMATTING
//DEFINE HOW YOU WILL BE DISPLAYING YOUR COMMISSION VALUES
define("DECIMAL_SEPARATOR", ".");
define("THOUSANDS_SEPARATOR", ",");
define("DECIMAL_PLACES", 2);

##########################
## URL AND SSL SETTINGS ##
##########################

//SPECIFY WHETHER TO USE HTTP:// OR HTTPS:// FOR AFFILIATE LINKS
define("HTTP_TRANSPORT", "http://");

//SPECIFY WHETHER TO USE SSL FOR ADMIN AREA
define("USE_SSL_ADMIN_AREA", false); //SET TO "true" TO USE SSL

//SET TO true TO USE A SHARED SSL CERTIFICATE FOR THE ADMIN AREA
define("USE_SHARED_CERT_ADMIN", false);

//SPECIFY WHETHER TO USE SSL FOR MEMBERS AREA
define("USE_SSL_MEMBERS_AREA", false); //SET TO "true" TO USE SSL

//SPECIFY THE URL FOR YOUR SHARED SSL CERTIFICATE
//DO NOT INCLUDE A TRAILING SLASH
define("JAM_SHARED_SSL_URL", "srv.domain.com/~affiliates");

###################################
## CURRENCY AND COUNTRY SETTINGS ##
###################################

//ENTER THE 3-DIGIT COUNTRY CODE YOU WANT TO USE FOR PAYMENTS.
//USED PRIMARILY FOR PAYPAL-BASED PAYMENTS
define("PAYPAL_CURRENCY_CODE", "USD");

//CURRENCY CODE FOR MONEYBOOKERS MASS PAYMENT FILE
define("MONEYBOOKERS_CURRENCY_CODE", "USD");

//SET THE DEFAULT COUNTRY TO CHOOSE FROM IF YOU WANT TO CHANGE THIS YOU NEED TO LOOK AT THE COUNTRY LIST FUNCTION
//HERE ARE SOME COMMON VALUES: Canada, United Kingdom, France, Germany, China, Japan
define("JAM_DEFAULT_COUNTRY", "United States");

###################################################################################
## THE FOLLOWING IS ONLY NEEDED IF YOU NEED TO MAKE CHANGES TO THE DEBUGGING AND ##
## ADVANCED SETTINGS FOR YOUR INSTALLATION ##
###################################################################################

##############################
## EMAIL SERVER INFORMATION ##
##############################

//ENTER "php" or "smtp"
define("MAILER_SEND_TYPE", "php");

//THIS NUMBER REPRESENTS THE TOTAL NUMBER OF EMAILS THAT WILL BE SENT VIA THE SCHEDULED JOB AT REGULAR INTERVALS
//IF YOU WANT TO SEND ALL EMAILS AT ONCE, ENTER 0 (ZERO);
define("EMAILS_PER_BATCH", "1000");

//THE EMAIL SERVER YOU WILL BE USING TO SEND EMAILS. TYPICALLY SET TO "localhost"
define("SMTP_HOST", "localhost");

//THIS ENABLES/DISABLES THE NEED FOR SMTP AUTHENTICATION. SET TO "true" IF YOU REQUIRE AUTHENTICATION
define("SMTP_AUTHENTICATION", false);

//THE USERNAME NEEDED TO USE TO SEND EMAILS. ONLY NECESSARY WHEN USING sendmail AS THE "MAILER_SEND_TYPE"
define("SMTP_USERNAME", "smtp_username");

//THE PASSWORD NEEDED TO SEND EMAILS. ONLY NECESSARY WHEN USING sendmail AS THE "MAILER_SEND_TYPE"
define("SMTP_PASSWORD", "smtp_password");

//SMTP PORT NUMBER IF NEEDED
define("SMTP_PORT", "25");

//IF YOU WANT TO SEND ALL MASS EMAILS IMMEDIATELY INSTEAD OF WAITING FOR THE CRON JOB TO RUN, SET THIS TO true
define("JAM_SEND_MASS_EMAILS_IMMEDIATELY", false);

####################
## MYSQL SETTINGS ##
####################

//SET THIS OPTION TO true IF YOU WANT TO USE PERSISTENT CONNECTIONS
define("ENABLE_PERSISTENT_MYSQL_CONNECTIONS", false);

###########################
## EMAIL REPORT SETTINGS ##
###########################

//THIS ENABLES/DISABLES THE DAILY ADMIN STATISTICS REPORTS SENT VIA EMAIL TO THE PRIMARY ADMIN
define("EMAIL_DAILY_ADMIN_REPORTS", true);

//TIME THAT THE DAILY REPORTS AND RECURRING COMMISSIONS WILL BE PROCESSED
//MUST BE IN 24-HOUR FORMAT AND MUST COINCIDE WITH CRON JOB TIME
define("EMAIL_DAILY_ADMIN_REPORTS_TIME", "01:30");

//YOU CAN SET THIS TO html or text FOR THE ADMIN EMAIL FORMAT
define("JAM_EMAIL_DAILY_ADMIN_HTML_TEXT", "html");

//SET WHEN AFFILIATE MONTHLY REPORTS WILL GO OUT
//CHANGE TO daily or weekly or monthly
define("JAM_SEND_AFFILIATE_REPORTS", "monthly");

//MYSQL ERROR AND DEBUGGING INFORMATION
//ONLY SET TO "true" IF YOU ARE HAVING ERRORS IN YOUR INSTALLATION
define("DEBUG_ADVANCED_ERROR", false);

//ONLY SET TO "true" IF YOU WANT THE DEBUGGING INFO EMAILED TO YOU. BE CAREFUL WITH THIS ONE, IT MAY FLOOD YOU WITH EMAILS
define("DEBUG_EMAIL", false);

//EMAIL ADDRESS TO SEND DEBUGGING INFORMATION TO
define("DEBUG_EMAIL_TO", "you@yourdomain.com");

//EMAIL ADDRESS THAT DEBUGGING INFORMATION IS SENT FROM
define("DEBUG_EMAIL_FROM", "error@@yourdomain.com");

//SET THIS TO true IF YOU WANT TO ENABLE READ RECEIPTS ON MASS EMAILS
define("JAM_ENABLE_READ_RECEIPTS_MASS_MAIL", false);

//IF YOU HAVE THE JAM_ENABLE_READ_RECEIPTS OPTION SET TO true, ENTER AN EMAIL ADDRESS TO SEND READ RECEIPTS TO HERE
define("JAM_READ_RECEIPTS_EMAIL_SEND_TO", "you@yourdomain.com");

#######################
## HELP URL SETTINGS ##
#######################

//URL TO LAUNCH THE ADMIN HELP GUIDE
define("ADMIN_HELP_URL", "http://jam.jrox.com/userguide/admin/");

//URL TO LAUNCH THE MEMBER HELP GUIDE
define("MEMBER_HELP_URL", "http://jam.jrox.com/userguide/member/");

#############################################################
## ENABLE / DISABLE AUTO BACKUPS - SET TO "true" TO ENABLE ##
#############################################################

//SET TO "true" IF YOU WANT TO ENABLE AUTOMATIC BACKUPS
define("DB_AUTOMATIC_BACKUPS", false);

//IF YOU WANT TO ENABLE AUTOMATIC BACKUPS, TYPE IN THE PHYSICAL FOLDER LOCATION HERE
define("DB_BACKUP_LOCATION", "/home/username/backup");

//ENTER THE BACKUP SCHEDULE YOU WANT. POSSIBLE VALUES ARE: daily, weekly, monthly
define("DB_BACKUP_SCHEDULE", "weekly");

//DAY OF THE WEEK TO DO WEEKLY BACKUPS ON.
// POSSIBLE VALUES ARE Sun, Mon, Tue, Wed, Thu, Fri, Sat, Sun. ONLY VALID FOR WEEKLY-BASED BACKUPS
define("DB_BACKUP_DAY_WEEKLY", "Sun");

//ENTER THE DAY OF THE MONTH YOU WANT TO DO MONTHLY BACKUPS ON. ONLY VALID FOR MONTHLY-BASED BACKUPS
define("DB_BACKUP_DAY_MONTHLY", "1");

###########################################
## ENABLE / DISABLE REPLICATED WEB SITES ##
###########################################

//MAKE SURE TO SET THE PROPER PERMISSIONS FOR THE FOLDER THAT YOU WILL BE REPLICATING PAGES TO
define("JAM_ENABLE_REPLICATED_SITES", false);

//ENTER THE EXTENSION YOU WANT TO USE FOR REPLICATED WEB PAGES
//EXAMPLES ARE html, htm, php
define("JAM_REPLICATION_EXTENSION", "html");

//SET THIS TO true IF YOU WANT TO USE DYNAMIC VARIABLES IN YOUR REPLICATED WEB PAGES
//YOU WILL NEED TO USE php AS YOUR JAM_REPLICATION_EXTENSION AS WELL
define("JAM_USE_DYNAMIC_VARIABLES_REPLICATION", false);

//ENTER THE ENTIRE PHYSICAL PATH OF THE WEB PAGE YOU WANT REPLICATED
define("JAM_REPLICATION_TEMPLATE", "/home/username/public_html/affiliates/plugins/misc/replicated.html");

//ENTER THE ENTIRE PHYSICAL PATH TO THE REPLICATION DIRECTORY. NO TRAILING SLASH
define("JAM_REPLICATION_DIRECTORY", "/home/username/public_html/affiliates/pages");

#################################
## MEMBERSHIP RENEWAL SETTINGS ##
#################################

//SET TO true TO SEND OUT MEMBERSHIP RENEWAL REMINDERS
define("JAM_ENABLE_MEMBERSHIP_RENEWAL_NOTICE", false);

//THIS IS USED FOR SENDING OUT RENEWAL EMAILS A FEW DAYS PRIOR TO EXPIRATION
define("JAM_MEMBERSHIP_EXPIRATION_INTERVAL", "2");

//SHOW THE MEMBERSHIP UPGRADE PAGE IF AN AFFILIATE MEMBERSHIP IS EXPIRED UPON LOGIN
//SET TO false TO DISABLE
define("JAM_SHOW_UPGRADE_PAGE_ON_EXPIRED_LOGIN", true);

#######################
## USERNAME SETTINGS ##
#######################

//USERNAME REQUIREMENTS
//TOTAL MINIMUM CHARACTERS IS 3
define("JAM_MINIMUM_USERNAME_CHARACTERS", "6");

//TOTAL MAXIMUM CHARACTERS IS 30
define("JAM_MAXIMUM_USERNAME_CHARACTERS", "12");

##################################
## SIGNUP FORM SESSION SETTINGS ##
##################################

//IF YOU WANT TO ENABLE SESSION HANDLING DURING THE SIGNUP PROCESS SET THIS TO true
define("JAM_ENABLE_SESSIONS_ON_SIGNUP", false);

#########################
## PAGINATION SETTINGS ##
#########################

define("JAM_DEFAULT_MAX_RESULTS", "25");
define("JAM_MEMBER_PROGRAM_LIST", "5");
define("JAM_MEMBER_MARKETING_TOOLS_LIST", "5");

#########################################
## CPM PAY-PER-LEAD AND CLICK SETTINGS ##
#########################################

//SET TO false TO REMOVE ANY CHECKING FOR BANNER IMPRESSIONS.
//ALL IMPRESSIONS WILL BE TRACKED REGARDLESS OF IP ADDRESS OR USER
define("JAM_CPM_UNIQUE", true);

//THIS IS THE INTERVAL IN HOURS BEFORE AN AFFILIATE GETS CREDIT FOR AN IMPRESSION FROM THE SAME IP ADDRESS
define("JAM_CPM_HOURS_APART", "24");

//SET THIS TO false IF YOU WANT TO DISABLE BANNER AD IMPRESSIONS
define("JAM_ENABLE_BANNER_AD_IMPRESSIONS", true);

//SET THIS TO false IF YOU WANT TO DISABLE TEXT AD IMPRESSIONS
define("JAM_ENABLE_TEXT_AD_IMPRESSIONS", true);

//SET THIS TO false IF YOU WANT TO DISABLE HOVER_AD IMPRESSIONS
define("JAM_ENABLE_HOVER_AD_IMPRESSIONS", true);

//SET THIS TO false IF YOU WANT TO DISABLE ARTICLE_AD IMPRESSIONS
define("JAM_ENABLE_ARTICLE_AD_IMPRESSIONS", true);

//SET THIS TO true TO ENABLE DELETION OF OLD IMPRESSIONS IN THE IMPRESSIONS TABLE
//ONLY PAID IMPRESSIONS WILL BE DELETED
define("JAM_ENABLE_DELETE_PAID_IMPRESSIONS", true);

//INTERVAL IN DAYS TO WAIT BEFORE PAID IMPRESSIONS ARE DELETED
define("JAM_DELETE_PAID_IMPRESSIONS_INTERVAL", "365");

//SET TO true TO USE PERCENTAGE COMMISSIONS FOR CLICKS
define("JAM_USE_PERCENTAGE_COMMS_CLICKS", false);

//THIS IS USED TO APPEND TO THE TRANSACTION ID FOR CPM COMMISSIONS
define("JAM_CPM_TRANS_ID", date('m-d-Y'));

//THIS IS USED TO APPEND TO THE TRANSACTION ID FOR PAY-PER-LEAD COMMISSIONS
define("JAM_LEAD_TRANS_ID", $_SERVER['REMOTE_ADDR']);

//THIS IS USED TO APPEND TO THE TRANSACTION ID FOR PAY-PER-CLICK COMMISSIONS
define("JAM_PPC_TRANS_ID", $_SERVER['REMOTE_ADDR']);

##########################
## PAGE REFRESH SETTING ##
##########################

//THIS IS THE NUMBER OF SECONDS A SUCCCESS PAGE WILL WAIT BEFORE REDIRECTING THE USER
define("JAM_SUCCESS_REFRESH_TIMER", "3");

############################
## CUSTOM MARKETING TOOLS ##
############################

//SET THIS TO true TO INCLUDE ANY CUSTOM MARKETING TOOLS THAT ARE IN THE plugins/tools FOLDER
define("JAM_ENABLE_CUSTOM_MARKETING_TOOLS", false);

##########################
## CUSTOM CONTENT PAGES ##
##########################

//SET THIS TO true TO SHOW ALL PAGES ON CONTENT DROPDOWN FOR UPGRADING
define("JAM_ENABLE_UPGRADE_CONTENT_PAGES", false);

//SET THIS TO true TO ADD ANY CUSTOM CONTENT PAGES TO THE CONTENT DROP DOWN MENU
define("JAM_ENABLE_CUSTOM_CONTENT_PAGES", false);

//IF YOU ENABLE THE JAM_ENABLE_CUSTOM_CONTENT_PAGES OPTION, ENTER THE PHYSICAL LOCATION HERE
define("JAM_CUSTOM_CONTENT_FOLDER", "/home/username/public_html/affiliates/members/pages");

//ENTER THE FULL URL PATH TO YOUR CUSTOM CONTENT PAGES FOR REDIRECTION
define("JAM_CUSTOM_CONTENT_URL", "http://www.yourdomain.com/affiliates/members/pages");

//PAGE EXTENSIONS TO STRIP OFF FROM FILE NAME, SEPARATED BY COMMAS AND ENCLOSED IN FORWARD SLASHES
define("JAM_CUSTOM_CONTENT_PAGE_EXTENSIONS", "/.html/,/.htm/,/.php/");

##########################
## FLASH GRAPH SETTINGS ##
##########################

//YOU CAN CHANGE THIS SETTTING TO 1, 2, 3. A SETTING OF 1 MORPHS THE FLASH GRAPH FROM 2D TO 3D, 2 STARTS IT AS A 2D, 3 SHOWS IT AS A 3D GRAPH
define("JAM_FLASH_3D_SETTING", "1");

//IF YOU DON'T WANT THE COLUMNS FOR THE FLASH GRAPHS TO BE ANIMATED, SET THIS TO 0 (ZERO)
define("JAM_ANIMATE_COLUMNS", "1");

############################
## PROGRAM IMAGE SETTINGS ##
############################

//SET THIS TO true TO USE FULL IMAGE PATHS FOR BANNER IMAGES INSTEAD OF DYNAMIC IMAGES
define("JAM_BANNER_FULL_IMAGE_PATHS", false);

//SET TO false IF YOU WANT TO STORE PROGRAM IMAGES IN A FOLDER INSTEAD OF THE DATABASE
define("JAM_PROGRAM_IMAGE_DB", true);

#######################
## SECURITY SETTINGS ##
#######################

//TIMER SETUP FOR ADMIN LOCKOUT
define("JAM_ADMIN_LOCKOUT_TIMER", "1"); //SET FOR 1 HOUR
define("JAM_ADMIN_LOCKOUT_TIMES", "5"); //MAX NUMBER OF FAILED LOGINS TO CHECK

//TIMER SETUP FOR ONE TIME OFFER PAGE
define("JAM_OTO_TIMER", "90"); //SET FOR 90 DAYS

#######################
## SALE.PHP SETTINGS ##
#######################

//IF YOU WANT MEMBERS TO GET COMMISSIONS ONLY WHEN THEY REFER THE PROGRAMS THEY ARE MEMBERS FOR, SET THIS TO true
define("JAM_MATCH_MEMBER_PROGRAM_ID", false);

#######################
## JROX.PHP SETTINGS ##
#######################

//IF YOU WANT TO USE A DIFFERENT FILE NAME FOR THE AFFILIATE LINK, YOU CAN EDIT IT HERE
//NOTE: YOU MUST EDIT IT IN YOUR .htaccess FILES AS WELL
define("JAM_AFFILIATE_LINK_FILE", "jrox");

################################################
## JAM AFFILIATES DIRECTORY PUBLISHING OPTION ##
################################################

//NOT YET IN USE DO NOT CHANGE
define("JAM_ENABLE_DIRECTORY_PUBLISHING", false);

##########################################
## DO NOT EDIT ANYTHING BELOW THIS LINE ##
##########################################

define("JAM_MEMORY_LIMIT", "20M");
define("JAM_SET_TIME_LIMIT", "60");

@set_magic_quotes_runtime(0);
?>

Now suppose we are using the following:

Domain: domain newgreenfarms.com.
Database: newgreenfarms_JAM
Database User: newgreenfarms_JAM
Database Password: O*Boy%21

Here is how the beginning of the file would look after some customizations.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44

//ENTER THE NAME OF THE DATABASE SERVER YOU ARE CONNECTING TO. NORMALLY SET TO "localhost"
define("JAM_DATABASE_SERVER", "localhost");

//ENTER THE NAME OF YOUR DATABASE
define("JAM_DATABASE_NAME", "newgreenfarms_JAM");

//ENTER THE USERNAME THAT CONNECTS TO YOUR DATABASE
define("JAM_DATABASE_USERNAME", "newgreenfarms_JAM");

//ENTER THE PASSWORD FOR YOUR DATABASE USER
define("JAM_DATABASE_PASSWORD", "O*Boy%21");

//ENTER THE PASSWORD FOR YOUR SCHEDULED CRON JOB
define("JAM_CRON_JOB_PASSWORD", "TheCronPassword");

//ENTER THE DOMAIN NAME OF YOUR WEBSITE
//EXAMPLE WOULD BE: jrox.com
//DO NOT INCLUDE ANY TRAILING SLASH OR HTTP://
//DO NOT INCLUDE THE SUBDOMAIN, SUCH AS www.
define("JAM_DOMAIN_NAME", "newgreenfarms");

//ENTER THE SUBDOMAIN FOR YOUR SITE
//EXAMPLE WOULD BE www
define("JAM_SUBDOMAIN_NAME", "www");

//THIS IS THE ENTIRE DOMAIN NAME FOR SETTING COOKIES.
//DO NOT INCLUDE ANY SUBDOMAIN, SUCH AS "www".
//AN EXAMPLE WOULD BE: jrox.com
define("COOKIE_DOMAIN", "newgreenfarms");

//ENTER THE ABSOLUTE PATH TO YOUR AFFILIATES DIRECTORY
//AN EXAMPLE WOULD BE: /home/username/public_html/affiliates
//DO NOT INCLUDE A TRAILING SLASH
define("HOME_BASE_DIRECTORY", "/home/newgreenfarms/public_html/affiliates");

//ENTER THE NAME OF YOUR AFFILIATE PROGRAM DIRECTORY
//DO NOT INCLUDE A TRAILING SLASH
define("HOME_BASE_AFFILIATE_DIRECTORY", "/affiliates");

//CONFIGURE NUMBER FORMATTING
//DEFINE HOW YOU WILL BE DISPLAYING YOUR COMMISSION VALUES
define("DECIMAL_SEPARATOR", ".");
define("THOUSANDS_SEPARATOR", ",");
define("DECIMAL_PLACES", 2);

Post Installation Checklist

http://jam.jrox.com/docs/index.php?article=6

Read the Blueprint

Don’t forget to read the affiliate blueprint included in the download: http://sammela.com/wp-content/uploads/2009/10/aff_blueprint.pdf

Reminders

Permissions 777 or World-writeable

Set the following to permission 777 or World-writeable:

/affiliates/includes/config.php
/affiliates/banners folder
backup folder