PHP Classes
elePHPant
Icontem

PHP Logger lib: Log errors to files and display messages on a page

Recommend this page to a friend!
  Info   View files Documentation   View files View files (30)   DownloadInstall with Composer Download .zip   Reputation   Support forum   Blog    
Last Updated Ratings Unique User Downloads Download Rankings
2017-11-02 (1 year ago) RSS 2.0 feedNot yet rated by the usersTotal: 145 All time: 8,669 This week: 371Up
Version License PHP version Categories
php-logger-lib 1.1.3MIT/X Consortium ...5.6PHP 5, Logging, PHP 7, PSR
Description Author

This package can log errors to files and display messages on a page.

It can take log messages and append them to a file using JSON as format to save the log message details.

The class can also output the log messages formatted using HTML templates to display them on a Web page.

  Performance   Level  
Name: Josantonius is available for providing paid consulting. Contact Josantonius .
Classes: 31 packages by
Country: Spain Spain
Age: ???
All time rank: 148030 in Spain Spain
Week rank: 166 Up5 in Spain Spain Up
Innovation award
Innovation award
Nominee: 11x

Details

PHP Logger library

Latest Stable Version Latest Unstable Version License Codacy Badge Total Downloads Travis PSR2 PSR4 CodeCov

Spanish version

Php library to create logs easily and store them in Json format.

Requirements

This library is supported by PHP versions 5.6 or higher and is compatible with HHVM versions 3.0 or higher.

Installation

The preferred way to install this extension is through Composer.

To install PHP Logger library, simply:

$ composer require Josantonius/Logger

The previous command will only install the necessary files, if you prefer to download the entire source code you can use:

$ composer require Josantonius/Logger --prefer-source

You can also clone the complete repository with Git:

$ git clone https://github.com/Josantonius/PHP-Logger.git

Or install it manually:

Download Logger.php:

$ wget https://raw.githubusercontent.com/Josantonius/PHP-Logger/master/src/Logger.php

Download Json.php:

$ wget https://raw.githubusercontent.com/Josantonius/PHP-Json/master/src/Json.php

Images

image image image image image

Available Methods

Available methods in this library:

- Initiator for site debug management:

new Logger($path, $filename, $logNumber, $ip, $states);

| Atttribute | Description | Type | Required | Default | --- | --- | --- | --- | --- | | $path | Path name to save file with logs. | string | No | null | | $filename | JSON file name that will save the logs. | string | No | null | | $logNumber | Maximum number of logs to save to file. | int | No | 200 | | $ip | If you want to get to another library. | string | No | null | | $states | Different states for logs. | array | No | null |

# Return (void)

- Save log line:

Logger::save($type, $code, $msg, $line, $file, $data);

| Atttribute | Description | Type | Required | Default | --- | --- | --- | --- | --- | | $type | Error type or warning. | string | Yes | | | $code | HTTP response status code. | int | Yes | | | $message | Message. | string | Yes | | | $line | Line from which the save is executed. | int | Yes | | | $file | Filepath from which the method is called. | string | Yes | | | $data | Extra custom parameters. | array | No | 0 |

# Return (boolean)

- Save logs to Json file:

Logger::store();

# Return (boolean)

- Get saved logs:

Logger::get();

# Return (array) ? logs saved

- Define directory for scripts and get url from file:

Logger::script($url);

| Atttribute | Description | Type | Required | Default | --- | --- | --- | --- | --- | | $url | File url. | string | Yes | |

# Return (string) ? file url

- Define directory for styles and get url from file:

Logger::style($url);

| Atttribute | Description | Type | Required | Default | --- | --- | --- | --- | --- | | $url | File url. | string | Yes | |

# Return (string) ? file url

- Get number of logs added in the current section:

Logger::added();

# Return (int) ? logs added in the current section

- Display logger section:

Logger::render();

# Return (boolean true)

- Reset parameters:

Logger::reset();

# Return (boolean true)

Quick Start

To use this library with Composer:

require __DIR__ . '/vendor/autoload.php';

use Josantonius\Logger\Logger;

Or If you installed it manually, use it:

require_once __DIR__ . '/Logger.php';
require_once __DIR__ . '/Json.php';

use Josantonius\Logger\Logger;

Usage

Example of use for this library:

- Basic example

<?php
require __DIR__ . '/vendor/autoload.php';

use Josantonius\Logger\Logger;

new Logger();

Logger::save('SUCCESS',  100, 'msg', __LINE__, __FILE__);
Logger::save('JOIN',     200, 'msg', __LINE__, __FILE__);
Logger::save('INFO',     300, 'msg', __LINE__, __FILE__);
Logger::save('WARNING',  400, 'msg', __LINE__, __FILE__);
Logger::save('ERROR',    500, 'msg', __LINE__, __FILE__);
Logger::save('FATAL',    600, 'msg', __LINE__, __FILE__);
Logger::save('REQUEST',  700, 'msg', __LINE__, __FILE__);
Logger::save('RESPONSE', 800, 'msg', __LINE__, __FILE__);

Logger::storeLogs();

- Advanced example

<?php
require __DIR__ . '/vendor/autoload.php';

use Josantonius\Logger\Logger;

$states  = [

  'global'    => true,
  'exception' => true,
  'error'     => false,
  'notice'    => false,
  'fatal'     => true,
];

new Logger('/logger/', 'logs', 600, '58.80.84.44', $states);

Logger::save('EXCEPTION', 400, 'msg', __LINE__, __FILE__);
Logger::save('ERROR' ,    402, 'msg', __LINE__, __FILE__);
Logger::save('NOTICE',    100, 'msg', __LINE__, __FILE__);

$params = [

  'id-user'   => 68,
  'name-user' => 'Joe'
]; 
        
Logger::save('FATAL, 500, 'msg', __LINE__, __FILE__, $params);

Logger::storeLogs();

echo 'Logs added: ' . Logger::added();

echo 'Logs added: ' . count(Logger::get);

printf('<link href="%s">', Logger::style('http://site.com/public/css/'));

printf('<script src="%s">', Logger::script('http://site.com/public/js/'));

Logger::render();

Tests

To run tests you just need Composer and to execute the following:

$ git clone https://github.com/Josantonius/PHP-Logger.git

$ cd PHP-Logger

$ composer install

Run unit tests with PHPUnit:

$ composer phpunit

Run PSR2 code standard tests with PHPCS:

$ composer phpcs

Run all previous tests:

$ composer tests

? TODO

  • [x] Create tests
  • [x] Improve documentation

Contribute

  1. Check for open issues or open a new issue to start a discussion around a bug or feature.
  2. Fork the repository on GitHub to start making your changes.
  3. Write one or more tests for the new feature or that expose the bug.
  4. Make code changes to implement the feature or fix the bug.
  5. Send a pull request to get your changes merged and published.

This is intended for large and long-lived objects.

Repository

All files in this repository were created and uploaded automatically with Reposgit Creator.

License

This project is licensed under MIT license. See the LICENSE file for more info.

Copyright

2017 Josantonius, josantonius.com

If you find it useful, let me know :wink:

You can contact me on Twitter or through my email.

  Files folder image Files  
File Role Description
Files folder imagepublic (4 directories)
Files folder imageresources (5 files)
Files folder imagesrc (1 file)
Files folder imagetests (1 file)
Accessible without login Plain text file .editorconfig Data Auxiliary data
Accessible without login Plain text file .travis.yml Data Auxiliary data
Accessible without login Plain text file CHANGELOG.md Data Auxiliary data
Accessible without login Plain text file composer.json Data Auxiliary data
Accessible without login Plain text file CONDUCT.md Data Auxiliary data
Accessible without login Plain text file contributors.txt Doc. Documentation
Accessible without login Plain text file gulpfile.js Data Auxiliary data
Accessible without login Plain text file LICENSE Lic. License text
Accessible without login Plain text file package.json Data Auxiliary data
Accessible without login Plain text file phpcs.ruleset.xml Data Auxiliary data
Accessible without login Plain text file phpunit.xml.dist Data Auxiliary data
Accessible without login Plain text file README-ES.md Doc. Documentation
Accessible without login Plain text file README.md Doc. Documentation
Accessible without login Plain text file _config.yml Data Auxiliary data

  Files folder image Files  /  public  
File Role Description
Files folder imagecss (1 file, 1 directory)
Files folder imagejs (1 file, 1 directory)
Files folder imagesass (1 file, 1 directory)
Files folder imagetemplate (1 file)

  Files folder image Files  /  public  /  css  
File Role Description
Files folder imagesource (2 files)
  Accessible without login Plain text file logger.min.css Data Auxiliary data

  Files folder image Files  /  public  /  css  /  source  
File Role Description
  Accessible without login Plain text file logger.css Data Auxiliary data
  Accessible without login Plain text file logger.css.map Data Auxiliary data

  Files folder image Files  /  public  /  js  
File Role Description
Files folder imagesource (1 file)
  Accessible without login Plain text file logger.min.js Data Auxiliary data

  Files folder image Files  /  public  /  js  /  source  
File Role Description
  Accessible without login Plain text file logger.js Data Auxiliary data

  Files folder image Files  /  public  /  sass  
File Role Description
Files folder imagepartials (2 files)
  Accessible without login Plain text file logger.sass Data Auxiliary data

  Files folder image Files  /  public  /  sass  /  partials  
File Role Description
  Accessible without login Plain text file _colors.sass Data Auxiliary data
  Accessible without login Plain text file _global.sass Data Auxiliary data

  Files folder image Files  /  public  /  template  
File Role Description
  Accessible without login Plain text file logger.php Aux. Auxiliary script

  Files folder image Files  /  resources  
File Role Description
  Accessible without login Image file logger-1.png Data Auxiliary data
  Accessible without login Image file logger-2.png Data Auxiliary data
  Accessible without login Image file logger-3.png Data Auxiliary data
  Accessible without login Image file logger-4.png Data Auxiliary data
  Accessible without login Image file logger-5.png Data Auxiliary data

  Files folder image Files  /  src  
File Role Description
  Plain text file Logger.php Class Class source

  Files folder image Files  /  tests  
File Role Description
  Plain text file LoggerTest.php Class Class source

 Version Control Unique User Downloads Download Rankings  
 100%
Total:145
This week:0
All time:8,669
This week:371Up