ChWsbConnectModule Class Reference

Inheritance diagram for ChWsbConnectModule:

Public Member Functions
	__construct ($aModule)
	_actionAdministration ($sOptionApiKey, $sLangSettingsTitle, $sLangInfoTitle='', $sLangInfoText='', $sInfoTextParam='')
	setLogged ($iProfileId, $sPassword, $sCallbackUrl='', $bRedirect=true)
	getAlternativeName ($sNickName)
	getJoinAfterPaymentPage ($aProfileInfo)
	processJoinAfterPayment (&$oAlert)
	_assignAvatar ($sAvatarUrl, $iProfileId=false)
	_createProfile ($aProfileInfo, $sAlternativeName='')
	_createProfileRaw ($aProfileInfo, $sAlternativeName='', $isAutoFriends=true, $isSetLoggedIn=true)
	_getJoinPage ($aProfileFields, $iRemoteProfileId)
	_getRedirectUrl ($iProfileId, $isExistingProfile=false)
Public Member Functions inherited from ChWsbModule
	isLogged ()
	getUserId ()
	getUserPassword ()
	getTitleKey ($sUri)
	serviceGetBaseUrl ()

Protected Member Functions
	_convertRemoteFields ($aProfileInfo, $sAlternativeName='')
	_redirect ($sUrl, $iStatus=302)

Additional Inherited Members
Static Public Member Functions inherited from ChWsbModule
static	getInstance ($sClassName)
static	getTitle ($sUri)
Public Attributes inherited from ChWsbModule
	$_aModule
	$_oDb
	$_oTemplate
	$_oConfig

Detailed Description

Definition at line 10 of file ChWsbConnectModule.php.

Constructor & Destructor Documentation

__construct()

ChWsbConnectModule::__construct

(

$aModule

)

constructor

Reimplemented from ChWsbModule.

Definition at line 12 of file ChWsbConnectModule.php.

Member Function Documentation

_actionAdministration()

ChWsbConnectModule::_actionAdministration	(		$sOptionApiKey,
			$sLangSettingsTitle,
			$sLangInfoTitle = '',
			$sLangInfoText = '',
			$sInfoTextParam = ''
	)

Generate admin page;

Returns

: (text) - html presentation data;

Definition at line 22 of file ChWsbConnectModule.php.

_assignAvatar()

ChWsbConnectModule::_assignAvatar	(		$sAvatarUrl,
			$iProfileId = false
	)

Assign avatar to user

Parameters

$sAvatarUrl

string

Returns

void

Definition at line 157 of file ChWsbConnectModule.php.

_convertRemoteFields()

ChWsbConnectModule::_convertRemoteFields (   $aProfileInfo,   $sAlternativeName = ''  )

protected

Parameters

$aProfileInfo	- remote profile info
$sAlternativeName	- suffix to add to NickName to make it unique

Returns

profile array info, ready for the local database

Reimplemented in ChFaceBookConnectModule, and ChDolphConModule.

Definition at line 242 of file ChWsbConnectModule.php.

_createProfile()

ChWsbConnectModule::_createProfile	(		$aProfileInfo,
			$sAlternativeName = ''
	)

Create new profile;

Parameters

:	$aProfileInfo	(array) - remote profile's information;
:	$sAlternativeName	(string) - profiles alternative nickname;

Definition at line 193 of file ChWsbConnectModule.php.

_createProfileRaw()

ChWsbConnectModule::_createProfileRaw	(		$aProfileInfo,
			$sAlternativeName = '',
			$isAutoFriends = true,
			$isSetLoggedIn = true
	)

Create new profile;

Parameters

:	$aProfileInfo	(array) - remote profile's information;
:	$sAlternativeName	(string) - profiles alternative nickname;

Returns

: error string or error or profile info array on success

Definition at line 254 of file ChWsbConnectModule.php.

_getJoinPage()

ChWsbConnectModule::_getJoinPage	(		$aProfileFields,
			$iRemoteProfileId
	)

Get join page

Parameters

$aProfileFields	array
$iRemoteProfileId	remote profile id

Returns

void

Definition at line 396 of file ChWsbConnectModule.php.

_getRedirectUrl()

ChWsbConnectModule::_getRedirectUrl	(		$iProfileId,
			$isExistingProfile = false
	)

get redirect URL

Parameters

$iProfileId

integer - profile ID

Returns

string redirect URL

Definition at line 422 of file ChWsbConnectModule.php.

_redirect()

ChWsbConnectModule::_redirect (   $sUrl,   $iStatus = 302  )

protected

Definition at line 453 of file ChWsbConnectModule.php.

getAlternativeName()

ChWsbConnectModule::getAlternativeName

(

$sNickName

)

get profile's alternative nickname

Parameters

$sNickName

string

Returns

suffix to add to nickname to make it unique

Definition at line 93 of file ChWsbConnectModule.php.

getJoinAfterPaymentPage()

ChWsbConnectModule::getJoinAfterPaymentPage

(

$aProfileInfo

)

get 'join after payment' page

Parameters

$aProfileInfo

array remote profile info

Returns

void

Definition at line 116 of file ChWsbConnectModule.php.

processJoinAfterPayment()

ChWsbConnectModule::processJoinAfterPayment

(

&

$oAlert

)

Definition at line 129 of file ChWsbConnectModule.php.

setLogged()

ChWsbConnectModule::setLogged	(		$iProfileId,
			$sPassword,
			$sCallbackUrl = '',
			$bRedirect = true
	)

Logged profile

Parameters

$iProfileId	integer
$sPassword	string
$sCallbackUrl
$bRedirect	boolean

Returns

void

Definition at line 73 of file ChWsbConnectModule.php.

---

The documentation for this class was generated from the following file:

• inc/classes/ChWsbConnectModule.php