<?xml version="1.0" encoding="utf-8"?>

<!-- $Revision$ -->

<!-- EN-Revision: c938838be5a7f6d2a0b0710476afb9fb2ccb6e52 Maintainer: Marqitos Status: ready -->

<!-- Reviewed: no -->

<!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. -->

<refentry xml:id="function.filter-var" xmlns="http://docbook.org/ns/docbook">

<refnamediv>

<refname>filter_var</refname>

<refpurpose>Filtra una variable con el filtro que se indique</refpurpose>

</refnamediv>

<refsect1 role="description">

&reftitle.description;

<methodsynopsis>

<type>mixed</type><methodname>filter_var</methodname>

<methodparam><type>mixed</type><parameter>value</parameter></methodparam>

<methodparam choice="opt"><type>int</type><parameter>filter</parameter><initializer><constant>FILTER_DEFAULT</constant></initializer></methodparam>

<methodparam choice="opt"><type class="union"><type>array</type><type>int</type></type><parameter>options</parameter><initializer>0</initializer></methodparam>

</methodsynopsis>

<simpara>

Filtra una variable usando un filtro de validación

<constant>FILTER_VALIDATE_<replaceable>*</replaceable></constant>,

un filtro de saneamiento

<constant>FILTER_SANITIZE_<replaceable>*</replaceable></constant>,

o un filtro definido por el usuario.

</simpara>

</refsect1>

<refsect1 role="parameters">

&reftitle.parameters;

<variablelist>

<varlistentry>

<term><parameter>value</parameter></term>

<listitem>

<simpara>

Valor a filtrar.

</simpara>

<warning>

<simpara>

Valores escalares son

<link linkend="language.types.string.casting">convertidos a string</link>

internamente antes de ser filtrados.

</simpara>

</warning>

</listitem>

</varlistentry>

<varlistentry>

<term><parameter>filter</parameter></term>

<listitem>

<simpara>

El filtro a aplicar.

Puede ser un filtro de validación usando una de las constantes

<constant>FILTER_VALIDATE_<replaceable>*</replaceable></constant>,

un filtro de saneamiento usando una de las constantes

<constant>FILTER_SANITIZE_<replaceable>*</replaceable></constant>

o <constant>FILTER_UNSAFE_RAW</constant>, o un filtro personalizado usando

<constant>FILTER_CALLBACK</constant>.

</simpara>

<note>

<simpara>

Por omisión es <constant>FILTER_DEFAULT</constant>,

que es un alias de <constant>FILTER_UNSAFE_RAW</constant>.

Esto resultará en que no se aplique ningún filtro por omisión.

</simpara>

</note>

</listitem>

</varlistentry>

<varlistentry>

<term><parameter>options</parameter></term>

<listitem>

<simpara>

O bien un <type>array</type> asociativo de opciones,

o bien una máscara de bits de constantes de indicadores de filtro

<constant>FILTER_FLAG_<replaceable>*</replaceable></constant>.

</simpara>

<simpara>

Si el <parameter>filter</parameter> acepta opciones,

los indicadores pueden ser proporcionados usando el campo <literal>"flags"</literal> del array.

</simpara>

</listitem>

</varlistentry>

</variablelist>

</refsect1>

<refsect1 role="returnvalues">

&reftitle.returnvalues;

<simpara>

En caso de éxito devuelve la variable filtrada.

En caso de fallo se devuelve &false;,

a menos que se use el flag <constant>FILTER_NULL_ON_FAILURE</constant>,

en cuyo caso se devuelve &null;.

</simpara>

</refsect1>

<refsect1 role="examples">

&reftitle.examples;

<example>

<title>Ejemplo de <function>filter_var</function></title>

<programlisting role="php">

<![CDATA[

<?php

var_dump(filter_var('[email protected]', FILTER_VALIDATE_EMAIL));

var_dump(filter_var('https://example.com', FILTER_VALIDATE_URL, FILTER_FLAG_PATH_REQUIRED));

?>

]]>

</programlisting>

&example.outputs;

<screen>

<![CDATA[

string(15) "[email protected]"

bool(false)

]]>

</screen>

</example>

<example>

<title>Example validating entries of an array</title>

<programlisting role="php">

<![CDATA[

<?php

$emails = [

"[email protected]",

"[email protected]",

"invalidemail"

];

var_dump(filter_var($emails, FILTER_VALIDATE_EMAIL, FILTER_REQUIRE_ARRAY));

?>

]]>

</programlisting>

&example.outputs;

<screen>

<![CDATA[

array(3) {

[0]=>

string(15) "[email protected]"

[1]=>

string(18) "[email protected]"

[2]=>

bool(false)

}

]]>

</screen>

</example>

<example>

<title>Ejemplo de pasar un array para <parameter>options</parameter></title>

<programlisting role="php">

<![CDATA[

<?php

$options = [

'options' => [

'min_range' => 10,

],

'flags' => FILTER_FLAG_ALLOW_OCTAL,

];

var_dump(filter_var('0755', FILTER_VALIDATE_INT, $options));

var_dump(filter_var('011', FILTER_VALIDATE_INT, $options));

?>

]]>

</programlisting>

&example.outputs;

<screen>

<![CDATA[

int(493)

bool(false)

]]>

</screen>

</example>

<example>

<title>Proporcionar flags directamente o vía un <type>array</type></title>

<programlisting role="php">

<![CDATA[

<?php

$str = 'string';

var_dump(filter_var($str, FILTER_VALIDATE_BOOLEAN, FILTER_NULL_ON_FAILURE));

var_dump(filter_var($str, FILTER_VALIDATE_BOOLEAN, ['flags' => FILTER_NULL_ON_FAILURE]));

?>

]]>

</programlisting>

&example.outputs;

<screen>

<![CDATA[

NULL

NULL

]]>

</screen>

</example>

</refsect1>

<refsect1 role="seealso">

&reftitle.seealso;

<simplelist>

<member><function>filter_var_array</function></member>

<member><function>filter_input</function></member>

<member><function>filter_input_array</function></member>

<member>

Filtros de validación

<constant>FILTER_VALIDATE_<replaceable>*</replaceable></constant>

</member>

<member>

Filtros de saneación

<constant>FILTER_SANITIZE_<replaceable>*</replaceable></constant>

</member>

</simplelist>

</refsect1>

</refentry>

<!-- Keep this comment at the end of the file

Local variables:

mode: sgml

sgml-omittag:t

sgml-shorttag:t

sgml-minimize-attributes:nil

sgml-always-quote-attributes:t

sgml-indent-step:1

sgml-indent-data:t

indent-tabs-mode:nil

sgml-parent-document:nil

sgml-default-dtd-file:"~/.phpdoc/manual.ced"

sgml-exposed-tags:nil

sgml-local-catalogs:nil

sgml-local-ecat-files:nil

End:

vim600: syn=xml fen fdm=syntax fdl=2 si

vim: et tw=78 syn=sgml

vi: ts=1 sw=1

-->