<?php
/**
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; under version 2
 * of the License (non-upgradable).
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 *
 * Copyright (c) 2002-2008 (original work) Public Research Centre Henri Tudor & University of Luxembourg (under the project TAO & TAO2);
 *               2008-2010 (update and modification) Deutsche Institut für Internationale Pädagogische Forschung (under the project TAO-TRANSFER);
 *               2009-2012 (update and modification) Public Research Centre Henri Tudor (under the project TAO-SUSTAIN & TAO-DEV);
 *               2013 (update and modification) Open Assessment Technologies SA (under the project TAO-PRODUCT);
 *
 */

/**
 * Short description of class common_log_Item
 *
 * @access public
 * @author Joel Bout, <joel.bout@tudor.lu>
 * @package generis

 */
class common_log_Item
{

    /**
     * Short description of attribute datetime
     *
     * @access private
     * @var int
     */
    private $datetime = 0;

    /**
     * Short description of attribute description
     *
     * @access private
     * @var string
     */
    private $description = '';

    /**
     * Short description of attribute severity
     *
     * @access private
     * @var int
     */
    private $severity = 0;

    /**
     * Short description of attribute backtrace
     *
     * @access private
     * @var array
     */
    private $backtrace = [];

    /**
     * Short description of attribute request
     *
     * @access private
     * @var string
     */
    private $request = '';

    /**
     * Short description of attribute tags
     *
     * @access private
     * @var array
     */
    private $tags = [];

    /**
     * Short description of attribute errorFile
     *
     * @access private
     * @var string
     */
    private $errorFile = '';

    /**
     * Short description of attribute errorLine
     *
     * @access private
     * @var int
     */
    private $errorLine = 0;

    /**
     * Short description of method __construct
     *
     * @access public
     * @author Joel Bout, <joel.bout@tudor.lu>
     * @param  string description
     * @param  int severity
     * @param  int datetime
     * @param  string user
     * @param  array backtrace
     * @param  array tags
     * @param  string request
     * @param  string errorFile
     * @param  int errorLine
     * @return mixed
     */
    public function __construct($description, $severity, $datetime, $backtrace = [], $tags = [], $request = "", $errorFile = '', $errorLine = 0)
    {
        if (!is_string($description)) {
            throw new InvalidArgumentException("The description must be a string, " . gettype($description) . " given");
        }
        
        $this->description      = $description;
        $this->severity         = $severity;
        $this->datetime         = $datetime;
        $this->tags             = is_array($tags) ? $tags : [$tags];
        $this->request          = $request;
        $this->errorFile        = $errorFile;
        $this->errorLine        = $errorLine;
        
        // limit backtrace
        if (count($backtrace) > 50) {
            $backtrace = array_slice($backtrace, -50);
        }
        
        $cleanbacktrace = [];
        foreach ($backtrace as $key => $row) {
            if (isset($backtrace[$key]['object'])) {
                unset($backtrace[$key]['object']);
            }
        
            // WARNING
            // do NOT modify the variables in the backtrace directly or
            // objects passed by reference will be modified aswell
            if (isset($backtrace[$key]['args'])) {
                $vars = [];
                foreach ($backtrace[$key]['args'] as $k => $v) {
                    switch (gettype($v)) {
                        case 'boolean':
                        case 'integer':
                        case 'double':
                            $vars[$k] = (string)$v;
                            break;
                        case 'string':
                            $vars[$k] = strlen($v) > 128 ? 'string(' . strlen($v) . ')' : $v;
                            break;
                        case 'class':
                            $vars[$k] = get_class($v);
                            break;
                        default:
                            $vars[$k] = gettype($v);
                    }
                }
                $backtrace[$key]['args'] = $vars;
            }
        }
        $this->backtrace        = $backtrace;
    }

    /**
     * Short description of method getDateTime
     *
     * @access public
     * @author Joel Bout, <joel.bout@tudor.lu>
     * @return int
     */
    public function getDateTime()
    {
        $returnValue = (int) 0;

        $returnValue = $this->datetime;

        return (int) $returnValue;
    }

    /**
     * Short description of method getDescription
     *
     * @access public
     * @author Joel Bout, <joel.bout@tudor.lu>
     * @return string
     */
    public function getDescription()
    {
        $returnValue = (string) '';

        $returnValue = $this->description;

        return (string) $returnValue;
    }

    /**
     * Short description of method getSeverity
     *
     * @access public
     * @author Joel Bout, <joel.bout@tudor.lu>
     * @return int
     */
    public function getSeverity()
    {
        $returnValue = (int) 0;

        $returnValue = $this->severity;

        return (int) $returnValue;
    }

    /**
     * Short description of method getBacktrace
     *
     * @access public
     * @author Joel Bout, <joel.bout@tudor.lu>
     * @return array
     */
    public function getBacktrace()
    {
        $returnValue = [];

        $returnValue = $this->backtrace;

        return (array) $returnValue;
    }

    /**
     * Short description of method getRequest
     *
     * @access public
     * @author Joel Bout, <joel.bout@tudor.lu>
     * @return string
     */
    public function getRequest()
    {
        $returnValue = (string) '';

        $returnValue = $this->request;

        return (string) $returnValue;
    }

    /**
     * Short description of method getCallerFile
     *
     * @access public
     * @author Joel Bout, <joel.bout@tudor.lu>
     * @return string
     */
    public function getCallerFile()
    {
        $returnValue = (string) '';

        $returnValue = $this->errorFile;

        return (string) $returnValue;
    }

    /**
     * Short description of method getCallerLine
     *
     * @access public
     * @author Joel Bout, <joel.bout@tudor.lu>
     * @return int
     */
    public function getCallerLine()
    {
        $returnValue = (int) 0;

        $returnValue = $this->errorLine;

        return (int) $returnValue;
    }

    /**
     * Short description of method getTags
     *
     * @access public
     * @author Joel Bout, <joel.bout@tudor.lu>
     * @return array
     */
    public function getTags()
    {
        $returnValue = [];

        $returnValue = $this->tags;

        return (array) $returnValue;
    }

    /**
     * Short description of method getSeverityDescriptionString
     *
     * @access public
     * @author Joel Bout, <joel.bout@tudor.lu>
     * @return string
     */
    public function getSeverityDescriptionString()
    {
        $returnValue = (string) '';

        switch ($this->severity) {
            case common_Logger::TRACE_LEVEL:
                $returnValue = "TRACE";
                break;
            case common_Logger::DEBUG_LEVEL:
                $returnValue = "DEBUG";
                break;
            case common_Logger::INFO_LEVEL:
                $returnValue = "INFO";
                break;
            case common_Logger::WARNING_LEVEL:
                $returnValue = "WARNING";
                break;
            case common_Logger::ERROR_LEVEL:
                $returnValue = "ERROR";
                break;
            case common_Logger::FATAL_LEVEL:
                $returnValue = "FATAL";
                break;
            default:
                $returnValue = "UNKNOWN";
        }

        return (string) $returnValue;
    }
}