Loggable Interface Reference

Inheritance diagram for Loggable:

Static Public Member Functions
static	logFormat (LogEvent $event)
static	logSearch ($needle, $action_name=null)

Detailed Description

Loggable This interface provides necessary functions to use the Stud.IP internal logging.

See also

StudipLog

Member Function Documentation

logFormat()

static logFormat ( LogEvent  $event )

static

This function is used to format the info_template of the action used by the given event and its properties. It is the first step in the formatting process. It returns a string that will be formatted by the replacements for the Stud.IP standard objects (e.g. User, Seminar, Institute,...). See LogEvent::formatEvent().

Parameters

LogEvent

$event

Implemented in MVV.

logSearch()

static logSearch (   $needle,   $action_name = null  )

static

This function is used to search for objects related to log events. The search has to accept a string as part of the name or the id of the object. See search functions in StudipLog.

Parameters

string	$needle	The needle to search for (object id or part of the name)
string	$action_name	The name of the action.

Implemented in MVV.

---

The documentation for this interface was generated from the following file:

• lib/classes/Loggable.class.php