PHP Class ThreeScaleAuthorizeResponseUsageReport

One object of this class always corresponds to one usage limit defined on the plan.

Public Methods

Method	Description
getCurrentValue ( ) : integer	The value the application alredy spent in the current period of the usage limit.
getMaxValue ( ) : integer	Maximum value allowed by the usage limit for the current period.
getMetric ( )	Name of the metric the usage limit is defined for.
getPeriod ( )	The period of the usage limit.
getPeriodEnd ( ) : integer	End of the current period of the usage limit, as unix timestamp.
getPeriodStart ( ) : integer	Start of the current period of the usage limit, as unix timestamp.
isExceeded ( )	Is the usage limit corresponding to this report exceeded?
setCurrentValue ( $value )
setMaxValue ( $value )
setMetric ( $metric )
setPeriod ( $period )
setPeriodInterval ( $start, $end )

The value the application alredy spent in the current period of the usage limit.

public getCurrentValue ( ) : integer
return	integer

Maximum value allowed by the usage limit for the current period.

public getMaxValue ( ) : integer
return	integer

Name of the metric the usage limit is defined for.

public getMetric ( )

The period of the usage limit.

public getPeriod ( )

End of the current period of the usage limit, as unix timestamp.

public getPeriodEnd ( ) : integer
return	integer	(unit timestamp)

Start of the current period of the usage limit, as unix timestamp.

public getPeriodStart ( ) : integer
return	integer	(unit timestamp)

Is the usage limit corresponding to this report exceeded?

public isExceeded ( )

public setCurrentValue ( $value )

public setMaxValue ( $value )

public setMetric ( $metric )

public setPeriod ( $period )

public setPeriodInterval ( $start, $end )