SecurityGroupManager
extends SecurityGroupManagerAbstraction
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
- $securityGroupDefaults : array<string|int, mixed>
- $securityGroupUseDefaults : bool
- __construct() : mixed
- The Service constructor
- delete() : bool
- fetchAllByProject() : bool
- fromOpenStack() : SecurityGroup
- Fill model from OpenStack
- getAuthenticationManager() : AuthenticationManager
- getOpenStackSecurityGroup() : SecurityGroup
- hasChanged() : bool
- import() : SecurityGroup
- list() : Generator
- logEntry() : Activity
- logEntryWithoutModel() : Activity
- logError() : Activity
- logWarning() : Activity
- refresh() : bool
- retrieveOrImport() : SecurityGroup
- setAuthenticationManager() : OpenStackObjectManager
- setDefaultRules() : SecurityGroup
- setDefaultsPerProject() : bool
- toOpenStack() : SecurityGroup
- Fill OpenStack from Model
- toOpenStackArray() : array<string|int, mixed>
- Return an array to be used vs OpenStack
- log() : array<string|int, Activity>
- create() : void
- getSecurityGroupService() : Service
- 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"
$securityGroupDefaults
private
array<string|int, mixed>
$securityGroupDefaults
$securityGroupUseDefaults
private
bool
$securityGroupUseDefaults
Methods
__construct()
The Service constructor
public
__construct(AuthenticationManager $authenticationManager) : mixed
Parameters
- $authenticationManager : AuthenticationManager
Return values
mixed —delete()
public
delete(SecurityGroup $securityGroup) : bool
Parameters
- $securityGroup : SecurityGroup
Tags
Return values
bool —fetchAllByProject()
public
fetchAllByProject(Project $project) : bool
Parameters
- $project : Project
Tags
Return values
bool —fromOpenStack()
Fill model from OpenStack
public
fromOpenStack(SecurityGroup $securityGroup, SecurityGroup $openStackSecurityGroup) : SecurityGroup
Parameters
- $securityGroup : SecurityGroup
- $openStackSecurityGroup : SecurityGroup
Tags
Return values
SecurityGroup —getAuthenticationManager()
public
getAuthenticationManager() : AuthenticationManager
Return values
AuthenticationManager —getOpenStackSecurityGroup()
public
getOpenStackSecurityGroup(string $id[, bool $retrieve = false ]) : SecurityGroup
Parameters
- $id : string
- $retrieve : bool = false
Tags
Return values
SecurityGroup —hasChanged()
public
hasChanged(SecurityGroup $securityGroup) : bool
Parameters
- $securityGroup : SecurityGroup
Tags
Return values
bool —import()
public
import(string $external_id) : SecurityGroup
Parameters
- $external_id : string
Tags
Return values
SecurityGroup —list()
public
list([array<string|int, mixed>|null $options = null ]) : Generator
Parameters
- $options : array<string|int, mixed>|null = null
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(SecurityGroup $securityGroup[, OperatorResource|null $openStackSecurityGroup = null ]) : bool
Parameters
- $securityGroup : SecurityGroup
- $openStackSecurityGroup : OperatorResource|null = null
Return values
bool —retrieveOrImport()
public
retrieveOrImport(string $external_id[, bool $refresh = false ]) : SecurityGroup
Parameters
- $external_id : string
- $refresh : bool = false
Tags
Return values
SecurityGroup —setAuthenticationManager()
public
setAuthenticationManager([AuthenticationManager|null $authenticationManager = null ]) : OpenStackObjectManager
Parameters
- $authenticationManager : AuthenticationManager|null = null
Return values
OpenStackObjectManager —setDefaultRules()
public
setDefaultRules(SecurityGroup $securityGroup) : SecurityGroup
Parameters
- $securityGroup : SecurityGroup
Tags
Return values
SecurityGroup —setDefaultsPerProject()
public
setDefaultsPerProject(Project $project) : bool
Parameters
- $project : Project
Tags
Return values
bool —toOpenStack()
Fill OpenStack from Model
public
toOpenStack(SecurityGroup $securityGroup, SecurityGroup $openStackSecurityGroup) : SecurityGroup
Parameters
- $securityGroup : SecurityGroup
- $openStackSecurityGroup : SecurityGroup
Return values
SecurityGroup —toOpenStackArray()
Return an array to be used vs OpenStack
public
toOpenStackArray(SecurityGroup $securityGroup) : array<string|int, mixed>
Parameters
- $securityGroup : SecurityGroup
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(SecurityGroup $securityGroup) : void
Parameters
- $securityGroup : SecurityGroup
Tags
Return values
void —getSecurityGroupService()
private
getSecurityGroupService() : Service
Return values
Service —update()
private
update(SecurityGroup $securityGroup) : void
Parameters
- $securityGroup : SecurityGroup