File: README.md

Recommend this page to a friend!

README.md

File:	`README.md`
Role:	Documentation
Content type:	`text/markdown`
Description:	Documentation
Class:	PHP HTTP Request Logger Store details about the HTTP request in a database
Author:	By Josantonius
Last change:
Date:	6 years ago
Size:	`5,274 bytes`

Download

HTTP Request Logger � Eliasis PHP Framework plugin

Versi�n en espa�ol

Save HTTP request information to the database.

Requirements
Installation
Usage
Tests
TODO
Contribute
License
Copyright

Requirements

This plugin 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 HTTP Request Logger, simply:

$ composer require eliasis-framework/http-request-logger

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

$ composer require eliasis-framework/http-request-logger --prefer-source

You can also clone the complete repository with Git:

$ git clone https://github.com/eliasis-framework/http-request-logger.git

Usage

To use this plugin, your Eliasis application must use the PHP-Database library and add the following to the application configuration files:

/
 * eliasis-app/config/complements.php
 */
return [

    'plugin' => [

        'http-request-logger' => [

            'db-id' => 'app',
            'db-prefix' => 'test_',
            'db-charset' => 'utf8',
            'db-engine' => 'innodb'
        ],
    ],
];

This will create the test_request table and automatically save all HTTP requests.

The table structure created is as follows:

| request_id | request_ip | request_uri | request_protocol | request_method | request_referer | request_user_agent | request_http_state | request_load_time | created | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | | 1 | 87.142.85.70 | /sample-app/ | HTTP/1.1 | GET | http://www.google.es/ | Mozilla/5.0 (...) | 200 | 0.008 | 2018-02-28 08:26:43 |

Tests

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

$ git clone https://github.com/eliasis-framework/http-request-logger.git

$ cd http-request-logger

$ composer install

Run unit tests with PHPUnit:

$ composer phpunit

Run PSR2 code standard tests with PHPCS:

$ composer phpcs

Run PHP Mess Detector tests to detect inconsistencies in code style:

$ composer phpmd

Run all previous tests:

$ composer tests

? TODO

[ ] Add getter methods.
[ ] Add new feature.
[ ] Improve tests.
[ ] Improve documentation.
[ ] Refactor code for disabled code style rules. See phpmd.xml and .php_cs.dist.

Contribute

If you would like to help, please take a look at the list of issues or the To Do checklist.

Pull requests

Fork and clone.
Run the command `composer install` to install the dependencies. This will also install the dev dependencies.
Run the command `composer fix` to excute code standard fixers.
Run the tests.
Create a branch, commit, push and send me a pull request.