70 lines
845 B
Markdown
70 lines
845 B
Markdown
|
```yaml
|
||
|
|
module: log
|
||
|
|
version: 1.0
|
||
|
|
requires: null
|
||
|
|
```
|
||
|
|
|
||
|
|
Overview
|
||
|
|
----
|
||
|
|
|
||
|
|
##### 1. Introduction
|
||
|
|
The `log` package allows you to manage multiple log files through simple code.
|
||
|
|
|
||
|
|
|
||
|
|
##### 2. Log format
|
||
|
|
> `timestamp | date | [tag] logmessage`
|
||
|
|
|
||
|
|
Example:
|
||
|
|
> `1481495961 | 2016-12-21 23:39:21 | [api_error] some content message`
|
||
|
|
|
||
|
|
##### 3. Log file location
|
||
|
|
Log files are located at `/build/log/log/{logfile}.php`.
|
||
|
|
|
||
|
|
|
||
|
|
Usage
|
||
|
|
----
|
||
|
|
> 1. Include the autoloader
|
||
|
|
|
||
|
|
```php
|
||
|
|
<?php
|
||
|
|
|
||
|
|
require_once '../autoloader.php';
|
||
|
|
|
||
|
|
...
|
||
|
|
```
|
||
|
|
|
||
|
|
> 2. Load the `Log` class
|
||
|
|
|
||
|
|
```php
|
||
|
|
<?php
|
||
|
|
|
||
|
|
...
|
||
|
|
|
||
|
|
use \log\core\Log;
|
||
|
|
|
||
|
|
```
|
||
|
|
|
||
|
|
> 3. Fetch the log file you want (_"error"_ in this example)
|
||
|
|
|
||
|
|
```php
|
||
|
|
<?php
|
||
|
|
|
||
|
|
...
|
||
|
|
|
||
|
|
Log::get('error');
|
||
|
|
|
||
|
|
...
|
||
|
|
```
|
||
|
|
|
||
|
|
> 3. log something on a specific log file (_"error"_ in this example)
|
||
|
|
|
||
|
|
```php
|
||
|
|
<?php
|
||
|
|
|
||
|
|
...
|
||
|
|
|
||
|
|
Log::get('error')->log('some message', 'optional_tag');
|
||
|
|
|
||
|
|
...
|
||
|
|
```
|