mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-18 09:58:55 +00:00
20ca2afd4b
# 250 to go git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@249418 c90b9560-bf6c-de11-be94-00142212c4b1
98 lines
3 KiB
XML
98 lines
3 KiB
XML
<?xml version="1.0" encoding="iso-8859-1"?>
|
|
<!-- $Revision: 1.6 $ -->
|
|
<refentry xml:id="function.hw-incollections" xmlns="http://docbook.org/ns/docbook">
|
|
<refnamediv>
|
|
<refname>hw_InCollections</refname>
|
|
<refpurpose>Check if object ids in collections</refpurpose>
|
|
</refnamediv>
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>array</type><methodname>hw_incollections</methodname>
|
|
<methodparam><type>int</type><parameter>connection</parameter></methodparam>
|
|
<methodparam><type>array</type><parameter>object_id_array</parameter></methodparam>
|
|
<methodparam><type>array</type><parameter>collection_id_array</parameter></methodparam>
|
|
<methodparam><type>int</type><parameter>return_collections</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
Checks whether a set of objects (documents or collections)
|
|
specified by the <parameter>object_id_array</parameter> is part of
|
|
the collections listed in <parameter>collection_id_array</parameter>.
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>connection</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The connection identifier.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>object_id_array</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
An array of object ids.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>collection_id_array</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
An array of collection ids.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>return_collections</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
When set to 0, the subset of object ids that is part of the
|
|
collections (i.e., the documents or collections that are children of
|
|
one or more collections of collection ids or their subcollections,
|
|
recursively) is returned as an array.
|
|
</para>
|
|
<para>
|
|
When set to 1, the set of collections that have one or more objects of
|
|
this subset as children are returned as an array. This option allows a
|
|
client to, e.g., highlight the part of the collection hierarchy that
|
|
contains the matches of a previous query, in a graphical overview.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
Returns an array of object ids.
|
|
</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:"../../../../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
|
|
-->
|