AcLog
AcLog is a simple, zero-dependency PHP package to log activity to files.
This is not meant for logging errors, this is can be used for logging cronjobs, emails, user activity, etc.
Requirements
- PHP 8.0+
Install
Add this to your existing project:
composer require xy2z/aclog
Basic Usage
use xy2z\AcLog\AcLog;
$aclog = new AcLog(__DIR__ . '/logs');
$aclog->log($var); // can be any type: object, array, string, int, etc.
$aclog->log($var, $foo, $bar, $etc); // as many arguments you want.
Set Options
$aclog = new AcLog(
log_dir: __DIR__ . '/logs',
log_date_format: false,
include_trace: false,
output_method: AcLog::VAR_DUMP,
line_breaks_between_header: 4,
// etc.
);
For more options see the constructor method of the AcLog.php file.
Static Class
It is also possible to use it as a static class, if you prefer.
use xy2z\AcLog\AcLogStatic;
AcLogStatic::setup(__DIR__ . '/logs');
AcLogStatic::log($var);
If you want to set options in the static class, you need to set them as an array.
AcLogStatic::setup([
'log_dir' => __DIR__ . '/logs',
'log_date_format' => false,
'include_trace' => false,
'output_method' => AcLog::VAR_DUMP,
'line_breaks_between_header' => 4,
// etc.
]);
Other than that, it should behave exactly the same as the AcLog class, and all public methods and properties are also available.
Static Alias
If you want a shorter name for the static class, you can alias it.
use xy2z\AcLog\AcLogStatic as acl;
acl::setup(__DIR__ . '/logs');
acl::log($var);
Log Callbacks
You can add callbacks that will be appended to each log() call, examples for this can be user information, request headers, etc. You can add as many callbacks you want.
$aclog = new AcLog($this->logdir);
$aclog->add_log_append_callback(function () {
return 'callback-1.';
});
$aclog->add_log_append_callback(array('MyClass', 'myCallbackMethod'));
Tips
- Consider to zip (7zip is best) the log files after a few days - it will save ALOT of diskspace.
Developing
Pull Requests are welcome, just make sure your code is tested, analysed and fixed - see below.
Remember to make tests for both classes: AcLog and AcLogStatic.
# Fix Coding Standards (php-cs-fixer)
vendor/bin/php-cs-fixer fix
# Analyse code (phpstan)
vendor/bin/phpstan analyse -c phpstan.neon
# Test code (phpunit)
vendor/bin/phpunit tests --testdox
Todo
- badges
- Later: Method for getting options values
- examples dir?
1 Jan 28, 2022
964 Dec 11, 2022
331 Dec 21, 2022
4 Apr 26, 2022
7 Aug 31, 2022
334 Jan 6, 2023
136 Jan 4, 2023
23 Dec 27, 2020
1.4k Dec 30, 2022
41 Jul 29, 2022
356 Dec 30, 2022
76 Sep 28, 2022
68 Dec 15, 2022
7 Jul 25, 2022
37 Nov 6, 2022
30 Jan 6, 2023
0 Jan 9, 2022
20.1k Jan 8, 2023