<?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.log');
jimport('joomla.log.logger');

// Register the JLoggerFormattedText class with the autoloader.
JLoader::register('JLoggerFormattedText', dirname(__FILE__).'/formattedtext.php');

/**
 * Joomla! W3C Logging class
 *
 * This class is designed to build log files based on the W3C specification
 * at: http://www.w3.org/TR/WD-logfile.html
 *
 * @package     Joomla.Platform
 * @subpackage  Log
 * @since       11.1
 */
class JLoggerW3C extends JLoggerFormattedText
{
    /**
     * @var    string  The format which each entry follows in the log file.  All fields must be
     *                 named in all caps and be within curly brackets eg. {FOOBAR}.
     * @since  11.1
     */
    protected $format = '{DATE} {TIME}  {PRIORITY}  {CLIENTIP}  {CATEGORY}  {MESSAGE}';

    /**
     * Constructor.
     *
     * @param   array  $options  Log object options.
     *
     * @return  void
     *
     * @since   11.1
     */
    public function __construct(array & $options)
    {
        // The name of the text file defaults to 'error.w3c.php' if not explicitly given.
        if (empty($options['text_file'])) {
            $options['text_file'] = 'error.w3c.php';
        }

        // Call the parent constructor.
        parent::__construct($options);
    }
}