PHP Classes
elePHPant
Icontem

File: README-ES.md

Recommend this page to a friend!
  Classes of Josantonius  >  PHP-Ip  >  README-ES.md  >  Download  
File: README-ES.md
Role: Documentation
Content type: text/markdown
Description: Documentation
Class: PHP-Ip
Get the real user IP address even behind proxies
Author: By
Last change: Updated to 1.1.6 version
Updated to 1.1.5 version
Code Refactoring by @MASNathan
Date: 12 days ago
Size: 5,262 bytes
 

Contents

Class file image Download

PHP Ip library

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

English version

Biblioteca PHP para obtener la IP del usuario.

Requisitos

Esta clase es soportada 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 esta extensión es a través de Composer.

Para instalar PHP Ip library, simplemente escribe:

$ composer require Josantonius/Ip

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

$ composer require Josantonius/Ip --prefer-source

También puedes clonar el repositorio completo con Git:

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

O instalarlo manualmente:

Descargar Ip.php:

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

Métodos disponibles

Métodos disponibles en esta biblioteca:

- Obtener IP del usuario:

Ip::get();

# Return (string|false) ? IP o falso

- Validar IP:

Ip::validate($ip);

| Atributo | Descripción | Tipo | Requerido | Predeterminado | --- | --- | --- | --- | --- | | $ip | Dirección IP a validar. | string | Sí | |

# Return (boolean)

Cómo empezar

Para utilizar esta biblioteca con Composer:

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

use Josantonius\Ip\Ip;

Si la instalaste manualmente, utiliza:

require_once __DIR__ . '/Ip.php';

use Josantonius\Ip\Ip;

Uso

Ejemplo de uso para esta biblioteca:

- Obtener IP del usuario:

Ip::get();

- Validar IP:

$ip = Ip::get();

Ip::validate($ip);

Tests

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

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

$ cd PHP-Ip

$ 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

  • [ ] Añadir nueva funcionalidad
  • [ ] Mejorar pruebas
  • [ ] Mejorar documentación
  • [ ] Refactorizar código

Contribuir

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

Pull requests

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

2017 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.