Docs For Class LoggerConfigurationAdapterINI

Description

Implements interfaces:

LoggerConfigurationAdapter

Converts ini configuration files to a PHP array.

These used to be called "properties" files (inherited from log4j), and that file extension is still supported.

version: $Revision$
since: 2.2
license: Apache License, Version 2.0

Located in /configurators/LoggerConfigurationAdapterINI.php (line 33)

Class Constant Summary

ADDITIVITY_PREFIX = "log4php.additivity."

APPENDER_PREFIX = "log4php.appender."

LOGGER_PREFIX = "log4php.logger."

RENDERER_PREFIX = "log4php.renderer."

ROOT_LOGGER_NAME = "root"

ROOT_LOGGER_PREFIX = "log4php.rootLogger"

THRESHOLD_PREFIX = "log4php.threshold"

Variable Summary

mixed $config

Method Summary

void beginsWith ( $str, $sub)

void convert (string $path)

void load (string $url)

void parseAppender (string $key, string $value)

void parseLogger (string $value, string $name)

void parseRenderer (string $key, string $value)

Variables

mixed $config = array() (line 57)

Holds the configuration.

access: private

Methods

beginsWith (line 293)

Helper method. Returns true if $str begins with $sub.

access: private

void beginsWith ( $str, $sub)

$str
$sub

convert (line 85)

Converts the provided INI configuration file to a PHP array config.

throws: LoggerException If the file cannot be loaded or parsed.
access: public

void convert (string $path)

string $path: Path to the config file.

Implementation of:

LoggerConfigurationAdapter::convert(): Converts the configuration file to PHP format usable by the configurator.

load (line 65)

Loads and parses the INI configuration file.

throws: LoggerException
access: private

void load (string $url)

string $url: Path to the config file.

parseAppender (line 229)

Parses an configuration line pertaining to an appender.

Parses the following patterns:

Appender class:

 log4php.appender. =

Appender parameter:

 log4php.appender.. =

Appender threshold:

 log4php.appender..threshold =

Appender layout:

 log4php.appender..layout =

Layout parameter:

 log4php.appender..layout. =

For example, a full appender config might look like:

 log4php.appender.myAppender = LoggerAppenderConsole
 log4php.appender.myAppender.threshold = info
 log4php.appender.myAppender.target = stdout
 log4php.appender.myAppender.layout = LoggerLayoutPattern
 log4php.appender.myAppender.layout.conversionPattern = "%d %c: %m%n"

After parsing all these options, the following configuration can be found under $this->config['appenders']['myAppender']:

 array(
 	'class' => LoggerAppenderConsole,
 	'threshold' => info,
 	'params' => array(
 		'target' => 'stdout'
 	),
 	'layout' => array(
 		'class' => 'LoggerAppenderConsole',
 		'params' => array(
 			'conversionPattern' => '%d %c: %m%n'
 		)
 	)
 )

access: private

void parseAppender (string $key, string $value)

string $key
string $value

parseLogger (line 140)

Parses a logger definition.

Loggers are defined in the following manner:

 log4php.logger. = [], [, , ...]

access: private

void parseLogger (string $value, string $name)

string $value: The configuration value (level and appender-refs).
string $name: Logger name.

parseRenderer (line 284)

Parses a renderer definition.

Renderers are defined as:

 log4php.renderer. =

access: private

void parseRenderer (string $key, string $value)

string $key: log4php.renderer.<renderedClass>
string $value: <renderingClass>

Class Constants

ADDITIVITY_PREFIX = "log4php.additivity." (line 39)

Prefix used for defining logger additivity.

APPENDER_PREFIX = "log4php.appender." (line 51)

Prefix used for defining an appender.

LOGGER_PREFIX = "log4php.logger." (line 48)

Prefix used for defining a logger.

RENDERER_PREFIX = "log4php.renderer." (line 54)

Prefix used for defining a renderer.

ROOT_LOGGER_NAME = "root" (line 36)

Name to assign to the root logger.

ROOT_LOGGER_PREFIX = "log4php.rootLogger" (line 45)

Prefix used for defining the root logger.

THRESHOLD_PREFIX = "log4php.threshold" (line 42)

Prefix used for defining logger threshold.