class AbstractUser extends AbstractFunction

Traits

Constants

USER_TYPE_BUSINESS

USER_TYPE_EMPLOYEE

USER_TYPE_PROJECT_MANAGER

USER_TYPE_PAYMENT_APPROVER

USER_TYPE_PLATFORM

USER_TYPE_CRM

Methods

getControlId()

Get control ID

setControlId($controlId = null)

Set control ID

__construct(string $controlId = null)

Initializes the class with the given parameters.

writeXml(XMLWriter $xml)

Write the XML

array
getCustomFields()

Get custom fields

setCustomFields(array $customFields)

Set custom fields

string
getUserId()

Get user ID

setUserId(string $userId)

Set user ID

string
getUserName()

Get user name

setUserName(string $userName)

Set user name

string
getUserType()

Get user type

setUserType(string $userType)

Set user type

boolean
isActive()

Get active

setActive(boolean $active)

Set active

boolean
isWebServicesOnly()

Get web services only

setWebServicesOnly(boolean $webServicesOnly)

Set web services only

array
getRestrictedEntities()

Get restricted entities

setRestrictedEntities(array $restrictedEntities)

Set restricted entities

array
getRestrictedDepartments()

Get restricted departments

setRestrictedDepartments(array $restrictedDepartments)

Set restricted departments

boolean
isSsoEnabled()

Get single sign on enabled

setSsoEnabled(boolean $ssoEnabled)

Set single sign on enabled

string
getSsoFederatedUserId()

Get single sign on federated user ID

setSsoFederatedUserId(string $ssoFederatedUserId)

Set single sign on federated user ID

Details

in AbstractFunction at line line 35
getControlId()

Get control ID

in AbstractFunction at line line 46
setControlId($controlId = null)

Set control ID

Parameters

$controlId

Exceptions

InvalidArgumentException

in AbstractFunction at line line 67
__construct(string $controlId = null)

Initializes the class with the given parameters.

Parameters

string $controlId Control ID, default=random UUID

in AbstractFunction at line line 72
abstract writeXml(XMLWriter $xml)

Write the XML

Parameters

XMLWriter $xml

in CustomFieldsTrait at line line 33
array getCustomFields()

Get custom fields

Return Value

array

in CustomFieldsTrait at line line 43
setCustomFields(array $customFields)

Set custom fields

Parameters

array $customFields

at line line 78
string getUserId()

Get user ID

Return Value

string

at line line 88
setUserId(string $userId)

Set user ID

Parameters

string $userId

at line line 98
string getUserName()

Get user name

Return Value

string

at line line 108
setUserName(string $userName)

Set user name

Parameters

string $userName

at line line 118
string getUserType()

Get user type

Return Value

string

at line line 128
setUserType(string $userType)

Set user type

Parameters

string $userType

at line line 138
boolean isActive()

Get active

Return Value

boolean

at line line 148
setActive(boolean $active)

Set active

Parameters

boolean $active

at line line 158
boolean isWebServicesOnly()

Get web services only

Return Value

boolean

at line line 168
setWebServicesOnly(boolean $webServicesOnly)

Set web services only

Parameters

boolean $webServicesOnly

at line line 178
array getRestrictedEntities()

Get restricted entities

Return Value

array

at line line 188
setRestrictedEntities(array $restrictedEntities)

Set restricted entities

Parameters

array $restrictedEntities

at line line 198
array getRestrictedDepartments()

Get restricted departments

Return Value

array

at line line 208
setRestrictedDepartments(array $restrictedDepartments)

Set restricted departments

Parameters

array $restrictedDepartments

at line line 218
boolean isSsoEnabled()

Get single sign on enabled

Return Value

boolean

at line line 228
setSsoEnabled(boolean $ssoEnabled)

Set single sign on enabled

Parameters

boolean $ssoEnabled

at line line 238
string getSsoFederatedUserId()

Get single sign on federated user ID

Return Value

string

at line line 248
setSsoFederatedUserId(string $ssoFederatedUserId)

Set single sign on federated user ID

Parameters

string $ssoFederatedUserId