AbstractUser Class Reference

Inheritance diagram for AbstractUser:

Public Member Functions
	getUserId ()
	setUserId ($userId)
	getUserName ()
	setUserName ($userName)
	getUserType ()
	setUserType ($userType)
	isActive ()
	setActive ($active)
	isWebServicesOnly ()
	setWebServicesOnly ($webServicesOnly)
	getRestrictedEntities ()
	setRestrictedEntities ($restrictedEntities)
	getRestrictedDepartments ()
	setRestrictedDepartments ($restrictedDepartments)
	isSsoEnabled ()
	setSsoEnabled ($ssoEnabled)
	getSsoFederatedUserId ()
	setSsoFederatedUserId ($ssoFederatedUserId)
Public Member Functions inherited from AbstractFunction
	getControlId ()
	setControlId (string $controlId='')
	__construct (string $controlId='')
	writeXml (XMLWriter &$xml)
	getControlId ()
	setControlId (string $controlId)
	writeXml (XMLWriter &$xml)

Data Fields
const	USER_TYPE_BUSINESS = 'business user'
const	USER_TYPE_EMPLOYEE = 'employee user'
const	USER_TYPE_PROJECT_MANAGER = 'project manager user'
const	USER_TYPE_PAYMENT_APPROVER = 'payment approver'
const	USER_TYPE_PLATFORM = 'platform user'
const	USER_TYPE_CRM = 'CRM user'

Protected Attributes
	$userId
	$userName
	$userType
	$active
	$webServicesOnly
	$restrictedEntities = []
	$restrictedDepartments = []
	$ssoEnabled
	$ssoFederatedUserId
Protected Attributes inherited from AbstractFunction
	$controlId = ''

Member Function Documentation

getRestrictedDepartments()

getRestrictedDepartments

(

)

Returns

string[]

getRestrictedEntities()

getRestrictedEntities

(

)

Returns

string[]

getSsoFederatedUserId()

getSsoFederatedUserId

(

)

Get single sign on federated user ID

Returns

string

getUserId()

getUserId

(

)

Get user ID

Returns

string

getUserName()

getUserName

(

)

Get user name

Returns

string

getUserType()

getUserType

(

)

Get user type

Returns

string

isActive()

isActive

(

)

Get active

Returns

bool

isSsoEnabled()

isSsoEnabled

(

)

Get single sign on enabled

Returns

bool

isWebServicesOnly()

isWebServicesOnly

(

)

Get web services only

Returns

bool

setActive()

setActive

(

$active

)

Set active

Parameters

bool

$active

setRestrictedDepartments()

setRestrictedDepartments

(

$restrictedDepartments

)

Parameters

string[]

$restrictedDepartments

setRestrictedEntities()

setRestrictedEntities

(

$restrictedEntities

)

Parameters

string[]

$restrictedEntities

setSsoEnabled()

setSsoEnabled

(

$ssoEnabled

)

Set single sign on enabled

Parameters

bool

$ssoEnabled

setSsoFederatedUserId()

setSsoFederatedUserId

(

$ssoFederatedUserId

)

Set single sign on federated user ID

Parameters

string

$ssoFederatedUserId

setUserId()

setUserId

(

$userId

)

Set user ID

Parameters

string

$userId

setUserName()

setUserName

(

$userName

)

Set user name

Parameters

string

$userName

setUserType()

setUserType

(

$userType

)

Set user type

Parameters

string

$userType

setWebServicesOnly()

setWebServicesOnly

(

$webServicesOnly

)

Set web services only

Parameters

bool

$webServicesOnly

Field Documentation

$active

$active

protected

$restrictedDepartments

$restrictedDepartments = []

protected

$restrictedEntities

$restrictedEntities = []

protected

$ssoEnabled

$ssoEnabled

protected

$ssoFederatedUserId

$ssoFederatedUserId

protected

$userId

$userId

protected

$userName

$userName

protected

$userType

$userType

protected

$webServicesOnly

$webServicesOnly

protected

USER_TYPE_BUSINESS

const USER_TYPE_BUSINESS = 'business user'

USER_TYPE_CRM

const USER_TYPE_CRM = 'CRM user'

USER_TYPE_EMPLOYEE

const USER_TYPE_EMPLOYEE = 'employee user'

USER_TYPE_PAYMENT_APPROVER

const USER_TYPE_PAYMENT_APPROVER = 'payment approver'

USER_TYPE_PLATFORM

const USER_TYPE_PLATFORM = 'platform user'

USER_TYPE_PROJECT_MANAGER

const USER_TYPE_PROJECT_MANAGER = 'project manager user'