Synopsis

bool plexcel_log(int $log_level, string $msg)

Description

The plexcel_log function writes a message to the Plexcel log file provided that the internal log level allows it.

The $log_level parameter is an integer representing the level and category of the message. This value is compared to the corresponding plexcel.log.level property set in /etc/php.d/plexcel.ini or in the php.ini file.

A $log_level of 1 is the simplest way to write a message to the Plexcel log file. For more advanced logging, the category may also be specified as described below.

The lower 8 bits of the $log_level is the level. The upper 24 bits is the category. If the category of either the $log_level value or the internal plexcel.log.level value is 0 , then only the priority is considered.

The following table lists category values and their meaning.

The $msg parameter is the message to be written to the log.

Returns

The plexcel_log function returns FALSE if an error occurs. Otherwise, TRUE is returned.

Example

The following PHP fragment writes the QUERY_STRING of a request to the Plexcel log file provided that the plexcel.log.level is less than or equal to 1 .

plexcel_log(1, 'test.php request params: ' . $_SERVER['QUERY_STRING']);