Skip to content
This repository has been archived by the owner on Jul 31, 2022. It is now read-only.

Latest commit

 

History

History
152 lines (90 loc) · 3.58 KB

README-ES.md

File metadata and controls

152 lines (90 loc) · 3.58 KB

PHP Ip library

Latest Stable Version License

English version

Biblioteca PHP para obtener la IP del usuario.

Tras revisar el código después de unos años, no recomendaría el uso de la clase para un sitio en producción, ya que se dio preferencia a cabeceras fácilmente manipulables por el usuario para obtener la IP.

Si la fiabilidad de la cabecera desde la que se obtendrá la IP no está garantizada, sería mejor utilizar $_SERVER['REMOTE_ADDR'] directamente o desarrollar una solución personalizada.



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

# 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

Patrocinar

Si este proyecto te ayuda a reducir el tiempo de desarrollo, puedes patrocinarme para apoyar mi trabajo 😊

Licencia

Este repositorio tiene una licencia MIT License.

Copyright © 2017-2022, Josantonius