Download the PHP package uppercod/aduana without Composer
On this page you can find all versions of the php package uppercod/aduana. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download uppercod/aduana
More information about uppercod/aduana
Files in uppercod/aduana
Package aduana
Short Description A small library to clean and filter data safely and easily.
License Apache-2.0
Informations about the package aduana
Aduana
Aduana es una pequeña librería para sanear y filtrar datos de forma segura y simple.
Como notará el ejemplo anterior enseña una instancia de Aduana\Shema, este requiere un array que enseñe las propiedades a filtrar con su correspondiente formato
Aduana\Shema::filter
el método filter permite filtrar y sanear datos en base a la instancia de Aduana\Shema, este siempre retornara 4 propiedades.
- valid : define si sea ha procesado toda la estructura shema de forma correcta, sin valores inválidos.
- dataValid : retorna las propiedades validadas.
- dataInvalid : retorna las propiedades requeridas e inválidas.
- countValid : es un contador de las propiedades válidas
- countInvalid : es un contador de las propiedades invalidas
Se advierte que todas las propiedades inválidas y no requeridas simplemente se ignoran en el resultado de validación.
Aduana\Filter
Esta clase posee todos los filtros que posee por defecto Aduana.
Por defecto todos los métodos encargados de filtrar y sanear son métodos estáticos de 2 argumentos Aduana\Filter::$filter($config, $value)
.
- $config : define la configuración del filtro.
- $value: el valor a filtrar o sanear por el método.
A su vez todo filtro dentro y fuera de aduana debe retornar un objeto con 2 propiedades en el (object)["valid"=>boolean, "value"=>any ]
.
Aduana\Filter::type (string $config, $value)
Filtra un valor en base a su tipo($config) en comparación a su valor($value).
type | detail |
---|---|
email, mail | Define si es un email |
integer, int | Define si es un número entero |
boolean, bool | Define si es un booleano |
float, double | Define si es un número flotante |
number, numberic | Define si es un número |
null | Define si es nulo |
infinite | Define si es un número infinito |
finite | Define si el número es finito |
json | Define si es un json |
url | Define si es una url |
date | Define si es un fecha |
default | Si no posee una definición de tipo usara la función gettype para verificar el tipo |
Aduana\Filter::minLength (int $config, string $value)
Requiere un largo mínimo para validar el valor.
La propiedad password dentro de $shema, debe ser mayor o igual a 6 caracteres.
Aduana\Filter::maxLength (int $config, string $value)
Requiere un largo máximo para validar el valor.
La propiedad password dentro de $shema, debe ser menor o igual a 12 caracteres.
Aduana\Filter::min (int $config, int $value)
Define un valor mínimo numerico.
La propiedad age dentro de $shema, debe ser mayor o igual a 18.
Aduana\Filter::max (int $config, int $value)
Define un valor mínimo numerico.
La propiedad age dentro de $shema debe ser menor o igual a 30.
Aduana\Filter::stripTags ($config, string $value)
aplica la función strip_tags al valor que apunte el cursor de schema.
Como notara puede usar un booleano en la definición de la propiedad stripTags para desactivar este filtro, de igual forma puede aplicar un string como parámetro secundario para strip_tags.
Aduana\Filter::pattern (string $config, string $value)
Valida si el string es válido al patrón entregado.
La propiedad tag debe cumplir con el patron
"/[a-z]+/"
aceptar su valor como valido.
Aduana\Filter::replace (array $config, string $value)
Permite reemplazar del valor entregado, caracteres a base de una búsqueda, esta búsqueda a su vez puede ser una expresión regular o una simple cadena simple.
En las propiedades tag_1 y tag_2, se buscará el carácter . y se reemplazará por un carácter @
Aduana\Filter::cleanSpace (bool $config, string $value)
Limpia un valor en su totalidad de espacios adicionales.
Aduana\Filter::option (array $config, $value)
Verifica que el valor entregado exista dentro de las opciones válidas.
Aduana\Filter::alias (array $config, $value)
Traduce el valor entregado a otro solo si este existe en el índice correspondiente.
La propiedad field_1 pasará de poseer un valor a a 1.
Aduana\Filter::date (string $config, string $value)
Da formato de fecha al valor entregado, esta aplica la función date.
Aduana\Filter::htmlEncode (bool $config, string $value)
Aplica la función htmlentities al valor entregado.
Aduana\Filter::htmlDecode (bool $config, string $value)
Aplica la función html_entity_decode al valor entregado.
Aduana\Filter::equal ($config, $value)
Compara con la siguiente expresión $config === $value
.
Aduana\Filter::notEqual ($config, $value)
Compara con la siguiente expresión $config !== $value
.
Aduana\Filter::numberFormat (array $config, float $value)
Aplica la función number_format sobre el valor entregado.
Aduana\Filter::range (array $config, $value )
Utiliza la función range para generar un rango y luego verificar si el valor entregado existe dentro de ese rango.
Aduana\Filter::round (float $config, float $value)
Aplica la función round, sobre el valor entregado.
Aduana\Filter::force (string $config, $value)
fuerza el tipo de una variable, los tipos válidos son integer || int, float || double, string, boolean || bool, unset
Aduana\Filter::quotemeta (bool $config, string $value)
Aplica la función quotemeta sobre el valor entregado.
Aduana\Filter::callback (callable $config, $value)
Ejecuta esta línea con los parámetros asignados call_user_func( $config, $value)
, Para que sea un filtro válido debe cumplir con el formato de retorno para filtros (object)["valid"=>boolean, "value"=>any ]
.
Esta función siempre debe retornar una objeto con los siguientes parámetros
(object)["valid"=>boolean, "value"=>any ]