Contentserv PHP API

CSMonitorObserver
in package

Represents a monitor observer record

Tags
since

CS15

Table of Contents

__construct()  : mixed
Set Monitorobserver
addObservation()  : mixed
Add a Observation from Monitorobservation to var observations
getAdminUrl()  : string
Get value adminurl form Monitorobserver for empty value get url for localhost
getDescription()  : string
Get value Description from Monitorobserver
getDowntimes()  : string
Get value downtimes form Monitorobserver
getHost()  : string
getID()  : int
Get value ID from Monitorobserver
getLabel()  : string
Get Label from Observer
getLastRun()  : string
Get value lastrun from Monitorobserver
getNotify()  : int
Get value notify from Monitorobserver
getNotifyEmail()  : string
Get value notify email from Monitorobserver if empty will get the notification email form global settings
getObservations()  : array<string|int, mixed>
Get observations from CSMonitorObserver
getObserverPlugin()  : CSMonitorObserverPlugin
Get instance of CSMonitorObserverPlugin
getPath()  : string
getRunInterval()  : float
Get value runinterval from Monitorobserver
getServices()  : array<string|int, mixed>
Get Services
getStatus()  : array<string|int, string>
Returns information about a defined service of the observer
getValue()  : mixed
Get value by record name
observe()  : array<string|int, mixed>
Called function observ on CSMonitorObserverPlugin
setLastRun()  : void
Set value lastrun to Monitorobserver
store()  : int
Stores the record in db

Methods

__construct()

Set Monitorobserver

public __construct(Record $record) : mixed
Parameters
$record : Record
Tags
Return values
mixed

addObservation()

Add a Observation from Monitorobservation to var observations

public addObservation(int $ObservationID) : mixed
Parameters
$ObservationID : int
Tags
Return values
mixed

getAdminUrl()

Get value adminurl form Monitorobserver for empty value get url for localhost

public getAdminUrl() : string
Tags
Return values
string

getDescription()

Get value Description from Monitorobserver

public getDescription() : string
Tags
Return values
string

getDowntimes()

Get value downtimes form Monitorobserver

public getDowntimes() : string
Tags
example

02:00-03:30

Return values
string

getHost()

public getHost() : string
Tags
Return values
string

the host name of the AdminUrl

getID()

Get value ID from Monitorobserver

public getID() : int
Tags
Return values
int

getLabel()

Get Label from Observer

public getLabel() : string
Tags
Return values
string

getLastRun()

Get value lastrun from Monitorobserver

public getLastRun() : string
Tags
example

2015-01-13 13:31:29

Return values
string

getNotify()

Get value notify from Monitorobserver

public getNotify() : int
Tags
Return values
int

getNotifyEmail()

Get value notify email from Monitorobserver if empty will get the notification email form global settings

public getNotifyEmail() : string
Tags
Return values
string

getObservations()

Get observations from CSMonitorObserver

public getObservations() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed>

getPath()

public getPath() : string
Tags
Return values
string

the relative path before the admin of the AdminUrl

getRunInterval()

Get value runinterval from Monitorobserver

public getRunInterval() : float
Tags
Return values
float

getServices()

Get Services

public getServices() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed>

getStatus()

Returns information about a defined service of the observer

public getStatus(mixed $sService) : array<string|int, string>
Parameters
$sService : mixed
Tags
Return values
array<string|int, string>

array with info like service, state, duration, etc.

getValue()

Get value by record name

public getValue(string $name) : mixed
Parameters
$name : string
Tags
Return values
mixed

observe()

Called function observ on CSMonitorObserverPlugin

public observe([string $Service = NULL ]) : array<string|int, mixed>
Parameters
$Service : string = NULL
Tags
Return values
array<string|int, mixed>

setLastRun()

Set value lastrun to Monitorobserver

public setLastRun(mixed $time) : void
Parameters
$time : mixed
Tags
example

2015-01-13 13:31:29

Return values
void

store()

Stores the record in db

public store() : int
Tags
Return values
int

the id of the updated or created record


        

Search results