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-Ip Get the real user IP address even behind proxies
Author:	By Josantonius
Last change:	Updated to 1.1.7 version Updated to 1.1.7 version
Date:	6 years ago
Size:	`5,656 bytes`

PHP Ip library

Biblioteca PHP para obtener la IP del usuario.

Esta clase es soportada por versiones de PHP 5.6 o superiores y es compatible con versiones de HHVM 3.0 o superiores.

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:

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

M�todos disponibles en esta biblioteca:

Ip::get();

# Return (string|false) ? IP o falso

Ip::validate($ip);

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

# Return (boolean)

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;

Ejemplo de uso para esta biblioteca:

Ip::get();

$ip = Ip::get();

Ip::validate($ip);

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

[ ] 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.

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.