UserManager
extends UserManagerAbstraction
in package
Table of Contents
- $errorLogName : string
- $warningLogName : string
- $apiVersion : string
- API Version
- $authenticationManager : AuthenticationManager
- The authentication manager, used to interact with Open Stack APIs
- $jobsLogName : string
- The name of the log in which we are going to log actions performed by jobs
- __construct() : mixed
- The Service constructor
- delete() : bool
- fromOpenStack() : User
- Fill model from OpenStack
- getAuthenticationManager() : AuthenticationManager
- hasChanged() : bool
- import() : User
- list() : Generator
- logEntry() : Activity
- logEntryWithoutModel() : Activity
- logError() : Activity
- logWarning() : Activity
- refresh() : bool
- retrieveOrImport() : User
- setAuthenticationManager() : OpenStackObjectManager
- toOpenStack() : User
- Fill OpenStack from model
- toOpenStackArray() : array<string|int, mixed>
- Prepare an array to be used vs OpenStack
- log() : array<string|int, Activity>
- create() : void
- getIdentityService() : Service
- getOpenStackUser() : User
- update() : void
Properties
$errorLogName
public
static string
$errorLogName
= "error"
$warningLogName
public
static string
$warningLogName
= "warning"
$apiVersion
API Version
protected
static string
$apiVersion
= 'v1'
$authenticationManager
The authentication manager, used to interact with Open Stack APIs
protected
AuthenticationManager
$authenticationManager
$jobsLogName
The name of the log in which we are going to log actions performed by jobs
protected
string
$jobsLogName
= "jobs"
Methods
__construct()
The Service constructor
public
__construct(AuthenticationManager $authenticationManager) : mixed
Parameters
- $authenticationManager : AuthenticationManager
Return values
mixed —delete()
public
delete(User $user) : bool
Parameters
- $user : User
Return values
bool —fromOpenStack()
Fill model from OpenStack
public
fromOpenStack(User $user, User $openStackUser) : User
Parameters
- $user : User
- $openStackUser : User
Tags
Return values
User —getAuthenticationManager()
public
getAuthenticationManager() : AuthenticationManager
Return values
AuthenticationManager —hasChanged()
public
hasChanged(User $user) : bool
Parameters
- $user : User
Tags
Return values
bool —import()
public
import(string $external_id) : User
Parameters
- $external_id : string
Tags
Return values
User —list()
public
list() : Generator
Return values
Generator —logEntry()
public
static logEntry(Model $model, array<string|int, mixed> $properties, string $description, string $event, string $logName) : Activity
Parameters
- $model : Model
- $properties : array<string|int, mixed>
- $description : string
- $event : string
- $logName : string
Return values
Activity —logEntryWithoutModel()
public
static logEntryWithoutModel(array<string|int, mixed> $properties, string $description, string $event, string $logName) : Activity
Parameters
- $properties : array<string|int, mixed>
- $description : string
- $event : string
- $logName : string
Return values
Activity —logError()
public
static logError(Model $model, array<string|int, mixed> $properties, string $description, string $event) : Activity
Parameters
- $model : Model
- $properties : array<string|int, mixed>
- $description : string
- $event : string
Return values
Activity —logWarning()
public
static logWarning(Model $model, array<string|int, mixed> $properties, string $description, string $event) : Activity
Parameters
- $model : Model
- $properties : array<string|int, mixed>
- $description : string
- $event : string
Return values
Activity —refresh()
public
refresh(User $user[, User|OperatorResource $openStackUser = null ]) : bool
Parameters
- $user : User
- $openStackUser : User|OperatorResource = null
Return values
bool —retrieveOrImport()
public
retrieveOrImport(string $external_id[, bool $refresh = false ]) : User
Parameters
- $external_id : string
- $refresh : bool = false
Tags
Return values
User —setAuthenticationManager()
public
setAuthenticationManager([AuthenticationManager|null $authenticationManager = null ]) : OpenStackObjectManager
Parameters
- $authenticationManager : AuthenticationManager|null = null
Return values
OpenStackObjectManager —toOpenStack()
Fill OpenStack from model
public
toOpenStack(User $user, User $openStackUser) : User
Parameters
- $user : User
- $openStackUser : User
Return values
User —toOpenStackArray()
Prepare an array to be used vs OpenStack
public
toOpenStackArray(User $user) : array<string|int, mixed>
Parameters
- $user : User
Return values
array<string|int, mixed> —log()
protected
log(Model|array<string|int, mixed> $models, array<string|int, mixed> $properties, string $description[, null $logName = null ]) : array<string|int, Activity>
Parameters
- $models : Model|array<string|int, mixed>
- $properties : array<string|int, mixed>
- $description : string
- $logName : null = null
Return values
array<string|int, Activity> —create()
private
create(User $user) : void
Parameters
- $user : User
Return values
void —getIdentityService()
private
getIdentityService() : Service
Return values
Service —getOpenStackUser()
private
getOpenStackUser(string $id[, bool $retrieve = false ]) : User
Parameters
- $id : string
- $retrieve : bool = false
Return values
User —update()
private
update(User $user) : void
Parameters
- $user : User