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

<!-- $Revision$ -->

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

<refnamediv>

<refname>array_chunk</refname>

<refpurpose>Split an array into chunks</refpurpose>

</refnamediv>

<refsect1 role="description">

&reftitle.description;

<methodsynopsis>

<type>array</type><methodname>array_chunk</methodname>

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

<methodparam><type>int</type><parameter>length</parameter></methodparam>

<methodparam choice="opt"><type>bool</type><parameter>preserve_keys</parameter><initializer>&false;</initializer></methodparam>

</methodsynopsis>

<para>

Chunks an array into arrays with <parameter>length</parameter> elements.

The last chunk may contain less than <parameter>length</parameter> elements.

</para>

</refsect1>

<refsect1 role="parameters">

&reftitle.parameters;

<para>

<variablelist>

<varlistentry>

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

<listitem>

<para>

The array to work on

</para>

</listitem>

</varlistentry>

<varlistentry>

<term><parameter>length</parameter></term>

<listitem>

<para>

The size of each chunk

</para>

</listitem>

</varlistentry>

<varlistentry>

<term><parameter>preserve_keys</parameter></term>

<listitem>

<para>

When set to &true; keys will be preserved.

Default is &false; which will reindex the chunk numerically

</para>

</listitem>

</varlistentry>

</variablelist>

</para>

</refsect1>

<refsect1 role="returnvalues">

&reftitle.returnvalues;

<para>

Returns a multidimensional numerically indexed array, starting with zero,

with each dimension containing <parameter>length</parameter> elements.

</para>

</refsect1>

<refsect1 role="errors">

&reftitle.errors;

<para>

If <parameter>length</parameter> is less than <literal>1</literal>,

a <classname>ValueError</classname> will be thrown.

</para>

</refsect1>

<refsect1 role="changelog">

&reftitle.changelog;

<informaltable>

<tgroup cols="2">

<thead>

<row>

<entry>&Version;</entry>

<entry>&Description;</entry>

</row>

</thead>

<tbody>

<row>

<entry>8.0.0</entry>

<entry>

If <parameter>length</parameter> is less than <literal>1</literal>,

a <classname>ValueError</classname> will be thrown now;

previously, an error of level <constant>E_WARNING</constant>

has been raised instead, and the function returned &null;.

</entry>

</row>

</tbody>

</tgroup>

</informaltable>

</refsect1>

<refsect1 role="examples">

&reftitle.examples;

<para>

<example>

<title><function>array_chunk</function> example</title>

<programlisting role="php">

<![CDATA[

<?php

$input_array = array('a', 'b', 'c', 'd', 'e');

print_r(array_chunk($input_array, 2));

print_r(array_chunk($input_array, 2, true));

?>

]]>

</programlisting>

&example.outputs;

<screen>

<![CDATA[

Array

(

[0] => Array

(

[0] => a

[1] => b

)

[1] => Array

(

[0] => c

[1] => d

)

[2] => Array

(

[0] => e

)

)

Array

(

[0] => Array

(

[0] => a

[1] => b

)

[1] => Array

(

[2] => c

[3] => d

)

[2] => Array

(

[4] => e

)

)

]]>

</screen>

</example>

</para>

</refsect1>

<refsect1 role="seealso">

&reftitle.seealso;

<para>

<simplelist>

<member><function>array_slice</function></member>

</simplelist>

</para>

</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

-->