FlavorManager
extends FlavorManagerAbstraction
in package
This class will handle the communication between our system and the Open Stack API system.
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() : Flavor
- Fill model from OpenStack
- getAuthenticationManager() : AuthenticationManager
- import() : Flavor
- list() : Generator|array<string|int, mixed>
- This function will retrieve the flavors list form the Open Stack APIs
- logEntry() : Activity
- logEntryWithoutModel() : Activity
- logError() : Activity
- logWarning() : Activity
- refresh() : bool
- retrieveOrImport() : Flavor
- setAuthenticationManager() : OpenStackObjectManager
- log() : array<string|int, Activity>
- getComputeService() : Service
- getOpenStackFlavor() : Flavor
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(Flavor $flavor) : bool
Parameters
- $flavor : Flavor
Tags
Return values
bool —fromOpenStack()
Fill model from OpenStack
public
fromOpenStack(Flavor $flavor, Flavor $openStackFlavor) : Flavor
Parameters
- $flavor : Flavor
- $openStackFlavor : Flavor
Return values
Flavor —getAuthenticationManager()
public
getAuthenticationManager() : AuthenticationManager
Return values
AuthenticationManager —import()
public
import(string $external_id) : Flavor
Parameters
- $external_id : string
Tags
Return values
Flavor —list()
This function will retrieve the flavors list form the Open Stack APIs
public
list() : Generator|array<string|int, mixed>
Return values
Generator|array<string|int, mixed> —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(Flavor $flavor[, Flavor|OperatorResource|null $openStackFlavor = null ]) : bool
Parameters
- $flavor : Flavor
- $openStackFlavor : Flavor|OperatorResource|null = null
Return values
bool —retrieveOrImport()
public
retrieveOrImport(string $external_id[, bool $refresh = false ]) : Flavor
Parameters
- $external_id : string
- $refresh : bool = false
Tags
Return values
Flavor —setAuthenticationManager()
public
setAuthenticationManager([AuthenticationManager|null $authenticationManager = null ]) : OpenStackObjectManager
Parameters
- $authenticationManager : AuthenticationManager|null = null
Return values
OpenStackObjectManager —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> —getComputeService()
private
getComputeService() : Service
Return values
Service —getOpenStackFlavor()
private
getOpenStackFlavor(string $id[, bool $retrieve = false ]) : Flavor
Parameters
- $id : string
- $retrieve : bool = false