Class JLog

Joomla! Log Class

This class hooks into the global log configuration settings to allow for user configured logging events to be sent to where the user wishes them to be sent. On high load sites Syslog is probably the best (pure PHP function), then the text file based loggers (CSV, W3c or plain Formattedtext) and finally MySQL offers the most features (e.g. rapid searching) but will incur a performance hit due to INSERT being issued.

Package: Joomla\Platform\Log
Copyright: Copyright (C) 2005 - 2017 Open Source Matters, Inc. All rights reserved.
License: General Public License version 2 or later; see LICENSE
Since: 11.1
Located at joomla/log/log.php

Methods summary

`protected`	# `__construct( )` Constructor. Constructor. Since 11.1
`public static`	# `add( mixed $entry, integer $priority = JLog::INFO, string $category = '', string $date = null )` Method to add an entry to the log. Method to add an entry to the log. Parameters `$entry` `mixed` - $entry The JLogEntry object to add to the log or the message for a new JLogEntry object. `$priority` `integer` - $priority Message priority. `$category` `string` - $category Type of entry `$date` `string` - $date Date of entry (defaults to now if not specified or blank) Since 11.1
`public static`	# `addLogger( array $options, integer $priorities = JLog::ALL, array $categories = array(), boolean $exclude = false )` Add a logger to the JLog instance. Loggers route log entries to the correct files/systems to be logged. Add a logger to the JLog instance. Loggers route log entries to the correct files/systems to be logged. Parameters `$options` `array` - $options The object configuration array. `$priorities` `integer` - $priorities Message priority `$categories` `array` - $categories Types of entry `$exclude` `boolean` - $exclude If true, all categories will be logged except those in the $categories array Since 11.1
`protected`	# `addLoggerInternal( array $options, integer $priorities = JLog::ALL, array $categories = array(), boolean $exclude = false )` Add a logger to the JLog instance. Loggers route log entries to the correct files/systems to be logged. This method allows you to extend JLog completely. Add a logger to the JLog instance. Loggers route log entries to the correct files/systems to be logged. This method allows you to extend JLog completely. Parameters `$options` `array` - $options The object configuration array. `$priorities` `integer` - $priorities Message priority `$categories` `array` - $categories Types of entry `$exclude` `boolean` - $exclude If true, all categories will be logged except those in the $categories array Since 11.1
`public static`	# `setInstance( JLog $instance )` Returns a reference to the a JLog object, only creating it if it doesn't already exist. Note: This is principally made available for testing and internal purposes. Returns a reference to the a JLog object, only creating it if it doesn't already exist. Note: This is principally made available for testing and internal purposes. Parameters `$instance` `JLog` - $instance The logging object instance to be used by the static methods. Since 11.1
`protected`	# `addLogEntry( JLogEntry $entry )` Method to add an entry to the appropriate loggers. Method to add an entry to the appropriate loggers. Parameters `$entry` `JLogEntry` - $entry The JLogEntry object to send to the loggers. Throws `RuntimeException` Since 11.1
`protected array`	# `findLoggers( integer $priority, string $category )` Method to find the loggers to use based on priority and category values. Method to find the loggers to use based on priority and category values. Parameters `$priority` `integer` - $priority Message priority. `$category` `string` - $category Type of entry Returns `array` - The array of loggers to use for the given priority and category values. Since 11.1

Magic methods summary

Constants summary

`integer`	`ALL`	`30719`	# All log priorities. All log priorities. Since 11.1
`integer`	`EMERGENCY`	`1`	# The system is unusable. The system is unusable. Since 11.1
`integer`	`ALERT`	`2`	# Action must be taken immediately. Action must be taken immediately. Since 11.1
`integer`	`CRITICAL`	`4`	# Critical conditions. Critical conditions. Since 11.1
`integer`	`ERROR`	`8`	# Error conditions. Error conditions. Since 11.1
`integer`	`WARNING`	`16`	# Warning conditions. Warning conditions. Since 11.1
`integer`	`NOTICE`	`32`	# Normal, but significant condition. Normal, but significant condition. Since 11.1
`integer`	`INFO`	`64`	# Informational message. Informational message. Since 11.1
`integer`	`DEBUG`	`128`	# Debugging message. Debugging message. Since 11.1

Properties summary

`protected static JLog`	`$instance`	# The global JLog instance. The global JLog instance. Since 11.1
`protected array`	`$configurations`	# Container for JLogLogger configurations. Container for JLogLogger configurations. Since 11.1
`protected JLogLogger[]`	`$loggers`	# Container for JLogLogger objects. Container for JLogLogger objects. Since 11.1
`protected array`	`$lookup`	# Lookup array for loggers. Lookup array for loggers. Since 11.1

Namespaces

Classes

Interfaces

Exceptions

Constants

Functions

Class JLog

Methods summary

Since

Parameters

Since

Parameters

Since

Parameters

Since

Parameters

Since

Parameters

Throws

Since

Parameters

Returns

Since

Magic methods summary

Constants summary

Since

Since

Since

Since

Since

Since

Since

Since

Since

Properties summary

Since

Since

Since

Since