GPTEngine logo

GPTEngine End User Documentation

<prev | up | next>

Snippets Reference

Conditional user content


if_logged_member


Usage: [?_if_logged_member_?]

Arguments: none

Return: the content between [?_if_logged_member_?] and [?_endif_logged_member_?] if member is logged in. Nothing otherwise.


Description:

Used in conjunction with [?_endif_logged_member_?] it will return the content between [?_if_logged_member_?] and [?_endif_logged_member_?] if member is logged in. If the member is not logged in nothing is returned.

Example:

[?_if_logged_member_?]You are logged in your member account.[?_endif_logged_member_?]



endif_logged_member


Usage: [?_endif_logged_member_?]

Arguments: none

Return: the content between [?_if_logged_member_?] and [?_endif_logged_member_?] if member is logged in. Nothing otherwise.


Description:

Used in conjunction with [?_if_logged_member_?] it will return the content between [?_if_logged_member_?] and [?_endif_logged_member_?] if member is logged in. If the member is not logged in nothing is returned.

Example:

[?_if_logged_member_?]You are logged in your member account.[?_endif_logged_member_?]



if_logged_advertiser


Usage: [?_if_logged_advertiser_?]

Arguments: none

Return: the content between [?_if_logged_advertiser_?] and [?_endif_logged_advertiser_?] if advertiser is logged in. Nothing otherwise.


Description:

Used in conjunction with [?_endif_logged_advertiser_?] it will return the content between [?_if_logged_advertiser_?] and [?_endif_logged_advertiser_?] if advertiser is logged in. If the advertiser is not logged in nothing is returned.

Example:

[?_if_logged_advertiser_?]You are logged in your advertiser account.[?_endif_logged_advertiser_?]



endif_logged_advertiser


Usage: [?_endif_logged_advertiser_?]

Arguments: none

Return: the content between [?_if_logged_advertiser_?] and [?_endif_logged_advertiser_?] if advertiser is logged in. Nothing otherwise.


Description:

Used in conjunction with [?_if_logged_advertiser_?] it will return the content between [?_if_logged_advertiser_?] and [?_endif_logged_advertiser_?] if advertiser is logged in. If the advertiser is not logged in nothing is returned.

Example:

[?_if_logged_advertiser_?]You are logged in your advertiser account.[?_endif_logged_advertiser_?]



if_not_logged


Usage: [?_if_not_logged_?]

Arguments: none

Return: the content between [?_if_not_logged_?] and [?_endif_not_logged_?] if user is not logged in either as member or advertiser. Nothing otherwise.


Description:

Used in conjunction with [?_endif_not_logged_?] it will return the content between [?_if_not_logged_?] and [?_endif_not_logged_?] if user is not logged in either as member or advertiser. If the user is logged in (as member or as an advertiser) nothing is returned.

Example:

[?_if_not_logged_?]You are not logged in.[?_endif_not_logged_?]



endif_not_logged


Usage: [?_endif_not_logged_?]

Arguments: none

Return: the content between [?_if_not_logged_?] and [?_endif_not_logged_?] if user is not logged in either as member or advertiser. Nothing otherwise.


Description:

Used in conjunction with [?_if_not_logged_?] it will return the content between [?_if_not_logged_?] and [?_endif_not_logged_?] if user is not logged in either as member or advertiser. If the user is logged in (as member or as an advertiser) nothing is returned.

Example:

[?_if_not_logged_?]You are not logged in.[?_endif_not_logged_?]



if_member_type


Usage: [?_if_member_type(arg1)_?]

Arguments: arg1: membership type

Return: the content between [?_if_member_type(arg1)_?] and [?_endif_member_type(arg1)_?] if member has the membership type indicated by arg1. Nothing otherwise.


Description:

Used in conjunction with [?_endif_member_type_?] it will return the content between [?_if_member_type(arg1)_?] and [?_endif_member_type(arg1)_?] if member has the membership indicated by arg1. Parse conditional membership must be checked in the page settings (CMS) in order to make this snippet work. If the member has another membership type nothing is returned.

Example:

[?_if_member_type(Premium)_?]You are a Premium Member[?_endif_member_type(Premium)_?]



endif_member_type


Usage: [?_endif_member_type(arg1)_?]

Arguments: arg1: membership type

Return: the content between [?_if_member_type(arg1)_?] and [?_endif_member_type(arg1)_?] if member has the membership type indicated by arg1. Nothing otherwise.


Description:

Used in conjunction with [?_if_member_type_?] it will return the content between [?_if_member_type(arg1)_?] and [?_endif_member_type(arg1)_?] if member has the membership indicated by arg1. Parse conditional membership must be checked in the page settings (CMS) in order to make this snippet work. If the member has another membership type nothing is returned.

Example:

[?_if_member_type(Premium)_?]You are a Premium Member[?_endif_member_type(Premium)_?]



HTTP functions


get_env


Usage: [?_get_env(arg1)_?]

Arguments: arg1: environment variable

Return: the value associated to the environment variable arg1.


Description:

get_env returns the value associated to the environment variable specified by arg1.

Example:

The IP address of the server for this URL is [?_get_env(SERVER_ADDR)_?]



get_value


Usage: [?_get_value(arg1)_?]

Arguments: arg1: HTTP POST or GET variable

Return: the value associated to the HTTP variable arg1.


Description:

get_value returns the value associated to the HTTP variable (POST or GET) specified by arg1.

Example:

For a page located at http://<yoursite>/mypage?x=abc, the snippet code

x=[?_get_value(x)_?]

will return

x=abc



get_cookie


Usage: [?_get_cookie(arg1)_?]

Arguments: arg1: cookie name

Return: the value associated to the HTTP cookie arg1.


Description:

get_cookie returns the value associated to the HTTP cookie named arg1.

Example:

If you set a cookie on the server side like

Set-Cookie: my_cookie=123456; path=/
the snippet code

Cookie value = [?_get_cookie(my_cookie)_?]

will return

Cookie value = 123456



User information


ip_address


Usage: [?_ip_address_?]

Arguments: none

Return: the IP address of the user.


Description:

ip_address returns the IP address of the user in decimal format.

Example:

Your IP address is: [?_ip_address_?]



user_agent


Usage: [?_user_agent_?]

Arguments: none

Return: the user agent (browser) of the user.


Description:

user_agent returns the browser of the user as provided by the browser software.

Example:

Your browser is: [?_user_agent_?]



country_name


Usage: [?_country_name_?]

Arguments: none

Return: the user's country name.


Description:

country_name returns the user's country based on the IP address.

Example:

Your country is: [?_country_name_?]



country_2digit_code


Usage: [?_country_2digit_code_?]

Arguments: none

Return: the user's country 2 digit code.


Description:

country_2digit_code returns the user's country 2 digit code based on the IP address.

Example:

Your country (2 digit code) is: [?_country_2digit_code_?]



country_3digit_code


Usage: [?_country_3digit_code_?]

Arguments: none

Return: the user's country 3 digit code.


Description:

country_3digit_code returns the user's country 3 digit code based on the IP address.

Example:

Your country (3 digit code) is: [?_country_3digit_code_?]



country_flag


Usage: [?_country_flag_?]

Arguments: none

Return: the user's country flag.


Description:

country_flag returns the user's country flag <img> element (around 20px x 16px) based on the IP address.

Example:

Your country flag is: [?_country_flag_?]



member


Usage: [?_member_?]

Arguments: none

Return: the member's username.


Description:

member returns the member's username (if logged in).

Example:

Your username is: [?_member_?]



member_id


Usage: [?_member_id_?]

Arguments: none

Return: the member's id.


Description:

member_id returns the member's id (if logged in).

Example:

Your member id: [?_member_id_?]



member_info


Usage: [?_member_info(arg1)_?]

Arguments: arg1: member information

Return: the member's information specified by arg1.


Description:

member_info returns the member's information specified by arg1 (if logged in).

Example:

Your email is: [?_member_info(Email)_?]

For a list of available members information go to Signup Options » Members information on the admin site.



member_country_flag


Usage: [?_member_country_flag?]

Arguments: none

Return: the member's country flag.


Description:

member_country_flag returns the member's country flag (around 20px x 16px) <img> element (if logged in).

Example:

Your country flag is: [?_member_country_flag?]



member_cash


Usage: [?_member_cash_?]

Arguments: none

Return: the member's current cash balance.


Description:

member_cash returns the member's current cash balance already formatted to the selected currency (if logged in).

Example:

Your cash balance is: [?_member_cash_?]



member_total_earnings


Usage: [?_member_total_earnings_?]

Arguments: none

Return: the member's total earnings since signup.


Description:

member_total_earnings returns the member's total earned cash since signup (if logged in).

Example:

Your total earnings since signup: [?_member_total_earnings_?]



member_minimum_payout


Usage: [?_member_minimum_payout?]

Arguments: none

Return: the minimum payout value the member may request.


Description:

member_minimum_payout returns the minimum payout value the member may request based on his/her membership settings (if logged in).

Example:

The minimum payout you may request is: [?_member_minimum_payout_?]



member_referral_link


Usage: [?_member_referral_link_?]

Arguments: none

Return: the member's referral link.


Description:

member_referral_link returns the member's link to refer other members under his/her account (if logged in).

Example:

Your referral link is: [?_member_referral_link_?]



member_upline


Usage: [?_member_upline(arg1)_?]

Arguments: arg1: upline level

Return: the member's upline referrer on the level arg1.


Description:

member_upline returns the member's upline referrer on the level specified by arg1 (if logged in).

Example:

Your referrer is: [?_member_upline(1)_?]



member_downline_commission_


Usage: [?_member_downline_commission(arg1)_?]

Arguments: arg1: downline level

Return: the member's downline commission for the level arg1.


Description:

member_downline_commission returns the member's downline commission (in %) for the level specified by arg1 based on his/her membership type settings (if logged in).

Example:

Your 3rd level downline commission is: [?_member_downline_commission(3)_?]



member_inbox_msg_count


Usage: [?_member_inbox_msg_count_?]

Arguments: none

Return: the number of unread messages in the member's inbox.


Description:

member_inbox_msg_count returns the number of unread messages in the member's inbox (if logged in).

Example:

You have [?_member_inbox_msg_count_?] unread messages in your inbox.



member_inbox_messages


Usage: [?_member_inbox_messages_?]

Arguments: none

Return: a JavaScript array containing the member's inbox messages data.


Description:

member_inbox_messages returns a JavaScript array containing the member's inbox messages data (if logged in).

For an example of usage, refer to code (HTML+JavaScript) of the member_inbox page on the CMS editor of your admin.



member_login_stats


Usage: [?_member_login_stats(arg1;arg2)_?]

Arguments: arg1: max number of records per page. arg2: stats content.

Return: the member's login stats.


Description:

member_login_stats returns the member's login statistics (if logged in). The content indicated by arg2 is parsed and concatenated over the number of records found.

arg2 comports the following variables:

%ID%: a counter number assigned to each record.
%DATE%: the time the login/logout event has occurred.
%EVENT%: returns login or logout.
%IP%: the member's IP address at the time of login/logout.
%BROWSER%: the member's browser at the time of login/logout.
%ODD%: returns Odd if it is an odd record (use it for table "zebra stripping").

The HTTP variable login_stats_page is used for pagination purposes.

For an example of usage, refer to the code (HTML+JavaScript) of the member_stats page on the CMS editor of your admin.



member_ptc_stats


Usage: [?_member_ptc_stats(arg1;arg2)_?]

Arguments: arg1: max number of records per page. arg2: stats content.

Return: the member's PTC campaigns stats.


Description:

member_ptc_stats returns the member's PTC campaigns statistics (if logged in). The content indicated by arg2 is parsed and concatenated over the number of records found.

arg2 comports the following variables:

%ID%: a counter number assigned to each record.
%DATE%: the time the PTC event has occurred.
%CAMPAIGN%: PTC campaign name.
%IP%: the member's IP address at the time of the PTC event.
%BROWSER%: the member's browser at the time of the PTC event.
%ODD%: returns Odd if it is an odd record (use it for table "zebra stripping").

The HTTP variable ptc_stats_page is used for pagination purposes.

For an example of usage, refer to the code (HTML+JavaScript) of the member_stats page on the CMS editor of your admin.



member_ptr_stats


Usage: [?_member_ptr_stats(arg1;arg2)_?]

Arguments: arg1: max number of records per page. arg2: stats content.

Return: the member's PTR campaigns stats.


Description:

member_ptr_stats returns the member's PTR campaigns statistics (if logged in). The content indicated by arg2 is parsed and concatenated over the number of records found.

arg2 comports the following variables:

%ID%: a counter number assigned to each record.
%DATE%: the time the PTR event has occurred.
%CAMPAIGN%: PTR campaign name.
%IP%: the member's IP address at the time of the PTR event.
%BROWSER%: the member's browser at the time of the PTR event.
%ODD%: returns Odd if it is an odd record (use it for table "zebra stripping").

The HTTP variable ptr_stats_page is used for pagination purposes.

For an example of usage, refer to the code (HTML+JavaScript) of the member_stats page on the CMS editor of your admin.



member_pts_stats


Usage: [?_member_pts_stats(arg1;arg2)_?]

Arguments: arg1: max number of records per page. arg2: stats content.

Return: the member's PTS campaigns stats.


Description:

member_pts_stats returns the member's PTS campaigns statistics (if logged in). The content indicated by arg2 is parsed and concatenated over the number of records found.

arg2 comports the following variables:

%ID%: a counter number assigned to each record.
%DATE%: the time the PTS event has occurred.
%CAMPAIGN%: PTS campaign name.
%IP%: the member's IP address at the time of the PTS event.
%BROWSER%: the member's browser at the time of the PTS event.
%ODD%: returns Odd if it is an odd record (use it for table "zebra stripping").

The HTTP variable pts_stats_page is used for pagination purposes.

For an example of usage, refer to the code (HTML+JavaScript) of the member_stats page on the CMS editor of your admin.



member_ptsu_stats


Usage: [?_member_ptsu_stats(arg1;arg2)_?]

Arguments: arg1: max number of records per page. arg2: stats content.

Return: the member's PTSU campaigns stats.


Description:

member_ptsu_stats returns the member's PTSU campaigns statistics (if logged in). The content indicated by arg2 is parsed and concatenated over the number of records found.

arg2 comports the following variables:

%ID%: a counter number assigned to each record.
%DATE%: the time the PTSU event has occurred.
%CAMPAIGN%: PTSU campaign name.
%STATUS%: will return confirmed, reversed or processing.
%IP%: the member's IP address at the time of the PTSU event.
%BROWSER%: the member's browser at the time of the PTSU event.
%ODD%: returns Odd if it is an odd record (use it for table "zebra stripping").

The HTTP variable ptsu_stats_page is used for pagination purposes.

For an example of usage, refer to the code (HTML+JavaScript) of the member_stats page on the CMS editor of your admin.



member_ptrv_stats


Usage: [?_member_ptrv_stats(arg1;arg2)_?]

Arguments: arg1: max number of records per page. arg2: stats content.

Return: the member's PTRV campaigns stats.


Description:

member_ptrv_stats returns the member's PTRV campaigns statistics (if logged in). The content indicated by arg2 is parsed and concatenated over the number of records found.

arg2 comports the following variables:

%ID%: a counter number assigned to each record.
%DATE%: the time the PTRV event has occurred.
%CAMPAIGN%: PTRV campaign name.
%STATUS%: will return confirmed, reversed or processing.
%IP%: the member's IP address at the time of the PTRV event.
%BROWSER%: the member's browser at the time of the PTRV event.
%ODD%: returns Odd if it is an odd record (use it for table "zebra stripping").

The HTTP variable ptrv_stats_page is used for pagination purposes.

For an example of usage, refer to the code (HTML+JavaScript) of the member_stats page on the CMS editor of your admin.



member_ptts_stats


Usage: [?_member_ptts_stats(arg1;arg2)_?]

Arguments: arg1: max number of records per page. arg2: stats content.

Return: the member's PTTS campaigns stats.


Description:

member_ptts_stats returns the member's PTTS campaigns statistics (if logged in). The content indicated by arg2 is parsed and concatenated over the number of records found.

arg2 comports the following variables:

%ID%: a counter number assigned to each record.
%DATE%: the time the PTTS event has occurred.
%CAMPAIGN%: PTTS campaign name.
%STATUS%: will return confirmed, reversed or processing.
%IP%: the member's IP address at the time of the PTTS event.
%BROWSER%: the member's browser at the time of the PTTS event.
%ODD%: returns Odd if it is an odd record (use it for table "zebra stripping").

The HTTP variable ptts_stats_page is used for pagination purposes.

For an example of usage, refer to the code (HTML+JavaScript) of the member_stats page on the CMS editor of your admin.



member_ptco_stats


Usage: [?_member_ptco_stats(arg1;arg2)_?]

Arguments: arg1: max number of records per page. arg2: stats content.

Return: the member's PTCO campaigns stats.


Description:

member_ptco_stats returns the member's PTCO campaigns statistics (if logged in). The content indicated by arg2 is parsed and concatenated over the number of records found.

arg2 comports the following variables:

%ID%: a counter number assigned to each record.
%DATE%: the time the PTCO event has occurred.
%CAMPAIGN%: PTCO campaign name.
%STATUS%: will return confirmed, reversed or processing.
%IP%: the member's IP address at the time of the PTCO event.
%BROWSER%: the member's browser at the time of the PTCO event.
%ODD%: returns Odd if it is an odd record (use it for table "zebra stripping").

The HTTP variable ptco_stats_page is used for pagination purposes.

For an example of usage, refer to the code (HTML+JavaScript) of the member_stats page on the CMS editor of your admin.



member_ptp_stats


Usage: [?_member_ptp_stats(arg1;arg2)_?]

Arguments: arg1: max number of records per page. arg2: stats content.

Return: the member's PTP campaigns stats.


Description:

member_ptp_stats returns the member's PTP campaigns statistics (if logged in). The content indicated by arg2 is parsed and concatenated over the number of records found.

arg2 comports the following variables:

%ID%: a counter number assigned to each record.
%DATE%: the time the PTP event has occurred.
%CAMPAIGN%: PTP campaign name.
%SUBID%: subid associated to the PTP campaign.
%IP%: the IP address of the user at the time of the PTP event.
%COUNTRY%: the country of the user at the time of the PTP event.
%BROWSER%: the browser of the user at the time of the PTP event.
%LANG%: the browser language of the user at the time of the PTP event.
%KEYWORD%: the keyword(s) associated to the PTP campaign.
%ODD%: returns Odd if it is an odd record (use it for table "zebra stripping").

The HTTP variable ptp_stats_page is used for pagination purposes.

For an example of usage, refer to the code (HTML+JavaScript) of the member_stats page on the CMS editor of your admin.



member_ptp_subid_stats


Usage: [?_member_ptp_subid_stats(arg1)_?]

Arguments: arg1: stats content.

Return: the member's PTP campaigns stats for each subid.


Description:

member_ptp_subid_stats returns the member's PTP campaigns statistics for each subid (if logged in). The content indicated by arg1 is parsed and concatenated over the number of records found.

arg1 comports the following variables:

%SUBID%: a counter number assigned to each record.
%IMPRESS%: number of PTP impressions for each subid.
%CLICKS%: number of PTP clicks for each subid.
%CTR%: click through rate (%) for each subid.
%ODD%: returns Odd if it is an odd record (use it for table "zebra stripping").

For an example of usage, refer to the code (HTML+JavaScript) of the member_stats page on the CMS editor of your admin.



member_ptx_stats


Usage: [?_member_ptx_stats(arg1;arg2)_?]

Arguments: arg1: max number of records per page. arg2: stats content.

Return: the member's PTX campaigns stats.


Description:

member_ptx_stats returns the member's PTX campaigns statistics (if logged in). The content indicated by arg2 is parsed and concatenated over the number of records found.

arg2 comports the following variables:

%ID%: a counter number assigned to each record.
%DATE%: the time the PTX event has occurred.
%CAMPAIGN%: PTX campaign name.
%STATUS%: will return confirmed, reversed or processing.
%IP%: the member's IP address at the time of the PTX event.
%BROWSER%: the member's browser at the time of the PTX event.
%ODD%: returns Odd if it is an odd record (use it for table "zebra stripping").

The HTTP variable ptx_stats_page is used for pagination purposes.

For an example of usage, refer to the code (HTML+JavaScript) of the member_stats page on the CMS editor of your admin.



member_credit_stats


Usage: [?_member_credit_stats(arg1;arg2)_?]

Arguments: arg1: max number of records per page. arg2: stats content.

Return: the member's credit/debit stats.


Description:

member_credit_stats returns the member's credit/debit statistics (if logged in). The content indicated by arg2 is parsed and concatenated over the number of records found.

arg2 comports the following variables:

%ID%: a counter number assigned to each record.
%DATE%: the time the debit/credit event has occurred.
%EVENT%: returns credit or debit.
%VALUE%: the credited or debited value.
%TYPE%: returns cash or points.
%DESCRIPTION%: credit/debit description.
%ODD%: returns Odd if it is an odd record (use it for table "zebra stripping").

The HTTP variable credit_stats_page is used for pagination purposes.

For an example of usage, refer to the code (HTML+JavaScript) of the member_earnings page on the CMS editor of your admin.



member_payout_stats


Usage: [?_member_payout_stats(arg1;arg2)_?]

Arguments: arg1: max number of records per page. arg2: stats content.

Return: the member's requested payouts stats.


Description:

member_payout_stats returns the member's requested payouts statistics (if logged in). The content indicated by arg2 is parsed and concatenated over the number of records found.

arg2 comports the following variables:

%ID%: a counter number assigned to each record.
%DATE%: the time the payout requesting event has occurred.
%VALUE%: the value of the requested payout.
%METHOD%: the payout method chosen by the member.
%STATUS%: returns pending, processing, confirmed or rejected.
%ODD%: returns Odd if it is an odd record (use it for table "zebra stripping").

The HTTP variable payout_stats_page is used for pagination purposes.

For an example of usage, refer to the code (HTML+JavaScript) of the member_earnings page on the CMS editor of your admin.



member_payout_methods


Usage: [?_member_payout_methods(arg1)_?]

Arguments: arg1: stats content.

Return: the member's available payout methods.


Description:

member_payout_methods returns the member's available payout methods (if logged in). The content indicated by arg1 is parsed and concatenated over the number of records found.

arg1 comports the following variable:

%METHOD%: the payment method available.

For an example of usage, refer to the code (HTML+JavaScript) of the member_earnings page on the CMS editor of your admin.



member_downline


Usage: [?_member_downline(arg1;arg2;arg3)_?]

Arguments: arg1: downline level. arg2: max number of records per page. arg3: stats content.

Return: the member's downline.


Description:

member_downline returns the member's downline for a given level (arg1) (if logged in). The content indicated by arg3 is parsed and concatenated over the number of records found.

arg3 comports the following variables:

%ID%: a counter number assigned to each record.
%MEMBERID%: referee's id.
%USERNAME%: referee's username.
%TYPE%: referee's membership type.
%SIGNUP%: referee's signup time.
%STATUS%: referee's account status.
%ODD%: returns Odd if it is an odd record (use it for table "zebra stripping").

The HTTP variable downline_level_<level>_stats_page is used for pagination purposes.

For an example of usage, refer to the code (HTML+JavaScript) of the member_downline page on the CMS editor of your admin.



ptc_count


Usage: [?_ptc_count_?]

Arguments: none.

Return: the number of member's available PTC campaigns.


Description:

ptc_count returns the number of member's available PTC campaigns (if logged in).

Example:

You have [?_ptc_count_?] PTC ads waiting for your click.



ptr_count


Usage: [?_ptr_count_?]

Arguments: none.

Return: the number of member's available PTR campaigns.


Description:

ptr_count returns the number of member's available PTR campaigns (if logged in).

Example:

You have [?_ptr_count_?] PTR ads for you.



pts_count


Usage: [?_pts_count_?]

Arguments: none.

Return: the number of member's available PTS campaigns.


Description:

pts_count returns the number of member's available PTS campaigns (if logged in).

Example:

You have [?_pts_count_?] PTS sites to visit.



ptsu_count


Usage: [?_ptsu_count_?]

Arguments: none.

Return: the number of member's available PTSU campaigns.


Description:

ptc_count returns the number of member's available PTSU campaigns (if logged in).

Example:

You have [?_ptsu_count_?] PTSU campaigns for you.



ptrv_count


Usage: [?_ptrv_count_?]

Arguments: none.

Return: the number of member's available PTRV campaigns.


Description:

ptrv_count returns the number of member's available PTRV campaigns (if logged in).

Example:

You have [?_ptrv_count_?] PTRV campaigns for you.



ptts_count


Usage: [?_ptts_count_?]

Arguments: none.

Return: the number of member's available PTTS campaigns.


Description:

ptts_count returns the number of member's available PTTS campaigns (if logged in).

Example:

You have [?_ptts_count_?] PTTS campaigns for you.



ptco_count


Usage: [?_ptco_count_?]

Arguments: none.

Return: the number of member's available PTCO campaigns.


Description:

ptco_count returns the number of member's available PTCO campaigns (if logged in).

Example:

You have [?_ptco_count_?] PTCO campaigns for you.



ptp_count


Usage: [?_ptp_count_?]

Arguments: none.

Return: the number of member's available PTP campaigns.


Description:

ptp_count returns the number of member's available PTP campaigns (if logged in).

Example:

You have [?_ptp_count_?] PTP campaigns for your site.



ptx_count


Usage: [?_ptx_count_?]

Arguments: none.

Return: the number of member's available PTX campaigns.


Description:

ptx_count returns the number of member's available PTX campaigns (if logged in).

Example:

You have [?_ptx_count_?] PTX campaigns for you.



ptp_link_base


Usage: [?_ptp_link_base_?]

Arguments: none.

Return: the member's PTP link.


Description:

ptp_link_base returns the member's PTP link base used to generate PTP code (if logged in).

For an example of usage, refer to the code (HTML+JavaScript) of the member_ptp page on the CMS editor of your admin.



list_ptc


Usage: [?_list_ptc(arg1;arg2;arg3)_?]

Arguments: arg1: ad type (LINK, BANNER or HTML). arg2: number of columns. arg3: PTC list content.

Return: the member's available PTC campaigns.


Description:

list_ptc returns the member's available PTC campaigns to click (if logged in).

The content indicated by arg3 is parsed and concatenated over the number of records found.

arg3 comports the following variables:

%ID%: the campaign id.
%NAME%: the campaign name.
%DESCRIPTION%: the campaign description.
%ADVERTISER%: the campaign advertiser.
%AD_LINK%: the campaign link.
%WIDTH%: banner width.
%HEIGHT%: banner height.
%ALT_TEXT%: banner alternative text.
%VALUE%: campaign value.
%VALUE_TYPE%: returns cash or points.

For an example of usage, refer to the code (HTML+JavaScript) of the member_ptc page on the CMS editor of your admin.



list_ptsu


Usage: [?_list_ptsu(arg1;arg2)_?]

Arguments: arg1: content to be displayed if no campaign is available. arg2: content.

Return: the member's available PTSU campaigns.


Description:

list_ptsu returns the member's available PTSU campaigns (if logged in). The content indicated by arg2 is parsed and concatenated over the number of records found.

arg2 comports the following variables:

%ID%: the campaign id.
%NAME%: the campaign name.
%DESCRIPTION%: the campaign description.
%ADVERTISER%: the campaign advertiser.
%AD_LINK%: the campaign link.
%VALUE%: campaign value.
%VALUE_TYPE%: returns cash or points.
%ODD%: returns Odd if it is an odd record (use it for table "zebra stripping").

For an example of usage, refer to the code (HTML+JavaScript) of the member_ptsu page on the CMS editor of your admin.



list_ptrv


Usage: [?_list_ptrv(arg1;arg2)_?]

Arguments: arg1: content to be displayed if no campaign is available. arg2: content.

Return: the member's available PTRV campaigns.


Description:

list_ptrv returns the member's available PTRV campaigns (if logged in). The content indicated by arg2 is parsed and concatenated over the number of records found.

arg2 comports the following variables:

%ID%: the campaign id.
%NAME%: the campaign name.
%DESCRIPTION%: the campaign description.
%ADVERTISER%: the campaign advertiser.
%AD_LINK%: the campaign link.
%VALUE%: campaign value.
%VALUE_TYPE%: returns cash or points.
%ODD%: returns Odd if it is an odd record (use it for table "zebra stripping").

For an example of usage, refer to the code (HTML+JavaScript) of the member_ptrv page on the CMS editor of your admin.



list_ptts


Usage: [?_list_ptts(arg1;arg2)_?]

Arguments: arg1: content to be displayed if no campaign is available. arg2: content.

Return: the member's available PTTS campaigns.


Description:

list_ptts returns the member's available PTTS campaigns (if logged in). The content indicated by arg2 is parsed and concatenated over the number of records found.

arg2 comports the following variables:

%ID%: the campaign id.
%NAME%: the campaign name.
%DESCRIPTION%: the campaign description.
%ADVERTISER%: the campaign advertiser.
%AD_LINK%: the campaign link.
%VALUE%: campaign value.
%VALUE_TYPE%: returns cash or points.
%ODD%: returns Odd if it is an odd record (use it for table "zebra stripping").

For an example of usage, refer to the code (HTML+JavaScript) of the member_ptts page on the CMS editor of your admin.



list_ptco


Usage: [?_list_ptco(arg1;arg2)_?]

Arguments: arg1: content to be displayed if no campaign is available. arg2: content.

Return: the member's available PTCO campaigns.


Description:

list_ptco returns the member's available PTCO campaigns (if logged in). The content indicated by arg2 is parsed and concatenated over the number of records found.

arg2 comports the following variables:

%ID%: the campaign id.
%NAME%: the campaign name.
%DESCRIPTION%: the campaign description.
%ADVERTISER%: the campaign advertiser.
%AD_LINK%: the campaign link.
%VALUE%: campaign value.
%VALUE_TYPE%: returns cash or points.
%ODD%: returns Odd if it is an odd record (use it for table "zebra stripping").

For an example of usage, refer to the code (HTML+JavaScript) of the member_ptco page on the CMS editor of your admin.



list_ptx


Usage: [?_list_ptx(arg1;arg2;arg3)_?]

Arguments: arg1: content to be displayed if no campaign is available. arg2: content. arg3: the category to which the listed PTX campaigns belong.

Return: the member's available PTX campaigns.


Description:

list_ptx returns the member's available PTX campaigns (if logged in). The content indicated by arg2 is parsed and concatenated over the number of records found.

arg2 comports the following variables:

%ID%: the campaign id.
%NAME%: the campaign name.
%DESCRIPTION%: the campaign description.
%ADVERTISER%: the campaign advertiser.
%AD_LINK%: the campaign link.
%VALUE%: campaign value.
%VALUE_TYPE%: returns cash or points.
%ODD%: returns Odd if it is an odd record (use it for table "zebra stripping").

arg3 can be used to only get PTX campaigns that belong to a given category listed.

For an example of usage, refer to the code (HTML+JavaScript) of the member_ptsu page on the CMS editor of your admin (as the list_ptsu function is similar to list_ptx).



set_max_pagination


Usage: [?_set_max_pagination(arg1)_?]

Arguments: arg1: the maximum number of GPT listings per page.

Return: nothing.


Description:

set_max_pagination sets the maximum number of GPT campaigns that functions like list_ptsu, list_ptrv, list_ptts, list_ptco and list_ptx can list per page. Use this function to implement a pagination system for your GPT lists.

For an example of usage, refer to the code (HTML+JavaScript) of pages like member_ptsu on the CMS editor of your admin.



set_pagination_order


Usage: [?_set_pagination_order(arg1;arg2)_?]

Arguments: arg1: the SQL column for sorting/ordering GPT lists. arg2: the ordering flow (ascending or descending).

Return: nothing.


Description:

set_pagination_order sets how GPT campaigns are sorted for listing functions like list_ptsu. By default, GPT is ordered by Id. For other sorting possibilities, refer to the SQL table structure of GPT type in interest (for example, GPTE_PTSU_Campaigns). Use this function to implement a pagination system for your GPT lists.

arg1 is the sorting SQL column, ex: Id, Ad_Value, Point_Value, etc.

arg2 sets the ordering flow. The only values allowed are ASC and DESC.

For an example of usage, refer to the code (HTML+JavaScript) of pages like member_ptsu on the CMS editor of your admin.



gpt_pagination_current


Usage: [?_gpt_pagination_current_?]

Arguments: none.

Return: the current page in the GPT listing pagination.


Description:

gpt_pagination_current returns the current page in the GPT listing pagination. Pagination pages are selected by sending the page number through the HTTP variable p.
Use this function to implement a pagination system for your GPT lists.

For an example of usage, refer to the code (HTML+JavaScript) of pages like member_ptsu on the CMS editor of your admin.



gpt_pagination_previous


Usage: [?_gpt_pagination_previous_?]

Arguments: none.

Return: the previous page in the GPT listing pagination.


Description:

gpt_pagination_previous returns the previous page in the GPT listing pagination. Pagination pages are selected by sending the page number through the HTTP variable p.
Use this function to implement a pagination system for your GPT lists.

For an example of usage, refer to the code (HTML+JavaScript) of pages like member_ptsu on the CMS editor of your admin.



gpt_pagination_next


Usage: [?_gpt_pagination_next_?]

Arguments: none.

Return: the next page in the GPT listing pagination.


Description:

gpt_pagination_next returns the next page in the GPT listing pagination. Pagination pages are selected by sending the page number through the HTTP variable p.
Use this function to implement a pagination system for your GPT lists.

For an example of usage, refer to the code (HTML+JavaScript) of pages like member_ptsu on the CMS editor of your admin.



gpt_pagination_has_next


Usage: [?_gpt_pagination_has_next_?]

Arguments: none.

Return: 1 if there's at least one more page for the GPT listing pagination.


Description:

gpt_pagination_has_next returns 1 if there's at least one more page for the GPT listing pagination. 0 is returned otherwise. Pagination pages are selected by sending he page number through the HTTP variable p.
Use this function to implement a pagination system for your GPT lists.

For an example of usage, refer to the code (HTML+JavaScript) of pages like member_ptsu on the CMS editor of your admin.



advertiser


Usage: [?_advertiser_?]

Arguments: none.

Return: the advertiser's username.


Description:

advertiser returns the advertiser's username (if logged in).

Example:

Welcome advertiser, your username is [?_advertiser_?].



advertiser_id


Usage: [?_advertiser_id_?]

Arguments: none.

Return: the advertiser's id.


Description:

advertiser_id returns the advertiser's id (if logged in).

Example:

Welcome advertiser, your id is [?_advertiser_id_?].



advertiser_info


Usage: [?_advertiser_info(arg1)_?]

Arguments: arg1: information to retrieve.

Return: the advertiser's information specified by arg1.


Description:

advertiser_info returns the advertiser's information specified by arg1 (if logged in).

Example:

Welcome advertiser, your email is [?_advertiser_info(Email)_?].

For a list of available advertisers information go to Signup Options » Advertisers information on the admin site.



advertiser_country_flag


Usage: [?_advertiser_country_flag?]

Arguments: none

Return: the advertiser's country flag.


Description:

advertiser_country_flag returns the advertiser's country flag (around 20px x 16px) <img> element (if logged in).

Example:

Welcome advertiser, your country flag is: [?_advertiser_country_flag?]



advertiser_cash


Usage: [?_advertiser_cash_?]

Arguments: none

Return: the advertiser's current cash balance.


Description:

advertiser_cash returns the advertiser's current cash balance (in discounts) already formatted to the selected currency (if logged in).

Example:

Welcome advertiser, your cash balance is: [?_advertiser_cash_?]



advertiser_inbox_msg_count


Usage: [?_advertiser_inbox_msg_count_?]

Arguments: none

Return: the number of unread messages in the advertiser's inbox.


Description:

advertiser_inbox_msg_count returns the number of unread messages in the advertiser's inbox (if logged in).

Example:

Welcome advertiser, you have [?_advertiser_inbox_msg_count_?] unread messages in your inbox.



advertiser_inbox_messages


Usage: [?_advertiser_inbox_messages_?]

Arguments: none

Return: a JavaScript array containing the advertiser's inbox messages data.


Description:

advertiser_inbox_messages returns a JavaScript array containing the advertiser's inbox messages data (if logged in).

For an example of usage, refer to code (HTML+JavaScript) of the advertiser_inbox page on the CMS editor of your admin.



advertiser_credit_stats


Usage: [?_advertiser_credit_stats(arg1;arg2)_?]

Arguments: arg1: max number of records per page. arg2: stats content.

Return: the advertiser's credit/debit stats.


Description:

advertiser_credit_stats returns the advertiser's credit/debit statistics (if logged in). The content indicated by arg2 is parsed and concatenated over the number of records found.

arg2 comports the following variables:

%ID%: a counter number assigned to each record.
%DATE%: the time the debit/credit event has occurred.
%EVENT%: returns credit or debit.
%VALUE%: the credited or debited value.
%DESCRIPTION%: credit/debit description.
%ODD%: returns Odd if it is an odd record (use it for table "zebra stripping").

The HTTP variable credit_stats_page is used for pagination purposes.

For an example of usage, refer to the code (HTML+JavaScript) of the advertiser_cash page on the CMS editor of your admin.



advertiser_ptc_campaigns


Usage: [?_advertiser_ptc_campaigns(arg1)_?]

Arguments: arg1: stats content.

Return: a list of advertiser's PTC campaigns.


Description:

advertiser_ptc_campaigns returns a list of the advertiser's PTC campaigns (if logged in). The content indicated by arg1 is parsed and concatenated over the number of records found.

arg1 comports the following variables:

%ID%: a counter number assigned to each record.
%NAME%: campaign name.
%DESCRIPTION%: campaign description.
%STATUS%: campaign status.
%VALIDITY_START%: campaign beginning time.
%VALIDITY_END%: campaign ending time.
%IMPRESSIONS%: number of PTC impressions.
%CLICKS%: number of PTC clicks.
%AD_VALUE%: value paid to members on completion.
%AD_VALUE_TYPE%: returns cash or points.
%TOTAL_CASH%: total cash paid to members.
%TOTAL_POINTS%: total points paid to members.
%MAX_IMPRESSIONS%: max number of impressions before expiration.
%MAX_CLICKS%: max number of clicks before expiration.
%PACKAGE%: ad package name.

For an example of usage, refer to the code (HTML+JavaScript) of the advertiser_campaigns page on the CMS editor of your admin.



advertiser_ptr_campaigns


Usage: [?_advertiser_ptr_campaigns(arg1)_?]

Arguments: arg1: stats content.

Return: a list of advertiser's PTR campaigns.


Description:

advertiser_ptr_campaigns returns a list of the advertiser's PTR campaigns (if logged in). The content indicated by arg1 is parsed and concatenated over the number of records found.

arg1 comports the following variables:

%ID%: a counter number assigned to each record.
%NAME%: campaign name.
%DESCRIPTION%: campaign description.
%STATUS%: campaign status.
%VALIDITY_START%: campaign beginning time.
%VALIDITY_END%: campaign ending time.
%EMAILS_SENT%: number of PTR emails sent.
%CLICKS%: number of PTR clicks.
%AD_VALUE%: value paid to members on completion.
%AD_VALUE_TYPE%: returns cash or points.
%TOTAL_CASH%: total cash paid to members.
%TOTAL_POINTS%: total points paid to members.
%MAX_EMAILS_SENT%: max number of sent emails before expiration.
%MAX_CLICKS%: max number of clicks before expiration.
%PACKAGE%: ad package name.

For an example of usage, refer to the code (HTML+JavaScript) of the advertiser_campaigns page on the CMS editor of your admin.



advertiser_pts_campaigns


Usage: [?_advertiser_pts_campaigns(arg1)_?]

Arguments: arg1: stats content.

Return: a list of advertiser's PTS campaigns.


Description:

advertiser_pts_campaigns returns a list of the advertiser's PTS campaigns (if logged in). The content indicated by arg1 is parsed and concatenated over the number of records found.

arg1 comports the following variables:

%ID%: a counter number assigned to each record.
%NAME%: campaign name.
%DESCRIPTION%: campaign description.
%STATUS%: campaign status.
%VALIDITY_START%: campaign beginning time.
%VALIDITY_END%: campaign ending time.
%VISITS%: number of PTS visits.
%AD_VALUE%: value paid to members on completion.
%AD_VALUE_TYPE%: returns cash or points.
%TOTAL_CASH%: total cash paid to members.
%TOTAL_POINTS%: total points paid to members.
%MAX_VISITS%: max number of visits before expiration.
%PACKAGE%: ad package name.

For an example of usage, refer to the code (HTML+JavaScript) of the advertiser_campaigns page on the CMS editor of your admin.



advertiser_ptsu_campaigns


Usage: [?_advertiser_ptsu_campaigns(arg1)_?]

Arguments: arg1: stats content.

Return: a list of advertiser's PTSU campaigns.


Description:

advertiser_ptsu_campaigns returns a list of the advertiser's PTSU campaigns (if logged in). The content indicated by arg1 is parsed and concatenated over the number of records found.

arg1 comports the following variables:

%ID%: a counter number assigned to each record.
%NAME%: campaign name.
%DESCRIPTION%: campaign description.
%STATUS%: campaign status.
%VALIDITY_START%: campaign beginning time.
%VALIDITY_END%: campaign ending time.
%REDIRECTIONS%: number of members redirected to the target URL.
%SIGNUPS%: number of completed signups.
%AD_VALUE%: value paid to members on completion.
%AD_VALUE_TYPE%: returns cash or points.
%TOTAL_CASH%: total cash paid to members.
%TOTAL_POINTS%: total points paid to members.
%MAX_SIGNUPS%: max number of completed signups before expiration.
%PACKAGE%: ad package name.

For an example of usage, refer to the code (HTML+JavaScript) of the advertiser_campaigns page on the CMS editor of your admin.



advertiser_ptrv_campaigns


Usage: [?_advertiser_ptrv_campaigns(arg1)_?]

Arguments: arg1: stats content.

Return: a list of advertiser's PTRV campaigns.


Description:

advertiser_ptrv_campaigns returns a list of the advertiser's PTRV campaigns (if logged in). The content indicated by arg1 is parsed and concatenated over the number of records found.

arg1 comports the following variables:

%ID%: a counter number assigned to each record.
%NAME%: campaign name.
%DESCRIPTION%: campaign description.
%STATUS%: campaign status.
%VALIDITY_START%: campaign beginning time.
%VALIDITY_END%: campaign ending time.
%REDIRECTIONS%: number of members redirected to the target URL.
%REVIEWS%: number of completed reviews.
%AD_VALUE%: value paid to members on completion.
%AD_VALUE_TYPE%: returns cash or points.
%TOTAL_CASH%: total cash paid to members.
%TOTAL_POINTS%: total points paid to members.
%MAX_REVIEWS%: max number of completed reviews before expiration.
%PACKAGE%: ad package name.

For an example of usage, refer to the code (HTML+JavaScript) of the advertiser_campaigns page on the CMS editor of your admin.



advertiser_ptts_campaigns


Usage: [?_advertiser_ptts_campaigns(arg1)_?]

Arguments: arg1: stats content.

Return: a list of advertiser's PTTS campaigns.


Description:

advertiser_ptts_campaigns returns a list of the advertiser's PTTS campaigns (if logged in). The content indicated by arg1 is parsed and concatenated over the number of records found.

arg1 comports the following variables:

%ID%: a counter number assigned to each record.
%NAME%: campaign name.
%DESCRIPTION%: campaign description.
%STATUS%: campaign status.
%VALIDITY_START%: campaign beginning time.
%VALIDITY_END%: campaign ending time.
%REDIRECTIONS%: number of members redirected to the target URL.
%SURVEYS%: number of completed surveys.
%AD_VALUE%: value paid to members on completion.
%AD_VALUE_TYPE%: returns cash or points.
%TOTAL_CASH%: total cash paid to members.
%TOTAL_POINTS%: total points paid to members.
%MAX_SURVEYS%: max number of completed surveys before expiration.
%PACKAGE%: ad package name.

For an example of usage, refer to the code (HTML+JavaScript) of the advertiser_campaigns page on the CMS editor of your admin.



advertiser_ptco_campaigns


Usage: [?_advertiser_ptco_campaigns(arg1)_?]

Arguments: arg1: stats content.

Return: a list of advertiser's PTCO campaigns.


Description:

advertiser_ptco_campaigns returns a list of the advertiser's PTCO campaigns (if logged in). The content indicated by arg1 is parsed and concatenated over the number of records found.

arg1 comports the following variables:

%ID%: a counter number assigned to each record.
%NAME%: campaign name.
%DESCRIPTION%: campaign description.
%STATUS%: campaign status.
%VALIDITY_START%: campaign beginning time.
%VALIDITY_END%: campaign ending time.
%REDIRECTIONS%: number of members redirected to the target URL.
%OFFERS%: number of completed offers.
%AD_VALUE%: value paid to members on completion.
%AD_VALUE_TYPE%: returns cash or points.
%TOTAL_CASH%: total cash paid to members.
%TOTAL_POINTS%: total points paid to members.
%MAX_OFFERS%: max number of completed offers before expiration.
%PACKAGE%: ad package name.

For an example of usage, refer to the code (HTML+JavaScript) of the advertiser_campaigns page on the CMS editor of your admin.



advertiser_ptp_campaigns


Usage: [?_advertiser_ptp_campaigns(arg1)_?]

Arguments: arg1: stats content.

Return: a list of advertiser's PTP campaigns.


Description:

advertiser_ptp_campaigns returns a list of the advertiser's PTP campaigns (if logged in). The content indicated by arg1 is parsed and concatenated over the number of records found.

arg1 comports the following variables:

%ID%: a counter number assigned to each record.
%NAME%: campaign name.
%DESCRIPTION%: campaign description.
%STATUS%: campaign status.
%VALIDITY_START%: campaign beginning time.
%VALIDITY_END%: campaign ending time.
%IMPRESSIONS%: number of PTP impressions.
%CLICKS%: number of PTP clicks.
%AD_VALUE%: value paid to members on completion.
%AD_VALUE_TYPE%: returns cash or points.
%TOTAL_CASH%: total cash paid to members.
%TOTAL_POINTS%: total points paid to members.
%MAX_IMPRESSIONS%: max number of PTP impressions before expiration.
%MAX_CLICKS%: max number of PTP clicks before expiration.
%AD_TYPE%: returns text, image or link.
%AD_IMG_FORMAT%: ad format (for image PTP campaigns).
%PACKAGE%: ad package name.

For an example of usage, refer to the code (HTML+JavaScript) of the advertiser_campaigns page on the CMS editor of your admin.



advertiser_ptx_campaigns


Usage: [?_advertiser_ptx_campaigns(arg1)_?]

Arguments: arg1: stats content.

Return: a list of advertiser's PTX campaigns.


Description:

advertiser_ptx_campaigns returns a list of the advertiser's PTX campaigns (if logged in). The content indicated by arg1 is parsed and concatenated over the number of records found.

arg1 comports the following variables:

%ID%: a counter number assigned to each record.
%NAME%: campaign name.
%DESCRIPTION%: campaign description.
%STATUS%: campaign status.
%VALIDITY_START%: campaign beginning time.
%VALIDITY_END%: campaign ending time.
%REDIRECTIONS%: number of members redirected to the target URL.
%ACTIONS%: number of completed actions.
%AD_VALUE%: value paid to members on completion.
%AD_VALUE_TYPE%: returns cash or points.
%TOTAL_CASH%: total cash paid to members.
%TOTAL_POINTS%: total points paid to members.
%MAX_ACTIONS%: max number of completed actions before expiration.
%PACKAGE%: ad package name.

For an example of usage, refer to the code (HTML+JavaScript) of the advertiser_campaigns page on the CMS editor of your admin.



advertiser_purchases


Usage: [?_advertiser_purchases(arg1;arg2)_?]

Arguments: arg1: max number of records per page. arg2: stats content.

Return: a list of advertiser's purchases.


Description:

advertiser_purchases returns a list of the advertiser's purchases (if logged in). The content indicated by arg2 is parsed and concatenated over the number of records found.

arg2 comports the following variables:

%ID%: a counter number assigned to each record.
%DATE%: the time the purchasing event occurred.
%PACKAGE%: ad package purchased.
%CAMPAIGN_TYPE%: GPT campaign type.
%VALUE%: purchase value.
%DISCOUNT%: purchase discount.
%STATUS%: purchase status.
%PROCESSING_TIME%: time of the purchase processing.

The HTTP variable purchases_page is used for pagination purposes.

For an example of usage, refer to the code (HTML+JavaScript) of the advertiser_purchases page on the CMS editor of your admin.



host


Usage: [?_host_?]

Arguments: none.

Return: host member's username.


Description:

host returns the host member's username (if guest is logged in).

Host member is the member profiled on the page http://<yoursite>/user/<SomeMember>. Guest member is the member viewing that page.

Example:

Hello [?_member_?], you are visiting [?_host_?]'s page.



host_id


Usage: [?_host_id_?]

Arguments: none.

Return: host member's id.


Description:

host_id returns the host member's id (if guest is logged in).

Host member is the member profiled on the page http://<yoursite>/user/<SomeMember>. Guest member is the member viewing that page.

Example:

Hello [?_member_?] (id: [?_member_id_?]), you are visiting [?_host_?]'s (id: [?_host_id_?]) page.



host_info


Usage: [?_host_info(arg1)_?]

Arguments: arg1: information to be retrieved.

Return: host member's information specified by arg1.


Description:

host_info returns the host member's information specified by arg1 (if guest is logged in).

Host member is the member profiled on the page http://<yoursite>/user/<SomeMember>. Guest member is the member viewing that page.

Example:

Hello [?_member_?] (email: [?_member_info(Email)_?]), you are visiting [?_host_?]'s (email: [?_host_info(Email)_?]) page.

For a list of available members information go to Signup Options » Members information on the admin site.



host_blocked_guest


Usage: [?_host_blocked_guest_?]

Arguments: none.

Return: 1 if guest is blocked by host; 0 otherwise.


Description:

host_blocked_guest returns 1 if the guest member is blocked by the host member; 0 otherwise (if guest is logged in).

Host member is the member profiled on the page http://<yoursite>/user/<SomeMember>. Guest member is the member viewing that page.

In this context, blocking a member means disabling private messaging.

Example:

<div id="blockingDiv" style="display:hidden">You are blocked by [?_host_?].</div>
<script>if ([?_host_blocked_guest_?]==1){document.getElementById("blockingDiv").style.display="block";}</script>



host_is_blocked


Usage: [?_host_is_blocked_?]

Arguments: none.

Return: 1 if host is blocked by guest; 0 otherwise.


Description:

host_is_blocked returns 1 if the host member is blocked by the guest member; 0 otherwise (if guest is logged in).

Host member is the member profiled on the page http://<yoursite>/user/<SomeMember>. Guest member is the member viewing that page.

In this context, blocking a member means disabling private messaging.

Example:

<div id="blockingDiv" style="display:hidden">You have blocked [?_host_?].</div>
<script>if ([?_host_is_blocked_?]==1){document.getElementById("blockingDiv").style.display="block";}</script>



host_downline_count


Usage: [?_host_downline_count(arg1)_?]

Arguments: arg1: downline level.

Return: the number of host's downline members at level arg1.


Description:

host_downline_count returns the number of host's downline members at the level specified by arg1 (if guest is logged in).

Example:

[?_host_?] has [?_host_downline_count(2)_?] member(s) at level 2.



host_last_referee


Usage: [?_host_last_referee(arg1)_?]

Arguments: arg1: downline level.

Return: the last host's referee at level arg1.


Description:

host_last_referee returns the last host's referee at level specified by arg1 (if guest is logged in).

Example:

[?_host_?]'s last direct referee is [?_host_last_referee(1)_?].



Database functions


sql_query


Usage: [?_sql_query(arg1)_?]

Arguments: arg1: SQL query.

Return: nothing.


Description:

sql_query performs a SQL query. Used in conjunction with sql_query_result or sql_row_concat, it may used for direct database access within a CMS page.

arg1 comports the following variables:

%MEMBER%
%MEMBER_ID%
%ADVERTISER%
%ADVERTISER_ID%
%HOST%
%HOST_ID%

Example:

Database version is: [?_sql_query(select version())_?][?_sql_query_result(0;0)_?].



sql_query_result


Usage: [?_sql_query_result(arg1;arg2)_?]

Arguments: arg1: 0-based SQL result row. arg2: 0-based SQL result column.

Return: the SQL result of that last query entered with sql_query.


Description:

sql_query_result returns the SQL result of that last query entered with sql_query. The row and column are specified by arg1 and arg2 respectively. Used in conjunction with sql_query, it may used for direct database access within a CMS page.

Example:

System time is: [?_sql_query(select now())_?][?_sql_query_result(0;0)_?].



sql_row_concat


Usage: [?_sql_row_concat(arg1;arg2)_?]

Arguments: arg1: 0-based SQL result row. arg2: content separator.

Return: the concatenated SQL result of that last query entered with sql_query.


Description:

sql_row_concat returns the concatenated SQL result of that last query entered with sql_query. The row is specified by arg1. Used in conjunction with sql_query, it may used for direct database access within a CMS page.

Example:

Your last 10 login sessions are: <p> [?_sql_query(select Time from GPTE_Members_Login_Stats where Event="login" and Member_Id=%MEMBER_ID% order by Time desc limit 10)_?] [?_sql_row_concat(0;<br />)_?]</p>



Program information


site_url


Usage: [?_site_url_?]

Arguments: none

Return: the full URL of your site.


Description:

site_url returns the full URL of your site. It will return http:// or https:// automatically if SSL is being used or not.

Example:

<a href="[?_site_url_?]">Home</a>



currency_code


Usage: [?_currency_code_?]

Arguments: none

Return: the currency code used by your program.


Description:

currency_code returns the currency code used by your program.

Example:

All prices are in [?_currency_code_?].



point_value


Usage: [?_point_value_?]

Arguments: none

Return: the current value of a point in cash.


Description:

point_value returns the the current value of a point in cash.

Example:

Currently, 1 point = [?_point_value_?].



list_ad_packages


Usage: [?_list_ad_packages(arg1;arg2)_?]

Arguments: arg1: GPT type (ptc, ptr, ... ptx). arg2: content.

Return: a list of available ad packages of type arg1.


Description:

list_ad_packages returns a list of available ad packages of the type specified by arg1. The content indicated by arg2 is parsed and concatenated over the number of records found.

arg2 comports the following variables:

%NAME%: package name.
%NAME_ENCODED%: URL encoded package name.
%DESCRIPTION%: package description.
%PRICE%: package price.
%PTP_TYPE%: returns text, image or link if GPT type is PTP.
%PTP_TYPE%: returns the ad image format if GPT type is PTP.
%ODD%: returns Odd if it is an odd record (use it for table "zebra stripping").

For an example of usage, refer to the code (HTML+JavaScript) of the advertiser_create_campaign page on the CMS editor of your admin.



Form validation


set_captcha


Usage: [?_set_captcha(arg1;arg2)_?]

Arguments: arg1: form id. arg2: captcha validity time (in seconds).

Return: captcha code to protect your form.


Description:

set_captcha returns an invisible captcha code to protect your form against automated submission. In order to validate your form submission, the target page must have validate captcha checked in the CMS.

Example:

<form id="myForm" action="some_page" method="get">
...form content...
</form>
[?_set_captcha(myForm;180)_?]



Entropy


content_rotator


Usage: [?_content_rotator(arg1)_?]

Arguments: arg1: content rotator name.

Return: random content given by the rotator arg1.


Description:

content_rotator returns random content given by the rotator specified by arg1.

Example:

Check out this special offer:<p>[?_content_rotator(Offers)_?]</p>

© 2015 by popux. All rights reserved.