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

<!-- $Revision$ -->

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

<refnamediv>

<refname>array_any</refname>

<refpurpose>Checks if at least one &array; element satisfies a callback function</refpurpose>

</refnamediv>

<refsect1 role="description">

&reftitle.description;

<methodsynopsis>

<type>bool</type><methodname>array_any</methodname>

<methodparam><type>array</type><parameter>array</parameter></methodparam>

<methodparam><type>callable</type><parameter>callback</parameter></methodparam>

</methodsynopsis>

<simpara>

<function>array_any</function> returns &true;, if the given

<parameter>callback</parameter> returns &true; for any element.

Otherwise the function returns &false;.

</simpara>

</refsect1>

<refsect1 role="parameters">

&reftitle.parameters;

<variablelist>

<varlistentry>

<term><parameter>array</parameter></term>

<listitem>

<simpara>

The &array; that should be searched.

</simpara>

</listitem>

</varlistentry>

<varlistentry>

<term><parameter>callback</parameter></term>

<listitem>

<para>

The callback function to call to check each element, which must be

of the following signature:

<methodsynopsis>

<type>bool</type><methodname><replaceable>callback</replaceable></methodname>

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

<methodparam><type>mixed</type><parameter>key</parameter></methodparam>

</methodsynopsis>

If this function returns &true;, &true; is returned from

<function>array_any</function> and the callback will not be called for

further elements.

</para>

</listitem>

</varlistentry>

</variablelist>

</refsect1>

<refsect1 role="returnvalues">

&reftitle.returnvalues;

<simpara>

The function returns &true;, if there is at least one element for which

<parameter>callback</parameter> returns &true;. Otherwise the function

returns &false;.

</simpara>

</refsect1>

<refsect1 role="examples">

&reftitle.examples;

<example>

<title><function>array_any</function> example</title>

<programlisting role="php">

<![CDATA[

<?php

$array = [

'a' => 'dog',

'b' => 'cat',

'c' => 'cow',

'd' => 'duck',

'e' => 'goose',

'f' => 'elephant'

];

// Check, if any animal name is longer than 5 letters.

var_dump(array_any($array, function (string $value) {

return strlen($value) > 5;

}));

// Check, if any animal name is shorter than 3 letters.

var_dump(array_any($array, function (string $value) {

return strlen($value) < 3;

}));

// Check, if any array key is not a string.

var_dump(array_any($array, function (string $value, $key) {

return !is_string($key);

}));

?>

]]>

</programlisting>

&example.outputs;

<screen>

<![CDATA[

bool(true)

bool(false)

bool(false)

]]>

</screen>

</example>

</refsect1>

<refsect1 role="seealso">

&reftitle.seealso;

<simplelist>

<member><function>array_all</function></member>

<member><function>array_filter</function></member>

<member><function>array_find</function></member>

<member><function>array_find_key</function></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

-->