<?php
/**
 * @package     Joomla.Platform
 * @subpackage  Log
 *
 * @copyright   Copyright (C) 2005 - 2011 Open Source Matters, Inc. All rights reserved.
 * @license     GNU General Public License version 2 or later; see LICENSE
 */

defined('JPATH_PLATFORM') or die;

jimport('joomla.log.logentry');

/**
 * Joomla! Logger Base Class
 *
 * This class is used to be the basis of logger classes to allow for defined functions
 * to exist regardless of the child class.
 *
 * @package     Joomla.Platform
 * @subpackage  Log
 * @since       11.1
 */
abstract class JLogger
{
    /**
     * @var    array  Options array for the JLog instance.
     * @since  11.1
     */
    protected $options = array();

    /**
     * Constructor.
     *
     * @param   array  $options  Log object options.
     *
     * @return  void
     *
     * @since   11.1
     */
    public function __construct(array & $options)
    {
        // Set the options for the class.
        $this->options = & $options;
    }

    /**
     * Method to add an entry to the log.
     *
     * @param   JLogEntry  The log entry object to add to the log.
     *
     * @return  void
     *
     * @since   11.1
     */
    abstract public function addEntry(JLogEntry $entry);
}