Source for file AgentNodeEntryItem.class.php

<?php
/**
 * @since 3/2/06
 * @package harmoni.osid_v2.logging
 * 
 * @copyright Copyright &copy; 2005, Middlebury College
 * @license http://www.gnu.org/copyleft/gpl.html GNU General Public License (GPL)
 *
 * @version $Id: AgentNodeEntryItem.class.php,v 1.8 2007/09/05 19:55:21 adamfranco Exp $
 */ 
 
/**
 * The AgentNodeEntryItem encapsulates data about a log entry
 * 
 * @since 3/2/06
 * @package harmoni.osid_v2.logging
 * 
 * @copyright Copyright &copy; 2005, Middlebury College
 * @license http://www.gnu.org/copyleft/gpl.html GNU General Public License (GPL)
 *
 * @version $Id: AgentNodeEntryItem.class.php,v 1.8 2007/09/05 19:55:21 adamfranco Exp $
 */
class AgentNodeEntryItem {
        
    /**
     * Constructor
     * 
     * @param string $category 
     * @param string $description 
     * @param optional array $nodeIds
     * @return object 
     * @access public
     * @since 3/2/06
     */
    function AgentNodeEntryItem ( $category, $description, $nodeIds = array() ) {
        ArgumentValidator::validate($category, StringValidatorRule::getRule());
        ArgumentValidator::validate($description, StringValidatorRule::getRule());
        ArgumentValidator::validate($nodeIds, ArrayValidatorRule::getRule());
        
        $this->_category = $category;
        $this->_description = $description;
        $this->_nodeIds = $nodeIds;
        $this->_agentIds = array();
        $this->_backtrace = '';
        $this->_additionalBactraceText = '';
    }
    
    /**
     * Answer the category
     * 
     * @return string 
     * @access public
     * @since 3/2/06
     */
    function getCategory () {
        return $this->_category;
    }
    
    /**
     * Answer the description
     * 
     * @return string 
     * @access public
     * @since 3/2/06
     */
    function getDescription () {
        return $this->_description;
    }
    
    /**
     * Answer the backtrace HTML if available
     * 
     * @return string 
     * @access public
     * @since 3/6/06
     */
    function getBacktrace () {
        return "<div>".$this->_backtrace."</div>\n<div>"
            .$this->_additionalBactraceText."</div>";
    }
    
    /**
     * Set the backtrace HTML
     * 
     * @param string $backtrace 
     * @return void 
     * @access public
     * @since 3/6/06
     */
    function setBacktrace ( $backtrace ) {
        if (is_array($backtrace)) {
            ob_start();
            printDebugBacktrace($backtrace);
            $this->_backtrace = ob_get_clean();
        } else
            $this->_backtrace = $backtrace;
    }
    
    /**
     * Add HTML text to the bactrace, usefull for storing source URLs, etc
     * 
     * @param string $additionalText 
     * @return void 
     * @access public
     * @since 8/1/06
     */
    function addTextToBactrace ($additionalText) {
        $this->_additionalBactraceText .= $additionalText;
    }
    
    /**
     * Add an node Id to this item
     * 
     * @param object Id $nodeId 
     * @return void 
     * @access public
     * @since 3/2/06
     */
    function addNodeId ( $nodeId ) {
        $this->_nodeIds[] =$nodeId;
    }
    
    /**
     * Answer the nodes for this item
     * 
     * @return object IdIterator 
     * @access public
     * @since 3/2/06
     */
    function getNodeIds () {
        $iterator = new HarmoniIterator($this->_nodeIds);
        return $iterator;
    }
    
    /**
     * Add an agent Id to this item
     * 
     * @param object Id $agentId 
     * @return void 
     * @access public
     * @since 3/2/06
     */
    function addAgentId ( $agentId ) {
        foreach ($this->_agentIds as $id) {
            if ($id->isEqual($agentId))
                return;
        }
        $this->_agentIds[] =$agentId;
    }
    
    /**
     * Add the current user ids to this item
     * 
     * @return void 
     * @access public
     * @since 3/2/06
     */
    function addUserIds () {
        $authN = Services::getService("AuthN");
        $authNTypes =$authN->getAuthenticationTypes();
        while ($authNTypes->hasNext())
            $this->addAgentId($authN->getUserId($authNTypes->next()));
        
        // Add the Admin Users if they are acting as another user
        if (isset($_SESSION['__ADMIN_IDS_ACTING_AS_OTHER'])) {
            foreach ($_SESSION['__ADMIN_IDS_ACTING_AS_OTHER'] as $adminId)
                $this->addAgentId($adminId);
            
            $this->_description .= "<div>"
                .implode(", ", $_SESSION['__ADMIN_NAMES_ACTING_AS_OTHER'])
                ." ".((count($_SESSION['__ADMIN_NAMES_ACTING_AS_OTHER']) > 1)?"are":"is")
                ." acting as the current user.</div>";
        }
    }
    
    /**
     * Answer the agents for this item. Anonymous will not be included unless
     * there are no other agents.
     * 
     * @return object IdIterator 
     * @access public
     * @since 3/2/06
     */
    function getAgentIds ( $includeAnonymous = FALSE ) {
        $idManager = Services::getService("Id");
        $idsToReturn = array();
        $anonymousId = $idManager->getId("edu.middlebury.agents.anonymous");
        foreach (array_keys($this->_agentIds) as $key) {
            if (!$anonymousId->isEqual($this->_agentIds[$key]))
                $idsToReturn[] =$this->_agentIds[$key];
        }
        
        if ($includeAnonymous && !count($idsToReturn))
            $idsToReturn[] =$anonymousId;
        
        $iterator = new HarmoniIterator($idsToReturn);
        return $iterator;
    }
}
 
?>