PHP Class Scalr\Stats\CostAnalytics\Events\AbstractEvent

Since: 5.0
Author: Vlad Dobrovolskiy ([email protected])
Show file Open project: scalr/scalr Class Usage Examples

Protected Properties

Property Type Description
$ccs array Cost Centers array
$environment Scalr_Environment Current environment
$message string Event message
$messageToHash string Message for hashing
$projects array Projects array
$timelineEvent Scalr\Stats\CostAnalytics\Entity\TimelineEventEntity Generated event
$user Scalr_Account_User User who fires an event

Public Methods

Method Description
__construct ( ) Constructor
fire ( ) : boolean Fires an event
getUserEmail ( ) : string Gets email address of the user who fires an event

Private Methods

Method Description
callbackFilter ( mixed $value ) : boolean Filter identifiers callback

Method Details

__construct() public method

Constructor
public __construct ( )

fire() public method

Fires an event
public fire ( ) : boolean
return boolean Returns true if a new record has been added

getUserEmail() public method

Gets email address of the user who fires an event
public getUserEmail ( ) : string
return string

Property Details

$ccs protected property

Cost Centers array
protected array $ccs
return array

$environment protected property

Current environment
protected Scalr_Environment $environment
return Scalr_Environment

$message protected property

Event message
protected string $message
return string

$messageToHash protected property

Message for hashing
protected string $messageToHash
return string

$projects protected property

Projects array
protected array $projects
return array

$timelineEvent protected property

Generated event
protected TimelineEventEntity,Scalr\Stats\CostAnalytics\Entity $timelineEvent
return Scalr\Stats\CostAnalytics\Entity\TimelineEventEntity

$user protected property

User who fires an event
protected Scalr_Account_User $user
return Scalr_Account_User