ExternalUserMapper
extends Mapper
in package
Class ExternalUserMapper.
Mapper class for DB calls used for the external_user table.
Table of Contents
- $db : ADOConnection
- DB connector.
- $logger : MonologWrapper
- Logger object.
- __construct() : mixed
- Mapper constructor.
- delete() : bool
- Delete an external user.
- findByAppid() : array<string|int, mixed>
- Find an external user by application ID.
- findByAppIdEntityExternalId() : ExternalUser
- Find an external user by app ID, external entity name and external ID.
- findById() : ExternalUser
- Find an external user by ID.
- save() : bool
- Save an external user object.
- fetchRow() : mixed
- Perform an SQL statement that expects a single row.
- fetchRows() : array<string|int, mixed>
- Perform an SQL statement that expects multiple rows.
- mapArray() : ExternalUser
- Map a DB results row to this object.
- saveDelete() : bool
- Perform a save or delete.
Properties
$db
DB connector.
protected
ADOConnection
$db
DB Instance.
$logger
Logger object.
protected
MonologWrapper
$logger
Methods
__construct()
Mapper constructor.
public
__construct(ADOConnection $dbLayer, MonologWrapper $logger) : mixed
Parameters
- $dbLayer : ADOConnection
-
DB connection object.
- $logger : MonologWrapper
-
Logger object.
Return values
mixed —delete()
Delete an external user.
public
delete(ExternalUser $externalUser) : bool
Parameters
- $externalUser : ExternalUser
-
ExternalUser object.
Tags
Return values
bool —Success.
findByAppid()
Find an external user by application ID.
public
findByAppid(int $appId) : array<string|int, mixed>
Parameters
- $appId : int
-
Application ID.
Tags
Return values
array<string|int, mixed> —External user object.
findByAppIdEntityExternalId()
Find an external user by app ID, external entity name and external ID.
public
findByAppIdEntityExternalId(int $appId, string $externalEntity, int $externalId) : ExternalUser
Parameters
- $appId : int
-
Application ID.
- $externalEntity : string
-
External entity name.
- $externalId : int
-
External ID.
Tags
Return values
ExternalUser —External user object.
findById()
Find an external user by ID.
public
findById(int $id) : ExternalUser
Parameters
- $id : int
-
External user ID.
Tags
Return values
ExternalUser —External user object.
save()
Save an external user object.
public
save(ExternalUser $user) : bool
Parameters
- $user : ExternalUser
-
ExternalUser object.
Tags
Return values
bool —Success.
fetchRow()
Perform an SQL statement that expects a single row.
protected
fetchRow(string $sql, array<string|int, mixed> $bindParams) : mixed
Parameters
- $sql : string
-
Query string.
- $bindParams : array<string|int, mixed>
-
Array of bind params.
Tags
Return values
mixed —Mapped row.
fetchRows()
Perform an SQL statement that expects multiple rows.
protected
fetchRows(string $sql[, array<string|int, mixed> $bindParams = [] ][, array<string|int, mixed> $params = [] ]) : array<string|int, mixed>
Parameters
- $sql : string
-
Query string.
- $bindParams : array<string|int, mixed> = []
-
Array of bind params.
- $params : array<string|int, mixed> = []
-
Parameters (optional). Example: [ 'filter' => [ 'keyword' => string, 'column' => string, ] 'order_by' => string, 'direction' => string "ASC"|"DESC", 'offset' => int, 'limit' => int, ] NOTE: * This will throw an exception if the sql already contains a WHERE clause and should be calculated separately in these cases. * ['filter']['keyword'] '%' characters in keyword not added to keyword automatically.
Tags
Return values
array<string|int, mixed> —Array of mapped rows.
mapArray()
Map a DB results row to this object.
protected
mapArray(array<string|int, mixed> $row) : ExternalUser
Parameters
- $row : array<string|int, mixed>
-
DB row results object.
Return values
ExternalUser —ExternalUser object.
saveDelete()
Perform a save or delete.
protected
saveDelete(string $sql, array<string|int, mixed> $bindParams) : bool
Parameters
- $sql : string
-
Query string.
- $bindParams : array<string|int, mixed>
-
Array of bind params.
Tags
Return values
bool —Success status.