Docs For Class AgentNodeEntryItem

Description

The AgentNodeEntryItem encapsulates data about a log entry

version: $Id: AgentNodeEntryItem.class.php,v 1.8 2007/09/05 19:55:21 adamfranco Exp $
license: GNU General Public License (GPL)
copyright: Copyright © 2005, Middlebury College
since: 3/2/06

Located in /harmoni/core/oki2/logging/AgentNodeEntryItem.class.php (line 23)

Method Summary

object AgentNodeEntryItem (string $category, string $description, [optional $nodeIds = array()])

void addAgentId (object Id $agentId)

void addNodeId (object Id $nodeId)

void addTextToBactrace (string $additionalText)

void addUserIds ()

object IdIterator getAgentIds ([mixed $includeAnonymous = FALSE])

string getBacktrace ()

string getCategory ()

string getDescription ()

object IdIterator getNodeIds ()

void setBacktrace (string $backtrace)

Methods

Constructor AgentNodeEntryItem (line 35)

Constructor

since: 3/2/06
access: public

object AgentNodeEntryItem (string $category, string $description, [optional $nodeIds = array()])

string $category
string $description
optional $nodeIds: array $nodeIds

addAgentId (line 143)

Add an agent Id to this item

since: 3/2/06
access: public

void addAgentId (object Id $agentId)

object Id $agentId

addNodeId (line 119)

Add an node Id to this item

since: 3/2/06
access: public

void addNodeId (object Id $nodeId)

object Id $nodeId

addTextToBactrace (line 107)

Add HTML text to the bactrace, usefull for storing source URLs, etc

since: 8/1/06
access: public

void addTextToBactrace (string $additionalText)

string $additionalText

addUserIds (line 158)

Add the current user ids to this item

since: 3/2/06
access: public

void addUserIds ()

getAgentIds (line 184)

Answer the agents for this item. Anonymous will not be included unless there are no other agents.

since: 3/2/06
access: public

object IdIterator getAgentIds ([mixed $includeAnonymous = FALSE])

getBacktrace (line 77)

Answer the backtrace HTML if available

since: 3/6/06
access: public

string getBacktrace ()

getCategory (line 55)

Answer the category

since: 3/2/06
access: public

string getCategory ()

getDescription (line 66)

Answer the description

since: 3/2/06
access: public

string getDescription ()

getNodeIds (line 130)

Answer the nodes for this item

since: 3/2/06
access: public

object IdIterator getNodeIds ()

setBacktrace (line 90)

Set the backtrace HTML

since: 3/6/06
access: public

void setBacktrace (string $backtrace)

string $backtrace