[Summary view] [Print] [Text view]

   1  <?php
   2  
   3  /**
   4   * Joomla! Content Management System
   5   *
   6   * @copyright  (C) 2011 Open Source Matters, Inc. <https://www.joomla.org>
   7   * @license    GNU General Public License version 2 or later; see LICENSE.txt
   8   */
   9  
  10  namespace Joomla\CMS\Log\Logger;
  11  
  12  // phpcs:disable PSR1.Files.SideEffects
  13  \defined('JPATH_PLATFORM') or die;
  14  // phpcs:enable PSR1.Files.SideEffects
  15  
  16  /**
  17   * Joomla! W3C Logging class
  18   *
  19   * This class is designed to build log files based on the W3C specification.
  20   *
  21   * @link   https://www.w3.org/TR/WD-logfile.html
  22   * @since  1.7.0
  23   */
  24  class W3cLogger extends FormattedtextLogger
  25  {
  26      /**
  27       * The format which each entry follows in the log file.
  28       *
  29       * All fields must be named in all caps and be within curly brackets eg. {FOOBAR}.
  30       *
  31       * @var    string
  32       * @since  1.7.0
  33       */
  34      protected $format = '{DATE}    {TIME}    {PRIORITY}    {CLIENTIP}    {CATEGORY}    {MESSAGE}';
  35  
  36      /**
  37       * Constructor.
  38       *
  39       * @param   array  &$options  Log object options.
  40       *
  41       * @since   1.7.0
  42       */
  43      public function __construct(array &$options)
  44      {
  45          // The name of the text file defaults to 'error.w3c.php' if not explicitly given.
  46          if (empty($options['text_file'])) {
  47              $options['text_file'] = 'error.w3c.php';
  48          }
  49  
  50          // Call the parent constructor.
  51          parent::__construct($options);
  52      }
  53  }