PHP Validate library

English version

Biblioteca PHP para manejo de tipos de datos.

• Requisitos
• Instalación
• Métodos disponibles
• Cómo empezar
• Uso
• Tests
• Tareas pendientes
• Contribuir
• Repositorio
• Licencia
• Copyright

Requisitos

Esta clase es soportada por versiones de PHP 7.0 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 Validate library, simplemente escribe:

$ composer require Josantonius/Validate

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

$ composer require Josantonius/Validate --prefer-source

También puedes clonar el repositorio completo con Git:

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

O instalarlo manualmente:

Descargar Validate.php:

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

Métodos disponibles

Métodos disponibles en esta biblioteca:

- Devolución de parámetros como array:

Validate::asArray($data, $default);

| Atributo | Descripción | Tipo | Requerido | Valor por defecto | --- | --- | --- | --- | --- | | $data | Datos a convertir. | mixed | Sí | | | $default | Valor por defecto en caso de error. | mixed | No | ´null´ |

# Return (mixed|null) ? valor, valor de retorno nulo o personalizado

- Devolución de parámetros como object:

Validate::asObject($data, $default);

| Atributo | Descripción | Tipo | Requerido | Valor por defecto | --- | --- | --- | --- | --- | | $data | Datos a convertir. | mixed | Sí | | | $default | Valor por defecto en caso de error. | mixed | No | ´null´ |

# Return (mixed|null) ? valor, valor de retorno nulo o personalizado

- Devolución de parámetros como JSON:

Validate::asJson($data, $default);

| Atributo | Descripción | Tipo | Requerido | Valor por defecto | --- | --- | --- | --- | --- | | $data | Datos a convertir. | mixed | Sí | | | $default | Valor por defecto en caso de error. | mixed | No | ´null´ |

# Return (mixed|null) ? valor, valor de retorno nulo o personalizado

- Devolución de parámetros como string:

Validate::asString($data, $default);

| Atributo | Descripción | Tipo | Requerido | Valor por defecto | --- | --- | --- | --- | --- | | $data | Datos a convertir. | mixed | Sí | | | $default | Valor por defecto en caso de error. | mixed | No | ´null´ |

# Return (mixed|null) ? valor, valor de retorno nulo o personalizado

- Devolución de parámetros como integer:

Validate::asInteger($data, $default);

| Atributo | Descripción | Tipo | Requerido | Valor por defecto | --- | --- | --- | --- | --- | | $data | Datos a convertir. | mixed | Sí | | | $default | Valor por defecto en caso de error. | mixed | No | ´null´ |

# Return (mixed|null) ? valor, valor de retorno nulo o personalizado

- Devolución de parámetros como float:

Validate::asFloat($data, $default);

| Atributo | Descripción | Tipo | Requerido | Valor por defecto | --- | --- | --- | --- | --- | | $data | Datos a convertir. | mixed | Sí | | | $default | Valor por defecto en caso de error. | mixed | No | ´null´ |

# Return (mixed|null) ? valor, valor de retorno nulo o personalizado

- Devolución de parámetros como boolean:

Validate::asBoolean($data, $default);

| Atributo | Descripción | Tipo | Requerido | Valor por defecto | --- | --- | --- | --- | --- | | $data | Datos a convertir. | mixed | Sí | | | $default | Valor por defecto en caso de error. | mixed | No | ´null´ |

# Return (mixed|null) ? valor, valor de retorno nulo o personalizado

- Devolución de parámetros como IP:

Validate::asIp($data, $default);

| Atributo | Descripción | Tipo | Requerido | Valor por defecto | --- | --- | --- | --- | --- | | $data | Datos a convertir. | mixed | Sí | | | $default | Valor por defecto en caso de error. | mixed | No | ´null´ |

# Return (mixed|null) ? valor, valor de retorno nulo o personalizado

- Devolución de parámetros como URL:

Validate::asUrl($data, $default);

| Atributo | Descripción | Tipo | Requerido | Valor por defecto | --- | --- | --- | --- | --- | | $data | Datos a convertir. | mixed | Sí | | | $default | Valor por defecto en caso de error. | mixed | No | ´null´ |

# Return (mixed|null) ? valor, valor de retorno nulo o personalizado

- Devolución de parámetros como URL:

Validate::asEmail($data, $default);

| Atributo | Descripción | Tipo | Requerido | Valor por defecto | --- | --- | --- | --- | --- | | $data | Datos a convertir. | mixed | Sí | | | $default | Valor por defecto en caso de error. | mixed | No | ´null´ |

# Return (mixed|null) ? valor, valor de retorno nulo o personalizado

Cómo empezar

Para utilizar esta biblioteca con Composer:

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

use Josantonius\Validate\Validate;

Si la instalaste manualmente, utiliza:

require_once __DIR__ . '/Validate.php';

use Josantonius\Validate\Validate;

Uso

Ejemplo de uso para esta biblioteca:

- ARRAY:

- Cuando un array es pasado:

var_dump(Validate::asArray(['foo', 'bar'])); // ['foo', 'bar']

- Cuando un array JSON es pasado:

var_dump(Validate::asArray('["foo", "bar"]')); // ['foo', 'bar']

- Cuando un objeto es pasado:

$data = new \StdClass;

$data->foo = 'bar';

var_dump(Validate::asArray($data)); // ['foo' => 'bar']

- Cuando un objeto JSON es pasado:

var_dump(Validate::asArray('{"foo": "bar"}')); // ['foo' => 'bar']

- Cuando no se pasa un array correcto:

var_dump(Validate::asArray(false)); // null

var_dump(Validate::asArray(false, ['foo', 'bar'])); // ['foo', 'bar']

- OBJECT:

- Cuando un objeto es pasado:

$data = new \StdClass;

$data->foo = 'bar';

$object = Validate::asObject($data);

echo $object->foo; // 'bar'

- Cuando un objeto JSON es pasado:

$object = Validate::asObject('{"foo": "bar"}');

echo $object->foo; // 'bar'

- Cuando un array es pasado:

$object = Validate::asObject(['foo' => 'bar']));

echo $object->foo; // 'bar'

- Cuando no se pasa un objeto correcto:

var_dump(Validate::asObject(false)); // null

$object = Validate::asObject(false, ['foo' => 'bar']);

echo $object->foo; // 'bar'

- JSON:

- Cuando un objeto JSON es pasado:

echo Validate::asJson('{"foo": "bar"}'); // '{"foo": "bar"}'

- Cuando un array es pasado:

echo Validate::asJson(['foo' => 'bar']); // '{"foo":"bar"}'

- Cuando un objeto es pasado:

$data = new \StdClass;

$data->foo = 'bar';

echo Validate::asJson($data); // '{"foo":"bar"}'

- Cuando no se pasa un JSON correcto:

var_dump(Validate::asJson(false)); // null

echo Validate::asJson(false, '["foo", "bar"]'); // '["foo", "bar"]'

- STRING:

- Cuando un string es pasado:

echo Validate::asString('foo'); // 'foo'

- When an integer is passed:

echo Validate::asString(221104); // '221104'

- Cuando no se pasa un string correcto:

var_dump(Validate::asString(false)); // null

echo Validate::asString(false, 'foo'); // 'foo'

- INTEGER:

- When an integer is passed:

echo Validate::asInteger(8); // 8

- Cuando un string es pasado:

echo Validate::asInteger('8'); // 8

- Cuando no se pasa un integer correcto:

var_dump(Validate::asInteger(false)); // null

echo Validate::asInteger(false, 8); // 8

- FLOAT:

- When an float is passed:

echo Validate::asFloat(8.8); // 8.8

- Cuando un string es pasado:

echo Validate::asFloat('8.8'); // 8.8

- Cuando no se pasa un float correcto:

var_dump(Validate::asFloat(false)); // null

echo Validate::asFloat(false, 8.8); // 8.8

- BOOLEAN:

- Cuando un booleano true es pasado:

var_dump(Validate::asBoolean(true)); // true

- Cuando un string true es pasado:

var_dump(Validate::asBoolean('true')); // true

- Cuando un integer 1 es pasado:

var_dump(Validate::asBoolean(1)); // true

- Cuando un string 1 es pasado:

var_dump(Validate::asBoolean('1')); // true

- Cuando un booleano false es pasado:

var_dump(Validate::asBoolean(false)); // false

- Cuando un string false es pasado:

var_dump(Validate::asBoolean('false')); // false

Cuando un integer 0 es pasado:

var_dump(Validate::asBoolean(0)); // false

- Cuando un string 0 es pasado:

var_dump(Validate::asBoolean('0')); // false

- Cuando no se pasa un booleano correcto:

var_dump(Validate::asBoolean(null)); // null

echo Validate::asBoolean(null, true); // true

- IP:

- Cuando una IP es pasada:

echo Validate::asIp('255.255.255.0'); // '255.255.255.0'

- Cuando no se pasa una IP correcta:

var_dump(Validate::asIp(null)); // null

echo Validate::asIp(null, '255.255.255.0'); // '255.255.255.0'

- URL:

- Cuando una URL es pasada:

echo Validate::asUrl('https://josantonius.com'); // 'https://josantonius.com'

- Cuando no se pasa una URL correcta:

var_dump(Validate::asUrl(null)); // null

echo Validate::asUrl(null, 'https://josantonius.com'); // 'https://josantonius.com'

- Email:

- Cuando un email es pasado:

echo Validate::asEmail('hello@josantonius.com'); // 'hello@josantonius.com'

- Cuando no se pasa un email correcto:

var_dump(Validate::asEmail(null)); // null

echo Validate::asEmail(null, 'hello@josantonius.com'); // 'hello@josantonius.com'

Tests

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

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

$ cd PHP-Validate

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

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

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.