ExternalUser
in package
Class ExternalUser.
DB class for storing external_user row data.
Table of Contents
- $appId : int|null
- External application ID.
- $dataField1 : mixed
- External user data field 1.
- $dataField2 : mixed
- External user data field 2.
- $dataField3 : mixed
- External user data field 3.
- $externalEntity : mixed
- External user external entity type.
- $externalId : mixed
- External user external ID.
- $id : int|null
- External user ID.
- __construct() : mixed
- ExternalUser constructor.
- dump() : array<string|int, mixed>
- Return the values as an associative array.
- getAppId() : int
- Get Application ID.
- getDataField1() : mixed
- Get data field 1.
- getDataField2() : mixed
- Get data field 2.
- getDataField3() : mixed
- Get data field 3.
- getExternalEntity() : mixed
- Get External entity.
- getExternalId() : mixed
- Get External ID.
- getId() : int
- Get External user ID.
- setAppId() : void
- Set application ID.
- setDataField1() : void
- Set data field 1.
- setDataField2() : void
- Set data field 2.
- setDataField3() : void
- Set data field 3.
- setExternalEntity() : void
- Set External entity.
- setExternalId() : void
- Set External ID.
- setId() : void
- Set External user ID.
Properties
$appId
External application ID.
protected
int|null
$appId
Application ID.
$dataField1
External user data field 1.
protected
mixed
$dataField1
Data field 1
$dataField2
External user data field 2.
protected
mixed
$dataField2
Data field 2
$dataField3
External user data field 3.
protected
mixed
$dataField3
Data field 3
$externalEntity
External user external entity type.
protected
mixed
$externalEntity
External entity.
$externalId
External user external ID.
protected
mixed
$externalId
External ID.
$id
External user ID.
protected
int|null
$id
External entity ID.
Methods
__construct()
ExternalUser constructor.
public
__construct([int|null $id = null ][, int|null $appId = null ][, int|null $externalId = null ][, string|null $externalEntity = null ][, string|null $dataField1 = null ][, string|null $dataField2 = null ][, string|null $dataField3 = null ]) : mixed
Parameters
- $id : int|null = null
-
External entity ID.
- $appId : int|null = null
-
Application ID.
- $externalId : int|null = null
-
External ID.
- $externalEntity : string|null = null
-
External entity name.
- $dataField1 : string|null = null
-
Spare data field 1.
- $dataField2 : string|null = null
-
Spare data field 2.
- $dataField3 : string|null = null
-
Spare data field 3.
Return values
mixed —dump()
Return the values as an associative array.
public
dump() : array<string|int, mixed>
Return values
array<string|int, mixed> —External user.
getAppId()
Get Application ID.
public
getAppId() : int
Return values
int —Application ID.
getDataField1()
Get data field 1.
public
getDataField1() : mixed
Return values
mixed —Data field 1.
getDataField2()
Get data field 2.
public
getDataField2() : mixed
Return values
mixed —Data field 2.
getDataField3()
Get data field 3.
public
getDataField3() : mixed
Return values
mixed —Data field 3.
getExternalEntity()
Get External entity.
public
getExternalEntity() : mixed
Return values
mixed —External entity.
getExternalId()
Get External ID.
public
getExternalId() : mixed
Return values
mixed —External ID.
getId()
Get External user ID.
public
getId() : int
Return values
int —External user ID.
setAppId()
Set application ID.
public
setAppId(int $appId) : void
Parameters
- $appId : int
-
Application ID.
Return values
void —setDataField1()
Set data field 1.
public
setDataField1(mixed $dataField1) : void
Parameters
- $dataField1 : mixed
-
Data field 1.
Return values
void —setDataField2()
Set data field 2.
public
setDataField2(mixed $dataField2) : void
Parameters
- $dataField2 : mixed
-
Data field 2.
Return values
void —setDataField3()
Set data field 3.
public
setDataField3(mixed $dataField3) : void
Parameters
- $dataField3 : mixed
-
Data field 3.
Return values
void —setExternalEntity()
Set External entity.
public
setExternalEntity(string $externalEntity) : void
Parameters
- $externalEntity : string
-
External entity.
Return values
void —setExternalId()
Set External ID.
public
setExternalId(mixed $externalId) : void
Parameters
- $externalId : mixed
-
External ID.
Return values
void —setId()
Set External user ID.
public
setId(int $id) : void
Parameters
- $id : int
-
External user ID.