Skip to content

Add documentation for array_find RFC #3465

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 9 commits into from
Nov 4, 2024
Merged

Add documentation for array_find RFC #3465

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
6fa04e4
Add `array_find` documentation
joshuaruesweg Jun 7, 2024
97af339
Add `array_find_key` documentation
joshuaruesweg Jun 20, 2024
6bd2ffe
Add `array_any` documentation
joshuaruesweg Jun 20, 2024
59d808f
Add `array_all` documentation
joshuaruesweg Jun 20, 2024
80a7752
Resolve annotations
joshuaruesweg Oct 28, 2024
186ccfa
Remove `para` tag within examples
joshuaruesweg Oct 28, 2024
27a1cba
Add suggested changes
joshuaruesweg Nov 3, 2024
da254aa
Remove `para` for `simpara`
joshuaruesweg Nov 3, 2024
6c7105d
Semantic Line Breaks
Girgias Nov 4, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
134 changes: 134 additions & 0 deletions reference/array/functions/array-all.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,134 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.array-all" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>array_all</refname>
<refpurpose>Checks if all &array; elements satisfy a callback function</refpurpose>
</refnamediv>

<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>mixed</type><methodname>array_all</methodname>
<methodparam><type>array</type><parameter>array</parameter></methodparam>
<methodparam><type>callable</type><parameter>callback</parameter></methodparam>
</methodsynopsis>
<simpara>
<function>array_all</function> returns &true;, if the given
<parameter>callback</parameter> returns &true; for all elements.
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
<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 &false;, &false; is returned from
<function>array_all</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 <parameter>callback</parameter> returns
&true; for all elements. Otherwise the function returns &false;.
</simpara>
</refsect1>

<refsect1 role="examples">
&reftitle.examples;
<example>
<title><function>array_all</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
$array = [
'a' => 'dog',
'b' => 'cat',
'c' => 'cow',
'd' => 'duck',
'e' => 'goose',
'f' => 'elephant'
];

// Check, if all animal names are shorter than 12 letters.
var_dump(array_all($array, function (string $value) {
return strlen($value) < 12;
}));

// Check, if all animal names are longer than 5 letters.
var_dump(array_all($array, function (string $value) {
return strlen($value) > 5;
}));

// Check, if all array keys are strings.
var_dump(array_all($array, function (string $value, $key) {
return is_string($key);
}));
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
bool(true)
bool(false)
bool(true)
]]>
</screen>
</example>
</refsect1>

<refsect1 role="seealso">
&reftitle.seealso;
<simplelist>
<member><function>array_any</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
-->
135 changes: 135 additions & 0 deletions reference/array/functions/array-any.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,135 @@
<?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>mixed</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
<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
-->
7 changes: 4 additions & 3 deletions reference/array/functions/array-filter.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<refname>array_filter</refname>
<refpurpose>Filters elements of an array using a callback function</refpurpose>
</refnamediv>

<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
Expand Down Expand Up @@ -201,7 +201,7 @@ Array
</screen>
</example>
<example>
<title><function>array_filter</function> with
<title><function>array_filter</function> with
<parameter>mode</parameter></title>
<programlisting role="php">
<![CDATA[
Expand Down Expand Up @@ -253,9 +253,10 @@ array(2) {
<para>
<simplelist>
<member><function>array_intersect</function></member>
<member><function>array_find</function></member>
<member><function>array_any</function></member>
<member><function>array_map</function></member>
<member><function>array_reduce</function></member>
<member><function>array_walk</function></member>
</simplelist>
</para>
</refsect1>
Expand Down
Loading