PHP Classes

File: README-ES.md

Recommend this page to a friend!
  Classes of Josantonius   PHP HTTP Request Logger   README-ES.md   Download  
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
Last change:
Date: 4 years ago
Size: 5,788 bytes
 

Contents

Class file image Download

HTTP Request Logger · Eliasis PHP Framework plugin

Packagist Downloads License Codacy Badge Build Status PSR2 PSR4 codecov

English version

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

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.

Repositorio

La estructura de archivos de este repositorio se creó con PHP-Skeleton.

Licencia

Este proyecto está licenciado bajo licencia MIT. Consulta el archivo LICENSE para más información.

Copyright

2016 - 2018 Josantonius, josantonius.com

Si te ha resultado útil, házmelo saber :wink:

Puedes contactarme en Twitter o a través de mi correo electrónico.