https://github.com/ialopezg/logger
Logger Service for PHP
https://github.com/ialopezg/logger
log log-service logger logger-service logging logging-library logging-service
Last synced: 2 months ago
JSON representation
Logger Service for PHP
- Host: GitHub
- URL: https://github.com/ialopezg/logger
- Owner: ialopezg
- License: mit
- Created: 2020-09-21T00:28:54.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2020-09-21T05:13:14.000Z (over 4 years ago)
- Last Synced: 2025-01-20T01:31:56.007Z (4 months ago)
- Topics: log, log-service, logger, logger-service, logging, logging-library, logging-service
- Language: PHP
- Homepage:
- Size: 10.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Logger Service
[](https://packagist.org/packages/ialopezg/logger)
[](LICENSE.txt)
Logger Service for PHP. Easily and customizable logger service. Allow to you write log files, in custom paths or directories, file extension, date format, message indentation and several levels.
**Table of Contents**
- [Requirements](#requirements)
- [Installation](#installation)
- [Usage](#basic-usage)
- [Options](#options)
- [Methods details](#method-details)
- [License](#license)
## Requirements
* PHP 5.6+
## Installation
Install latest version via composer:
```shell script
composer require ialopezg/logger
```
## Usage instructions
### Basic usage
First, create a new "Logger" instance. Logger aims to make configuring the library as easy as possible.
```php
$logger = new \ialopezg\Services\Logger([
'log_path' => 'logs'
]);
```
For more options see [examples](examples) directory.
### Options
This is a list of possible options that can be passed when creating a logger instance:
* `enabled` if logger can write to the log files. Default: `true`.
* `log_date_format` log date format. Default: `Y-m-d H:i:s`.
* `log_file_extension` log file extension. Default: `log`.
* `log_path:` log path where log files will be written. If not specified or not writable, modify `Logger::enabled` property to `false`.
* `log_file_permissions` log files permissions. Default: `0644`, read and write for owner, read for everybody else.
* `log_indented` message indentation. Default: `true`.
* `log_threshold` log threshold. Default: `1` or `error`. Accepts single values or array of values. Accept single or array of values. Accepted values: `error`, `debug`, `info`, `warning`, `all`.
### Methods
| Method | Description |
|---|---|
| `log()` | Static function that write a log message line into the default log system, new or empty log system. |
| `write()` | Write a log message line. |
#### Method Details
```php
/**
* Log a message into the default log system. If the log system does not exists, will create a new one.
*
* @param int $level log message level. Accepts: `debug`, `error`, `info` and `warning` messages.
* @param string $message log message.
*
* @return bool true if line was successfully wrote, false otherwise.
*/
public static function log($level, $message): bool
```
**Examples**
```php
// debug message
Logger::log('debug', 'Debug message');
// error message
Logger::log('error', 'Error message');
// info message
Logger::log('info', 'Informative message');
// warning message
Logger::log('warning', 'Waring message');
```
```php
/**
* Write a log message line.
*
* @param string $level Error log level.
* @param string $message Error log message.
*
* @return bool True if line was successfully wrote.
*/
public static function write($level, $message): void
```
**Examples**
```php
// debug message
$logger->write('debug', 'Debug message');
// error message
$logger->write('error', 'Error message');
// info message
$logger->write('info', 'Informative message');
// warning message
$logger->write('warning', 'Waring message');
```
## License
This project is under the MIT license. For more information see See [LICENSE](LICENSE).