php-doc-en/reference/pthreads/stackable/chunk.xml
Joe Watkins f8d8fcd58a updates for pthreads documentation
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@331306 c90b9560-bf6c-de11-be94-00142212c4b1
2013-09-08 06:02:24 +00:00

71 lines
No EOL
1.8 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="stackable.chunk" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>Stackable::chunk</refname>
<refpurpose>Manipulation</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>final</modifier> <modifier>public</modifier> <type>boolean</type><methodname>Stackable::chunk</methodname>
<methodparam><type>long</type><parameter>size</parameter></methodparam>
<methodparam><type>boolean</type><parameter>preserve</parameter></methodparam>
</methodsynopsis>
<para>
Fetches a chunk of the objects member table of the given size, optionally preserving keys
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>size</parameter></term>
<listitem>
<para>
The number of items to fetch
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>preserve</parameter></term>
<listitem>
<para>
Preserve the keys of members, by default false
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
An array of items from the objects member table
</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
-->