README

A simple logger for php projects

Overview

PHP Logger is a simple package for PHP developers to log. It is implemented based on PSR-3 Standard.

Installation

Using Composer (Recommended)

Read How to use composer in php projects article if you are not familiar with Composer.

Run following command in your project root directory:

composer require miladrahimi/phplogger

Manually

You may use your own autoloader as long as it follows PSR-0 or PSR-4 standards. Just put src directory contents in your vendor directory.

Getting Started

PHPLogger has potential to store logs into different kinds of storage, but for now you can only use directory (filesystem) to store them. Following codes illustrate how to define a directory storage and inject it to Logger class:

use MiladRahimi\PHPLogger\Logger;
use MiladRahimi\PHPLogger\Directory;

$dir = new Directory("./logs/");
$logger = new Logger($dir);

As you see in the code snippet above, you can inject storage via Logger constructor, but if you want to use more storage, you may add them via following method:

$logger->addStorage($my_storage);

Now you may store your first log:

$logger->alert("This is an alert!");

Alert is not only supported log level out of the box, you may see all supported log level out there in PSR-3 page.

Log method

The broader method for logging is Logger::log() method which catches log level as its first parameter. Following example show how to use this method:

use MiladRahimi\PHPLogger\Logger;
use MiladRahimi\PHPLogger\Directory;

$directory = new Directory(__DIR__);
$logger = new Logger($directory);
$logger->log("alert", "This is an alert message!");

To follow standards you may use LogLevel constants which are provided by PSR-3 standard.

use MiladRahimi\PHPLogger\Logger;
use MiladRahimi\PHPLogger\Directory;
use Psr\Log\LogLevel;

$logger = new Logger(new Directory(__DIR__));
$logger->log(LogLevel::ALERT, "This is an error message!");

Context

Context is the third parameter in Logger::log() method and second one for direct level log methods like Log::alert(). This parameter can be an array or an object which you may use to store more details alongside your log message.

License

PHPLogger is created by Milad Rahimi and released under the MIT License.

miladrahimi / phplogger

Maintainers

Details