PHP Class Scalr\LogCollector\AuditLogger

Inheritance: extends AbstractLogger
Show file Open project: scalr/scalr

Public Methods

Method Description
__construct ( AuditLoggerConfiguration $config ) Constructor. Instantiates AuditLogger, prepares backend
setAccountId ( integer $accountId ) : AuditLogger Sets identifier of the Account
setEnvironmentId ( integer $envId ) : AuditLogger Sets identifier of the Environment
setRequestType ( string $requestType ) : AuditLogger Sets request type
setRuid ( integer $ruid ) : AuditLogger Sets user identifier
setSystemTask ( string $systemTask ) : AuditLogger Sets system task
setUser ( Scalr_Account_User $user ) : AuditLogger Sets user object

Protected Methods

Method Description
getCommonData ( )
handleScriptExecute ( array $script, DBServer $targetServer, integer $taskId = null, AbstractServerEvent $event = null ) : array script.execute handler
handlerFarmLaunch ( Farm | DBFar\DBFarm $farm, array $additional = null ) : array farm.launch | farm.terminate handler
handlerUserAuthLogin ( Scalr_Account_Use\Scalr_Account_User | User $user ) : array user.auth.login handler
initializeSubscribers ( )

Method Details

__construct() public method

Constructor. Instantiates AuditLogger, prepares backend
public __construct ( AuditLoggerConfiguration $config )
$config AuditLoggerConfiguration Audit logger config data

getCommonData() protected method

See also: AbstractLogger::getCommonData()
protected getCommonData ( )

handleScriptExecute() protected method

script.execute handler
protected handleScriptExecute ( array $script, DBServer $targetServer, integer $taskId = null, AbstractServerEvent $event = null ) : array
$script array Script settings
$targetServer DBServer Target server object
$taskId integer optional Scheduler task identifier
$event AbstractServerEvent optional Event object
return array Returns array of the fields to log

handlerFarmLaunch() protected method

farm.launch | farm.terminate handler
protected handlerFarmLaunch ( Farm | DBFar\DBFarm $farm, array $additional = null ) : array
$farm Scalr\Model\Entity\Farm | DBFar\DBFarm Farm instance
$additional array Additional fields to log
return array Returns array of the fields to log

handlerUserAuthLogin() protected method

user.auth.login handler
protected handlerUserAuthLogin ( Scalr_Account_Use\Scalr_Account_User | User $user ) : array
$user Scalr_Account_Use\Scalr_Account_User | Scalr\Model\Entity\Account\User User object
return array Returns array of the fields to log

initializeSubscribers() protected method

See also: AbstractLogger::initializeSubscribers()
protected initializeSubscribers ( )

setAccountId() public method

Sets identifier of the Account
public setAccountId ( integer $accountId ) : AuditLogger
$accountId integer Identifier of the User's Account
return AuditLogger

setEnvironmentId() public method

Sets identifier of the Environment
public setEnvironmentId ( integer $envId ) : AuditLogger
$envId integer Identifier of the User's Environment
return AuditLogger

setRequestType() public method

Sets request type
public setRequestType ( string $requestType ) : AuditLogger
$requestType string Request type
return AuditLogger

setRuid() public method

Sets user identifier
public setRuid ( integer $ruid ) : AuditLogger
$ruid integer Real user identifier
return AuditLogger

setSystemTask() public method

Sets system task
public setSystemTask ( string $systemTask ) : AuditLogger
$systemTask string System task
return AuditLogger

setUser() public method

Sets user object
public setUser ( Scalr_Account_User $user ) : AuditLogger
$user Scalr_Account_User User object
return AuditLogger