';
$help .= '';
$help .= '- ' . __( 'Hits are HTTP requests for affiliate links.', 'affiliates' ) . '
';
$help .= '- ' . __( 'Visits are unique and daily requests for affiliate links.', 'affiliates' ) . '
';
$help .= '- ' . __( 'Referrals are recording commissions and referral data.', 'affiliates' ) . '
';
$help .= '
';
$help .= '';
$help .= __( 'The Affiliates plugin provides the Affiliates Contact widget that can be used to record lead referrals.', 'affiliates' );
$help .= sprintf( __( 'To use it, place the widget in one of your widget areas.', 'affiliates' ), get_admin_url( null, 'widgets.php' ) );
$help .= '
';
$help .= '';
$help .= __( 'Note that deleted affiliates are not literally deleted but marked as such so that data that has been collected will still be accesible.', 'affiliates' );
$help .= '
';
break;
case 'affiliates_page_affiliates-admin-affiliates':
$show_affiliates_help = true;
$help .=
'' .
__( 'Here you can add, edit and remove affiliates.', 'affiliates' ) .
'
';
$help .=
'' .
'- ' .
'
' .
__( 'Affiliate link', 'affiliates' ) .
'
' .
'' .
__( 'This link uses a parameter in the URL to record visits you receive through your affiliates.', 'affiliates' ) . ' ' .
'
' .
sprintf( __( 'You may also append the ?%s=... part to links to your posts.', 'affiliates' ), $pname ) .
'
' .
' ' .
'
' .
'' .
__( 'Once a visitor has landed on your site through an affiliate link, referrals may be recorded and attributed to the affiliate.', 'affiliates' ) .
'
';
break;
case 'affiliates_page_affiliates-admin-hits' :
$show_affiliates_help = true;
break;
case 'affiliates_page_affiliates-admin-hits-affiliate' :
$show_affiliates_help = true;
break;
case 'affiliates_page_affiliates-admin-totals' :
$show_affiliates_help = true;
break;
case 'affiliates_page_affiliates-admin-referrals' :
$show_affiliates_help = true;
break;
case 'affiliates_page_affiliates-admin-options' :
$show_affiliates_help = true;
break;
default:
$show_affiliates_help = strpos( $screen_id, 'affiliates_page_affiliates' ) !== false;
}
if ( !defined( 'AFFILIATES_PRO_PLUGIN_DOMAIN' ) && !defined( 'AFFILIATES_ENTERPRISE_PLUGIN_DOMAIN' ) ) {
$help .= '';
$help .= affiliates_donate( false, true );
$help .= '
';
}
$help .= affiliates_help_tab_footer( false );
if ( $show_affiliates_help ) {
return $help;
} else {
return $contextual_help;
}
}
/**
* Returns or renders the common footer for help tabs.
* @param boolean $render
* @return string or nothing
*/
function affiliates_help_tab_footer( $render = true ) {
$footer =
'' .
sprintf(
'
%s',
esc_attr( 'http://docs.itthinx.com/document/affiliates/' ),
esc_html( __( 'Online documentation', 'affiliates' ) )
) .
'
* - affiliate_id - the integer id
* - name - the affiliate's name
* - email - email address
* - from_date - from when the affiliate is valid (*)
* - thru_date - [optional] until when the affiliate is valid (*)
* - status - either 'active' or 'deleted'
*
* (*) Suggested referrals will succeed if the current date is within those dates. Both are inclusive.
*
* Usage example:
* $affiliate = affiliates_get_affiliate( $affiliate_id );
* $email = $affiliate['email'];
*
* @param int|string $affiliate_id the affiliate's id
* @return array affiliate details or null
*/
function affiliates_get_affiliate( $affiliate_id ) {
global $wpdb;
$table = _affiliates_get_tablename( 'affiliates' );
$affiliate = $wpdb->get_row(
$wpdb->prepare( "SELECT * FROM $table WHERE affiliate_id = %d", intval( $affiliate_id ) ),
ARRAY_A
);
return $affiliate;
}
/**
* Return the user id related to an affiliate.
* @param int $affiliate_id
* @return int user_id
*/
function affiliates_get_affiliate_user( $affiliate_id ) {
global $wpdb;
$table = _affiliates_get_tablename( 'affiliates_users' );
$user_id = $wpdb->get_var( $wpdb->prepare(
"SELECT user_id FROM $table WHERE affiliate_id = %d", intval( $affiliate_id )
) );
return $user_id;
}
/**
* Return the affiliate ids related to a user.
*
* @param int $user_id
* @param string $status the affiliate's status, default is 'active'
* @return array of int affiliate ids or null on failure
*/
function affiliates_get_user_affiliate( $user_id, $status = 'active' ) {
global $wpdb;
switch( $status ) {
case 'active' :
case 'pending' :
case 'deleted' :
break;
default :
$status = 'active';
}
$result = null;
$affiliates_table = _affiliates_get_tablename( 'affiliates' );
$affiliates_users_table = _affiliates_get_tablename( 'affiliates_users' );
if ( $affiliates = $wpdb->get_results( $wpdb->prepare(
"SELECT $affiliates_table.affiliate_id FROM $affiliates_users_table LEFT JOIN $affiliates_table ON $affiliates_users_table.affiliate_id = $affiliates_table.affiliate_id WHERE $affiliates_users_table.user_id = %d AND $affiliates_table.status = %s",
intval( $user_id ),
$status
) ) ) {
$result = array();
foreach( $affiliates as $affiliate ) {
$result[] = $affiliate->affiliate_id;
}
}
return $result;
}
/**
* Returns true if the user is an affiliate.
* @param int|object $user (optional) specify a user or use current if none given
*/
function affiliates_user_is_affiliate( $user_id = null ) {
global $wpdb;
$result = false;
if ( is_user_logged_in() ) {
if ( $user_id == null ) {
$user = wp_get_current_user();
} else {
$user = get_user_by( 'id', $user_id );
}
if ( $user ) {
$user_id = $user->ID;
$affiliates_table = _affiliates_get_tablename( 'affiliates' );
$affiliates_users_table = _affiliates_get_tablename( 'affiliates_users' );
$affiliates = $wpdb->get_results(
$wpdb->prepare( "SELECT * FROM $affiliates_users_table LEFT JOIN $affiliates_table ON $affiliates_users_table.affiliate_id = $affiliates_table.affiliate_id WHERE $affiliates_users_table.user_id = %d AND $affiliates_table.status ='active'", intval( $user_id ) )
);
$result = !empty( $affiliates );
}
}
return $result;
}
/**
* Returns true if the user is an affiliate with the given status.
*
* @param int|object $user (optional) specify a user or use current if none given
* @param string $status 'active' (default), 'pending', 'deleted'
*/
function affiliates_user_is_affiliate_status( $user_id = null, $status = 'active' ) {
global $wpdb;
switch( $status ) {
case 'active' :
case 'pending' :
case 'deleted' :
break;
default :
$status = 'active';
}
$result = false;
if ( is_user_logged_in() ) {
if ( $user_id == null ) {
$user = wp_get_current_user();
} else {
$user = get_user_by( 'id', $user_id );
}
if ( $user ) {
$user_id = $user->ID;
$affiliates_table = _affiliates_get_tablename( 'affiliates' );
$affiliates_users_table = _affiliates_get_tablename( 'affiliates_users' );
$affiliates = $wpdb->get_results(
$wpdb->prepare(
"SELECT * FROM $affiliates_users_table LEFT JOIN $affiliates_table ON $affiliates_users_table.affiliate_id = $affiliates_table.affiliate_id WHERE $affiliates_users_table.user_id = %d AND $affiliates_table.status = %s",
intval( $user_id ),
$status
)
);
$result = !empty( $affiliates );
}
}
return $result;
}
/**
* Returns the current status of the affiliate.
*
* @param int $affiliate_id
* @return string affiliate status or null
*/
function affiliates_get_affiliate_status( $affiliate_id ) {
global $wpdb;
$affiliates_table = _affiliates_get_tablename( 'affiliates' );
return $wpdb->get_var(
$wpdb->prepare(
"SELECT status FROM $affiliates_table WHERE affiliate_id = %d",
intval( $affiliate_id )
)
);
}
/**
* Returns an array of affiliates.
* @param boolean $active returns only active affiliates (not deleted via the admin UI)
* @return array of affiliates
*/
function affiliates_get_affiliates( $active = true, $valid = true ) {
global $wpdb;
$results = array();
$today = date( 'Y-m-d', time() );
$table = _affiliates_get_tablename( 'affiliates' );
if ( $active ) {
if ( $valid ) {
$query = $wpdb->prepare( "SELECT * FROM $table WHERE from_date <= %s AND ( thru_date IS NULL OR thru_date >= %s ) AND status = 'active' ORDER BY NAME", $today, $today );
} else {
$query = "SELECT * FROM $table WHERE status = 'active' ORDER BY NAME";
}
} else {
if ( $valid ) {
$query = $wpdb->prepare( "SELECT * FROM $table WHERE from_date <= %s AND ( thru_date IS NULL OR thru_date >= %s ) ORDER BY NAME", $today, $today );
} else {
$query = "SELECT * FROM $table ORDER BY NAME";
}
}
if ( $affiliates = $wpdb->get_results( $query, ARRAY_A ) ) {
$results = $affiliates;
}
return $results;
}
/**
* Returns the number of hits for a given affiliate.
*
* @param int $affiliate_id the affiliate's id
* @param string $from_date optional from date
* @param string $thru_date optional thru date
* @param boolean $precise take time into account ($from_date and $thru_date include time)
* @return int number of hits
*/
function affiliates_get_affiliate_hits( $affiliate_id, $from_date = null , $thru_date = null, $precise = false ) {
global $wpdb;
$hits_table = _affiliates_get_tablename('hits');
$result = 0;
$where = " WHERE affiliate_id = %d";
$values = array( $affiliate_id );
if ( $from_date ) {
if ( $precise ) {
$from_datetime = date( 'Y-m-d H:i:s', strtotime( $from_date ) );
} else {
$from_date = date( 'Y-m-d', strtotime( $from_date ) );
}
}
if ( $thru_date ) {
if ( $precise ) {
$thru_datetime = date( 'Y-m-d H:i:s', strtotime( $thru_date ) );
} else {
$thru_date = date( 'Y-m-d', strtotime( $thru_date ) + 24*3600 );
}
}
if ( $from_date && $thru_date ) {
if ( $precise ) {
$where .= " AND datetime >= %s AND datetime < %s ";
$values[] = $from_datetime;
$values[] = $thru_datetime;
} else {
$where .= " AND date >= %s AND date < %s ";
$values[] = $from_date;
$values[] = $thru_date;
}
} else if ( $from_date ) {
if ( $precise ) {
$where .= " AND datetime >= %s ";
$values[] = $from_datetime;
} else {
$where .= " AND date >= %s ";
$values[] = $from_date;
}
} else if ( $thru_date ) {
if ( $precise ) {
$where .= " AND datetime < %s ";
$values[] = $thru_datetime;
} else {
$where .= " AND date < %s ";
$values[] = $thru_date;
}
}
$query = $wpdb->prepare( "SELECT COUNT(*) FROM $hits_table $where",
$values
);
$result = intval( $wpdb->get_var( $query) );
return $result;
}
/**
* Returns the number of visits for a given affiliate.
* One or more hits from the same IP on the same day count as one visit.
*
* @param int $affiliate_id the affiliate's id
* @param string $from_date optional from date
* @param string $thru_date optional thru date
* @param boolean $precise take time into account ($from_date and $thru_date include time)
* @return int number of visits
*/
function affiliates_get_affiliate_visits( $affiliate_id, $from_date = null , $thru_date = null, $precise = false ) {
global $wpdb;
$hits_table = _affiliates_get_tablename('hits');
$result = 0;
$where = " WHERE affiliate_id = %d";
$values = array( $affiliate_id );
// if ( $from_date ) {
// $from_date = date( 'Y-m-d', strtotime( $from_date ) );
// }
// if ( $thru_date ) {
// $thru_date = date( 'Y-m-d', strtotime( $thru_date ) + 24*3600 );
// }
// if ( $from_date && $thru_date ) {
// $where .= " AND date >= %s AND date < %s ";
// $values[] = $from_date;
// $values[] = $thru_date;
// } else if ( $from_date ) {
// $where .= " AND date >= %s ";
// $values[] = $from_date;
// } else if ( $thru_date ) {
// $where .= " AND date < %s ";
// $values[] = $thru_date;
// }
if ( $from_date ) {
if ( $precise ) {
$from_datetime = date( 'Y-m-d H:i:s', strtotime( $from_date ) );
} else {
$from_date = date( 'Y-m-d', strtotime( $from_date ) );
}
}
if ( $thru_date ) {
if ( $precise ) {
$thru_datetime = date( 'Y-m-d H:i:s', strtotime( $thru_date ) );
} else {
$thru_date = date( 'Y-m-d', strtotime( $thru_date ) + 24*3600 );
}
}
if ( $from_date && $thru_date ) {
if ( $precise ) {
$where .= " AND datetime >= %s AND datetime < %s ";
$values[] = $from_datetime;
$values[] = $thru_datetime;
} else {
$where .= " AND date >= %s AND date < %s ";
$values[] = $from_date;
$values[] = $thru_date;
}
} else if ( $from_date ) {
if ( $precise ) {
$where .= " AND datetime >= %s ";
$values[] = $from_datetime;
} else {
$where .= " AND date >= %s ";
$values[] = $from_date;
}
} else if ( $thru_date ) {
if ( $precise ) {
$where .= " AND datetime < %s ";
$values[] = $thru_datetime;
} else {
$where .= " AND date < %s ";
$values[] = $thru_date;
}
}
$query = $wpdb->prepare(
"SELECT SUM(visits) FROM " .
"(SELECT COUNT(DISTINCT IP) visits FROM $hits_table $where GROUP BY DATE) tmp",
$values
);
$result = intval( $wpdb->get_var( $query) );
return $result;
}
/**
* Returns the number of referrals for a given affiliate.
*
* @param int $affiliate_id the affiliate's id
* @param string $from_date optional from date
* @param string $thru_date optional thru date
* @return int number of hits
*/
function affiliates_get_affiliate_referrals( $affiliate_id, $from_date = null , $thru_date = null, $status = null, $precise = false ) {
global $wpdb;
$referrals_table = _affiliates_get_tablename( 'referrals' );
$result = 0;
$where = " WHERE affiliate_id = %d";
$values = array( $affiliate_id );
if ( $from_date ) {
if ( $precise ) {
$from_date = date( 'Y-m-d H:i:s', strtotime( $from_date ) );
} else {
$from_date = date( 'Y-m-d', strtotime( $from_date ) );
}
}
if ( $thru_date ) {
if ( $precise ) {
$thru_date = date( 'Y-m-d H:i:s', strtotime( $thru_date ) );
} else {
$thru_date = date( 'Y-m-d', strtotime( $thru_date ) + 24*3600 );
}
}
if ( $from_date && $thru_date ) {
$where .= " AND datetime >= %s AND datetime < %s ";
$values[] = $from_date;
$values[] = $thru_date;
} else if ( $from_date ) {
$where .= " AND datetime >= %s ";
$values[] = $from_date;
} else if ( $thru_date ) {
$where .= " AND datetime < %s ";
$values[] = $thru_date;
}
if ( !empty( $status ) ) {
$where .= " AND status = %s ";
$values[] = $status;
} else {
$where .= " AND status IN ( %s, %s ) ";
$values[] = AFFILIATES_REFERRAL_STATUS_ACCEPTED;
$values[] = AFFILIATES_REFERRAL_STATUS_CLOSED;
}
$query = $wpdb->prepare( "SELECT COUNT(*) FROM $referrals_table $where",
$values
);
$result = intval( $wpdb->get_var( $query) );
return $result;
}
/**
* Returns the prefixed DB table name.
* @param string $name the name of the DB table
* @return string prefixed DB table name
*/
function _affiliates_get_tablename( $name ) {
global $wpdb;
return $wpdb->prefix . AFFILIATES_TP . $name;
}
/**
* Attribute filter for overrides.
*
* @param mixed $value
* @param int $affiliate_id
* @param string $key
* @return mixed
*/
function affiliates_attribute_filter( $value, $affiliate_id, $key ) {
if ( $user_id = affiliates_get_affiliate_user( $affiliate_id ) ) {
$maybe_value = get_user_meta( $user_id, $key , true );
if ( !empty( $maybe_value ) ) {
$value = $maybe_value;
}
}
return $value;
}
/**
* Compose a URL based on its components.
*
* $components can provide values indexed by the keys scheme, host, port,
* user, pass, path, query and fragment as produced by parse_url().
*
* @param array $components
* @return string URL
*/
function affiliates_compose_url( $components ) {
$scheme = isset( $components['scheme'] ) ? $components['scheme'] . '://' : '';
$host = isset( $components['host'] ) ? $components['host'] : '';
$port = isset( $components['port'] ) ? ':' . $components['port'] : '';
$user = isset( $components['user'] ) ? $components['user'] : '';
$pass = isset( $components['pass'] ) ? ':' . $components['pass'] : '';
$pass = ( !empty( $user ) || !empty( $pass ) ) ? "$pass@" : '';
$path = isset( $components['path'] ) ? $components['path'] : '';
$query = isset( $components['query'] ) ? '?' . $components['query'] : '';
$fragment = isset( $components['fragment'] ) ? '#' . $components['fragment'] : '';
return "$scheme$user$pass$host$port$path$query$fragment";
}
/**
* Returns the URL converted to an affiliate URL for the given affiliate.
*
* @param string $url
* @param int $affiliate_id
*/
function affiliates_get_affiliate_url( $url, $affiliate_id ) {
$pname = get_option( 'aff_pname', AFFILIATES_PNAME );
$scheme = parse_url( $url, PHP_URL_SCHEME );
if ( empty( $scheme ) ) {
$prefix = '';
// Although scheme is empty we could have a malformed scheme and we don't
// want to make it worse so also check for http:// and https:// prefixes.
if ( strpos( $url, 'http://' ) !== 0 && strpos( $url, 'https://' ) !== 0 ) {
$prefix = !empty( $_SERVER['HTTPS'] ) && strtolower( $_SERVER['HTTPS'] ) != 'off' ? 'https:' : 'http:';
if ( strpos( $url, '//' ) !== 0 ) {
$prefix .= '//';
}
}
$url = $prefix . $url;
}
$components = parse_url( $url );
// If pname is already in query, don't modify.
if ( strpos( isset( $components['query'] ) ? $components['query'] : '', "$pname=" ) === false ) {
$query = '';
if ( !empty( $components['query'] ) ) {
$query = $components['query'] . '&';
}
$encoded_id = affiliates_encode_affiliate_id( $affiliate_id );
$query .= sprintf( '%s=%s', $pname, $encoded_id );
if ( empty( $components['path'] ) ) {
$components['path'] = '/';
}
$components['query'] = $query;
}
return affiliates_compose_url( $components );
}
/**
* Returns the precision for referral amount decimals.
*
* Uses the constants :
* - AFFILIATES_REFERRAL_AMOUNT_DECIMALS for empty or default context ''
* - AFFILIATES_REFERRAL_AMOUNT_DECIMALS_DISPLAY for context 'display'
*
* @param string $context provided and passed in the filter, default '', allows also 'display'
* @return int decimals for referral amounts
*/
function affiliates_get_referral_amount_decimals( $context = null ) {
switch( $context ) {
case 'display' :
$result = apply_filters( 'affiliates_referral_amount_decimals', AFFILIATES_REFERRAL_AMOUNT_DECIMALS_DISPLAY, $context );
break;
default :
$result = apply_filters( 'affiliates_referral_amount_decimals', AFFILIATES_REFERRAL_AMOUNT_DECIMALS, $context );
}
return $result;
}
/**
* Returns the referral amount formatted.
*
* @param number $amount
* @param string $context see affiliates_get_referral_amount_decimals()
* @return string
*/
function affiliates_format_referral_amount( $amount, $context = '' ) {
if ( function_exists( 'bcadd' ) ) {
return bcadd( '0', $amount, affiliates_get_referral_amount_decimals( $context ) );
} else {
$scale = intval( affiliates_get_referral_amount_decimals( $context ) );
return sprintf( '%.' . $scale . 'F', $amount );
}
}