zguillez/php-xmlog

PHP module for create XML and LOG files

1.1.2 2016-09-09 12:18 UTC

README

Dependency Status License Join the chat at https://gitter.im/zguillez/php-xmlog

PHP module for create XML and LOG files

Getting Started

Add package to composer.json

composer require zguillez/php-xmlog

//packaje.json
{
    "require": {
        "zguillez/php-xmlog": "^1.1.0"
    }
}

Usage:

require 'vendor/autoload.php';

use Z\Log;

$params["filename"] = "register";
$params["path"] = "./logs/";

$log = new Log($params);

On this example, "register" is the name of the log file and "./logs" is the folder on this files will be saved. This folder must exits and have write permitions.

$log->insert('This is an update!');

This will create a file "register.log" with the text "This is an update!".

For create a XML file instead LOG file:

$params["type"] = Log::XML;

Options (true/false):

1 dated:

$params["dated"]  = true;

Create a dated file name:

  • true: register_2016-03-12_17:10:17.log
  • false (default): register.log

2 clear:

$params["clear"]  = true;

Overwrite last file:

  • true: register.log (overwrite the file with new log text)
  • false (default): register.log (new log text will added in new line)

3 backup:

$params["backup"] = true;

Backup last file:

  • true: register_2016-03-12_17:10:17_backup.log
  • false (default): (no backup file)

Configuration:

You can override the log options by a config function.

$log->config(["dated"=>true]);

Example:

require 'vendor/autoload.php';

$params["type"]   = Log::LOG;
$params["filename"]   = "register";
$params["path"]   = "./logs/";
$params["dated"]  = false;
$params["clear"]  = false;
$params["backup"] = false;

$log = new Log($params);

$log->config(["dated"=>true]);

$log->insert('This is update one!');
$log->insert('This is update two!');

Contributing and issues

Contributors are welcome, please fork and send pull requests! If you have any ideas on how to make this project better then please submit an issue or send me an email.

License

©2016 Zguillez.io

Original code licensed under MIT Open Source projects used within this project retain their original licenses.

Changelog

v1.1.0 (September 9, 2016)

  • Configuration object

v1.0.0 (March 12, 2016)

  • Initial implementation

Analytics