BxDolAccount Class Reference

Inheritance diagram for BxDolAccount:

Public Member Functions
	__clone ()
	id ()
	isConfirmed ($iAccountId=false)
	updateEmailConfirmed ($isConfirmed, $isAutoSendConfrmationEmail=true, $iAccountId=false)
	updatePhoneConfirmed ($isConfirmed, $iAccountId=false)
	updatePassword ($sPassword, $iAccountId=false)
	updatePhone ($sPhone, $iAccountId=false)
	updateProfileContextAuto ($iProfileIdFilterOut=false, $iAccountId=false)
	sendConfirmationEmail ($iAccountId=false)
	getInfo ($iAccountId=false)
	getDisplayName ($iAccountId=false)
	getUrl ($iAccountId=false)
	getUnit ($iAccountId=false, $aParams=array())
	getPicture ($iAccountId=false)
	getAvatarBig ($iAccountId=false)
	getAvatar ($iAccountId=false)
	getThumb ($iAccountId=false)
	getIcon ($iAccountId=false)
	getEmail ($iAccountId=false)
	getLanguageId ($iAccountId=false)
	isOnline ($iAccountId=false)
	isProfilesLimitReached ()
	getProfilesNumber ($isFilterNonSwitchableProfiles=true)
	getProfilesIds ($isFilterNonSwitchableProfiles=true, $isFilterSystemProfiles=true)
	getProfiles ($isFilterNonSwitchableProfiles=true, $isFilterSystemProfiles=true)
	delete ($bDeleteWithContent=false)
	addInformerPermanentMessages ($oInformer)
	getUnsubscribeLink ($iEmailType, $iAccountId=false)

Static Public Member Functions
static	getInstance ($mixedAccountId=false, $bClearCache=false)
static	getInstanceStudioOperator ()
static	getID ($s)
static	isAllowedCreate ($iProfileId, $isPerformAction=false)
static	isAllowedEdit ($iProfileId, $aContentInfo, $isPerformAction=false)
static	isAllowedDelete ($iProfileId, $aContentInfo, $isPerformAction=false)

Protected Member Functions
	__construct ($iAccountId)

Constructor & Destructor Documentation

__construct()

BxDolAccount::__construct (   $iAccountId )

protected

Constructor

Member Function Documentation

__clone()

BxDolAccount::__clone

(

)

Prevent cloning the instance

addInformerPermanentMessages()

BxDolAccount::addInformerPermanentMessages

(

$oInformer

)

Add permament messages.

delete()

BxDolAccount::delete

(

$bDeleteWithContent = false

)

Delete profile.

Parameters

$bDeleteWithContent

- delete associated profiles with all its contents

getAvatar()

BxDolAccount::getAvatar

(

$iAccountId = false

)

Get avatar url

getAvatarBig()

BxDolAccount::getAvatarBig

(

$iAccountId = false

)

Get big (2x) avatar url

getDisplayName()

BxDolAccount::getDisplayName

(

$iAccountId = false

)

Get account display name

getEmail()

BxDolAccount::getEmail

(

$iAccountId = false

)

Get account email

getIcon()

BxDolAccount::getIcon

(

$iAccountId = false

)

Get icon picture url

getID()

static BxDolAccount::getID (   $s )

static

Validate account.

Parameters

$s	- account identifier (id or email)

Returns

account id or false if account was not found

getInfo()

BxDolAccount::getInfo

(

$iAccountId = false

)

Get account info

getInstance()

static BxDolAccount::getInstance (   $mixedAccountId = false,   $bClearCache = false  )

static

Get singleton instance of the class

getInstanceStudioOperator()

static BxDolAccount::getInstanceStudioOperator ( )

static

Get studio operator account singleton instance on the class

getLanguageId()

BxDolAccount::getLanguageId

(

$iAccountId = false

)

Get language ID

getPicture()

BxDolAccount::getPicture

(

$iAccountId = false

)

Get picture url

getProfiles()

BxDolAccount::getProfiles	(		$isFilterNonSwitchableProfiles = true,
			$isFilterSystemProfiles = true
	)

Get all profiles associated with the account

getProfilesIds()

BxDolAccount::getProfilesIds	(		$isFilterNonSwitchableProfiles = true,
			$isFilterSystemProfiles = true
	)

Get all profile ids associated with the account

getProfilesNumber()

BxDolAccount::getProfilesNumber

(

$isFilterNonSwitchableProfiles = true

)

Get number of profiles associated with the account

getThumb()

BxDolAccount::getThumb

(

$iAccountId = false

)

Get thumb picture url

getUnit()

BxDolAccount::getUnit	(		$iAccountId = false,
			$aParams = array()
	)

Get account url

getUnsubscribeLink()

BxDolAccount::getUnsubscribeLink	(		$iEmailType,
			$iAccountId = false
	)

Get unsubscribe link for the specified mesage type

getUrl()

BxDolAccount::getUrl

(

$iAccountId = false

)

Get account url

id()

BxDolAccount::id

(

)

Get account id

isAllowedCreate()

static BxDolAccount::isAllowedCreate (   $iProfileId,   $isPerformAction = false  )

static

Returns

CHECK_ACTION_RESULT_ALLOWED if access is granted or error message if access is forbidden.

isAllowedDelete()

static BxDolAccount::isAllowedDelete (   $iProfileId,   $aContentInfo,   $isPerformAction = false  )

static

Returns

CHECK_ACTION_RESULT_ALLOWED if access is granted or error message if access is forbidden.

isAllowedEdit()

static BxDolAccount::isAllowedEdit (   $iProfileId,   $aContentInfo,   $isPerformAction = false  )

static

Returns

CHECK_ACTION_RESULT_ALLOWED if access is granted or error message if access is forbidden.

isConfirmed()

BxDolAccount::isConfirmed

(

$iAccountId = false

)

Check if account is confirmed, it is checked by email confirmation

isOnline()

BxDolAccount::isOnline

(

$iAccountId = false

)

Is account online

isProfilesLimitReached()

BxDolAccount::isProfilesLimitReached

(

)

Check if profiles limit reached

sendConfirmationEmail()

BxDolAccount::sendConfirmationEmail

(

$iAccountId = false

)

Send "confirmation" email

updateEmailConfirmed()

BxDolAccount::updateEmailConfirmed	(		$isConfirmed,
			$isAutoSendConfrmationEmail = true,
			$iAccountId = false
	)

Set account email to confirmed or unconfirmed

Parameters

int	$isConfirmed	- false: mark email as unconfirmed, true: as confirmed
int	$iAccountId	- optional account id

Returns

true on success or false on error

updatePassword()

BxDolAccount::updatePassword	(		$sPassword,
			$iAccountId = false
	)

Change account password

Parameters

string	$sPassword	- new password
int	$iAccountId	- optional account id

Returns

true on success or false on error

updatePhone()

BxDolAccount::updatePhone	(		$sPhone,
			$iAccountId = false
	)

Set account phone

Parameters

string	$sPhone	- phone number
int	$iAccountId	- optional account id

Returns

true on success or false on error

updatePhoneConfirmed()

BxDolAccount::updatePhoneConfirmed	(		$isConfirmed,
			$iAccountId = false
	)

Set account phone to confirmed or unconfirmed

Parameters

int	$isConfirmed	- false: mark phone as unconfirmed, true: as confirmed
int	$iAccountId	- optional account id

Returns

true on success or false on error

updateProfileContextAuto()

BxDolAccount::updateProfileContextAuto	(		$iProfileIdFilterOut = false,
			$iAccountId = false
	)

Switch context automatically to the first available profile

Parameters

$iProfileIdFilterOut	profile ID to exclude from the list of possible profiles
$iAccountId	account ID to use istead of current account

Returns

true on success or false on error

---

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

• inc/classes/BxDolAccount.php