File: README-ES.md

Recommend this page to a friend!

README-ES.md

File:	`README-ES.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:	7 years ago
Size:	`5,788 bytes`

Download

HTTP Request Logger � Eliasis PHP Framework plugin

English version

Guarda informaci�n sobre peticiones HTTP en la base de datos.

Requisitos
Instalaci�n
Uso
Tests
Tareas pendientes
Contribuir
Licencia
Copyright

Requisitos

Este plugin es soportado por versiones de PHP 5.6 o superiores y es compatible con versiones de HHVM 3.0 o superiores.

Instalaci�n

La mejor forma de instalar este plugin es a trav�s de Composer.

Para instalar HTTP Request Logger, simplemente escribe:

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

El comando anterior s�lo instalar� los archivos necesarios, si prefieres descargar todo el c�digo fuente puedes utilizar:

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

Tambi�n puedes clonar el repositorio completo con Git:

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

Uso

Para utilizar este plugin, tu aplicaci�n Eliasis debes utilizar la biblioteca PHP-Database y agregar lo siguiente en los archivos de configuraci�n de la aplicaci�n:

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

    'plugin' => [

        'http-request-logger' => [

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

Esto crear� la tabla test_request y autom�ticamente guardar� todas las peticiones HTTP recibidas en el sitio.

La estructura de la tabla creada es la siguiente:

| 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

Para ejecutar las pruebas necesitar�s Composer y seguir los siguientes pasos:

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

$ cd http-request-logger

$ composer install

Ejecutar pruebas unitarias con PHPUnit:

$ composer phpunit

Ejecutar pruebas de est�ndares de c�digo PSR2 con PHPCS:

$ composer phpcs

Ejecutar pruebas con PHP Mess Detector para detectar inconsistencias en el estilo de codificaci�n:

$ composer phpmd

Ejecutar todas las pruebas anteriores:

$ composer tests

? Tareas pendientes

[ ] Agregar m�todos de obtenci�n (getter).
[ ] A�adir nueva funcionalidad.
[ ] Mejorar pruebas.
[ ] Mejorar documentaci�n.
[ ] Refactorizar c�digo para las reglas de estilo de c�digo deshabilitadas. Ver phpmd.xml y .php_cs.dist.

Contribuir

Si deseas colaborar, puedes echar un vistazo a la lista de issues o tareas pendientes.

Pull requests

Fork and clone.
Ejecuta el comando `composer install` para instalar dependencias. Esto tambi�n instalar� las dependencias de desarrollo.
Ejecuta el comando `composer fix` para estandarizar el c�digo.
Ejecuta las pruebas.
Crea una nueva rama (branch), commit, push y env�ame un pull request.