Docs For Class registration

Class registration

Description

Registration class to perform the majority of registration handling tasks

author: ILance
version: $Revision: 1.0.0 $

Located in /api/class.registration.inc.php (line 23)

Method Summary

nothing build_invitation_datastore ([integer $userid = 0], string $email)

nothing build_registration_questions (array &$questions, integer $userid)

mixed build_user_datastore (array &$user, array &$preferences, array &$subscription, array &$questions, [string $custom = 'return_userarray'], [bool $skipsessions = 0])

nothing build_user_subscription ([integer $userid = 0], [integer $subscriptionid = 0], [string $paymethod = 'account'], [string $promocode = ''], [integer $roleid = '-1'], [boolean $skipsession = 0])

mixed construct_account_number ()

string fetch_default_timezone ()

integer fetch_formname_questionid (string $formname)

bool fetch_invite_subscriptionid ()

mixed process_custom_register_questions (array &$custom, integer $userid)

string proxy_check ()

nothing referral_check (integer $userid, string $referralcode)

nothing send_email_activation (string $useremail)

nothing send_email_activation_with_redirect_link (string $useremail, $redirect)

Methods

build_invitation_datastore (line 1158)

Function for returning the subscription id of a free subscription plan that is active and visible for the permission of 'servicebid' with a value of 'true'

nothing build_invitation_datastore ([integer $userid = 0], string $email)

integer $userid: user id
string $email: email address

build_registration_questions (line 569)

Function to insert custom registration questions into the database based on formame (key) and answer (value).

nothing build_registration_questions (array &$questions, integer $userid)

array &$questions: question formname (key) and answer (value)
integer $userid: user id

build_user_datastore (line 37)

Function for creating a valid ILance member using the registration datastore.

return: returns integers, strings and arrays

mixed build_user_datastore (array &$user, array &$preferences, array &$subscription, array &$questions, [string $custom = 'return_userarray'], [bool $skipsessions = 0])

array &$user: user information
array &$preferences: user preferences information
array &$subscription: user subscription information
array &$questions: custom registration questions and answers
string $custom: tells this function what data to return when completed: return_userid OR return_userstatus OR return_userarray
bool $skipsessions: tells this function if it should skip sessions (for api calls from other applications if required)

build_user_subscription (line 739)

Function for creating a new user subscription plan.

nothing build_user_subscription ([integer $userid = 0], [integer $subscriptionid = 0], [string $paymethod = 'account'], [string $promocode = ''], [integer $roleid = '-1'], [boolean $skipsession = 0])

integer $userid: user id
integer $subscriptionid: subscription id
string $paymethod: payment method (account, paypal, cashu, stormpay, moneybookers, etc)
string $promocode: promotional code
integer $roleid: subscription role id
boolean $skipsession: skip session functionality (maybe calling from external script)

construct_account_number (line 1003)

Function for creating a new user account number used in the ILance accounting system.

return: unique online account balance number

mixed construct_account_number ()

fetch_default_timezone (line 1212)

Function for returning the default time zone

return: Returns default time zone

string fetch_default_timezone ()

fetch_formname_questionid (line 708)

Function for fetching the question id based on a formname question.

return: question id number

integer fetch_formname_questionid (string $formname)

string $formname: name of the form field

fetch_invite_subscriptionid (line 1108)

Function for returning the subscription id of a free subscription plan that is active and visible for the permission of 'servicebid' with a value of 'true'

return: false or the integer of the subscription id

bool fetch_invite_subscriptionid ()

process_custom_register_questions (line 1021)

Function to process submitted custom registration questions to be stored within the database

return: unique online account balance number

mixed process_custom_register_questions (array &$custom, integer $userid)

array &$custom: custom answers stored in array format
integer $userid: user id

proxy_check (line 1084)

Function for checking if a user attempting to register is coming from a proxy service and displays a custom template denying registration if registration proxy disabling is enabled.

return: HTML representation of the question registration question

string proxy_check ()

referral_check (line 948)

Function for checking a referral code

nothing referral_check (integer $userid, string $referralcode)

integer $userid: user id
string $referralcode: referral code

send_email_activation (line 608)

Function for dispatching the activation email to new clients.

nothing send_email_activation (string $useremail)

string $useremail: user email address

send_email_activation_with_redirect_link (line 658)

Function for dispatching the activation email to new clients.

nothing send_email_activation_with_redirect_link (string $useremail, $redirect)

string $useremail: user email address
$redirect

Documentation generated on Mon, 08 Aug 2011 17:40:56 +0200 by phpDocumentor 1.4.1