|
Data Generator - Parameter List
Below are detailed all of the parameters that can be used when setting up data
streams on your site. Note that all parameter names are CaSe sEnsiTive. The values
shown below are examples only and you will replace these with your own when you use
each parameter.
NB: We recommend that you include the code "$params = array();"
where-ever you call affCAFF parameters. This clears out any values that are already
stored from previous calls to affCAFF on the same page.
Mandatory Parameters (Generated automatically with the Data Generator)
$params[streamID] = "0000000000000"; Property ID
$params[template] = "template_name.inc"; Template name
Recommended Parameters
$params[maxitems] = "10"; Max. items to show in a stream
Optional Parameters (more detailed info)
$params[maxheadlinelen] = "50"; Max length of headlines
$params[maxdesclen] = "150"; Max length of descriptions
$params[imagewidth] = "100"; Width of images (Max. 200)
$params[imageheight] = "100"; Height of images (Max. 200)
$params[propertyintitle] = "Y"; Always show property name in title
$params[timeformat] = "d/m/y h:i:s"; Show item date in this format
$params[showsignupoffersonly] = "y"; Only show signup offers
$params[showpromotionsonly] = "y"; Only show promotions
$params[shownewsonly] = "y"; Only show news/general info
$params['filterwordstitle']="a, b"; Only show items with "a" or "b" in the title
$params['filterwordsdesc']="c, d"; Only show items with "c" or "d" in the description
$params[random] = "y"; Randomises the order of items with each page view
$params[outputformat] = "RSS"; RSS or XML output options (see templates)
$params[itemID] = "00000000"; Show ONLY a specific Item
...item ID's appear in the yellow box in the Data Generator when you select a property. The latest
stream is loaded and the item ID appears at the end of the description in grey text.
$mergeStreams[anyname] = "110000016"; Add an extra property
...note you can use the above multiple times, replacing "anyname" with any name you like to
help you remember each stream later, but remember to pass the extra parameters into the
"displayItems()" call, thus:
displayItems($params, $mergeStreams);
Advanced Parameters (For Experienced Webmasters) (more detailed info)
$params[overridelink] = "mypage.php"; Override default (aff) link with this URL
$params[appenditemID] = "y"; Append Item ID to the Override URL
$params[linkclass] = "myclass"; Override default link class with this
$params[dividprefix] = "anything"; Prefix div ID's (useful for javascript templates)
User-Defined Parameters (more detailed info)
$params[u_anything] = "anything"; User defined variable
Template Placeholders
The following placeholders can optionally be placed anywhere in your templates and will be
replaced with the relevant information every time an item is displayed:
{link} The affiliate link that you input
{title} The item headline
{link} The full text description
{hint} Optional hint when user hovers mouse over link
{class} Optional CSS class for the link
{target} Optional target browser for the link to open in
{id} Optional item ID display
{property} Optional property name display
Placeholders that require $params[...] calls (see above)
{time} Optional date/time placeholder
{itemDivID} Optional Item Div ID prefix
{linkID} Optional link ID prefix
{descDivID} Optional description ID prefix
{width} Optional image width
{height} Optional image height
...additionally the user defined parameters described in the
section above also require placeholders with the "u_" prefix, thus:
{u_anyname}
|
