Eventlog

API Documentation

\GSPPanel\EventLog

This class allows interaction with the eventlogs

Methods

Add(array $params) : void

Add an event to the eventlog

$params requires the following:

  • message: The message(REQUIRED)
  • userid: The affected user's id(optional)
  • runby: The user's id that ran the logged event(optional)
  • type: The type of event, this allows filtering(optional, values: login, gamectrl, usermgmt, gamemgmt, sysmgmt)
  • ugid: The affected user's gameserver id(optional)
  • subuser: If the runby userid is a subuser(optional, true/false)
Parameters
NameTypeDescription
$paramsarray
ViewLog(array $params = array()) : array

Displays the eventlog

$params requires the following:

  • limit: Limit of how many records to return
  • orderby: The column to order the records by
  • userid: User's id to retrieve records for
  • type: The type of records to retrieve
  • runby: The runby user's id
  • ugid: The users gameserver id
  • runbyor: The runby user's id, this one is used for looking for a subuser event
Parameters
NameTypeDescription
$paramsarray
Returns
TypeDescription
array
Documentation was generated by phpDocumentor 2.9.0.