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

<!-- $Revision$ -->

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

<!-- Reviewed: yes -->

<!-- Rev-Revision: c938838be5a7f6d2a0b0710476afb9fb2ccb6e52 Reviewer: samesch -->

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

<refnamediv>

<refname>filter_var</refname>

<refpurpose>Filtert eine Variable mit einem angegebenen Filter</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>

Filtert eine Variable unter Verwendung eines

<constant>FILTER_VALIDATE_<replaceable>*</replaceable></constant>-Validierungsfilters, eines

<constant>FILTER_SANITIZE_<replaceable>*</replaceable></constant>-Bereinigungsfilters

oder eines benutzerdefinierten Filters.

</simpara>

</refsect1>

<refsect1 role="parameters">

&reftitle.parameters;

<variablelist>

<varlistentry>

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

<listitem>

<simpara>

Der zu filternde Wert.

</simpara>

<warning>

<simpara>

Skalare Werte werden intern

<link linkend="language.types.string.casting">in eine Zeichenkette umgewandelt</link>,

bevor sie gefiltert werden.

</simpara>

</warning>

</listitem>

</varlistentry>

<varlistentry>

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

<listitem>

<simpara>

Der anzuwendende Filter.

Dies kann entweder ein Validierungsfilter sein, indem eine der

<constant>FILTER_VALIDATE_<replaceable>*</replaceable></constant>-Konstanten

verwendet wird, ein Bereinigungsfilter, indem eine der

<constant>FILTER_SANITIZE_<replaceable>*</replaceable></constant>-Konstanten

verwendet wird, der Fiter <constant>FILTER_UNSAFE_RAW</constant> oder ein

benutzerdefinierter Filter durch Verwendung von

<constant>FILTER_CALLBACK</constant>.

</simpara>

<note>

<simpara>

Die Voreinstellung ist <constant>FILTER_DEFAULT</constant>, was ein

Alias von <constant>FILTER_UNSAFE_RAW</constant> ist.

Dies bedeutet, dass standardmäßig keine Filterung stattfindet.

</simpara>

</note>

</listitem>

</varlistentry>

<varlistentry>

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

<listitem>

<simpara>

Entweder ein assoziatives <type>array</type> von Optionen oder eine

Bitmaske der Filterflag-Konstanten

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

</simpara>

<simpara>

Wenn <parameter>filter</parameter> Optionen akzeptiert, können die Flags

durch Verwendung des Array-Schlüssels <literal>"flags"</literal>

angegeben werden.

</simpara>

</listitem>

</varlistentry>

</variablelist>

</refsect1>

<refsect1 role="returnvalues">

&reftitle.returnvalues;

<simpara>

Bei Erfolg werden die gefilterten Daten zurückgegeben.

Im Fehlerfall wird &false; zurückgegeben, es sei denn, das Flag

<constant>FILTER_NULL_ON_FAILURE</constant> wird verwendet; in diesem Fall

wird &null; zurückgegeben.

</simpara>

</refsect1>

<refsect1 role="examples">

&reftitle.examples;

<example>

<title><function>filter_var</function>-Beispiel</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>Beispiel für das Validieren der Einträge eines Arrays</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>Beispiel für die Übergabe eines Arrays für <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>Angabe von Flags entweder direkt oder über ein <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>

Validierungsfilter

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

</member>

<member>

Bereinigungsfilter

<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

-->