default
[ class tree: default ] [ index: default ] [ all elements ]

Class: Sps_Go

Source Location: /sps_go.php

Class Overview

Sps
   |
   --Sps_Table
      |
      --Sps_Go

Table of Go-Codes.


Methods


Inherited Methods


Class Details

[line 36]
Table of Go-Codes.

DOCUMENTATION FROM Perl-SPS; NEEDS UPDATING. GO is a framework for tracking newsletter clickthroughs. Here's how it works.

First, to use GO, you should be using the sps::plugin::newsletter module to auto-generate mailings.

In your configuration file, create a GO section, which will typically be quite simple, e.g.

 <GO>
 	GO_URL=http://my.server.name/sps/template/public/go.php
 </GO>
<p> Next, when generating your publications, instead of generating normal links, generate go-codes, e.g.
 	Here is my generated publication with a URL in it, as in
 		<SPS_GO PUBLICATION="newsletter"
 			ISSUE="June 2003"
 			NAME="Learn more about fish"
 			URL="http://wherever.org/fish.html">
This will be expanded by the newsletter filter, so users will see the following:
 	Here is my generated publication with a URL in it, as in
 		http://my.server.name/sps/template/public/go.php?c=kadf897ZXKJchLKSFDxczvk
The "go.cgi" will track each time a user clicks on that link.

Finally, include the sps::plugin::reports::go module, part of the core SPS report system, in your configuration. This will generate reports of clickthroughs sorted by publication, issue, and name.




[ Top ]


Class Methods


method conf [line 40]

void conf( )



Overrides Sps_Table::conf() (parent method not documented)

[ Top ]

method generate_id [line 118]

void generate_id( )

Override Sps_Table::generate_id() to generate suitable go-codes.



Overrides Sps_Table::generate_id() (Generate a new ID for this table. This calls Sps_Sequence::next_val() to generate the ID.)

[ Top ]

method get_record_name [line 89]

void get_record_name( Sps_Form &$form)



Overrides Sps_Table::get_record_name() (parent method not documented)

Parameters:

Sps_Form   &$form  

[ Top ]


Documentation generated on Mon, 23 Apr 2007 09:51:04 -0500 by phpDocumentor 1.3.0RC6