From e376d1e89e23371ded1024ca7194ba703e9b413d Mon Sep 17 00:00:00 2001 From: xdrm-brackets Date: Sun, 11 Dec 2016 23:51:22 +0100 Subject: [PATCH] updated README + init notice for log:1.0 --- README.md | 4 +++ notice/log/1.0.md | 69 +++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 73 insertions(+) create mode 100644 notice/log/1.0.md diff --git a/README.md b/README.md index 8904a2e..0cfd624 100644 --- a/README.md +++ b/README.md @@ -56,6 +56,10 @@ xdrm-framework is based on `all in config` so you will have this structure : > version 2.0 - [documentation](/notice/api/2.0.md) > version 2.2 - [documentation](/notice/api/2.2.md) +#### 3.2 Log - multilog system + +> version 1.0 - [documentation](/notice/log/1.0.md) + #### [3.2] error - error system #### [3.3] database - database wrapper and repository manager diff --git a/notice/log/1.0.md b/notice/log/1.0.md new file mode 100644 index 0000000..2ab9e4d --- /dev/null +++ b/notice/log/1.0.md @@ -0,0 +1,69 @@ +```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 + 2. Load the `Log` class + +```php + 3. Fetch the log file you want (_"error"_ in this example) + +```php + 3. log something on a specific log file (_"error"_ in this example) + +```php +log('some message', 'optional_tag'); + + ... +```