mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-27 14:28:56 +00:00
5b9fc29465
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@78496 c90b9560-bf6c-de11-be94-00142212c4b1
54 lines
2.1 KiB
XML
54 lines
2.1 KiB
XML
<?xml version="1.0" encoding="iso-8859-1"?>
|
|
<!-- $Revision: 1.2 $ -->
|
|
<!-- splitted from ./en/functions/hw.xml, last change in rev 1.2 -->
|
|
<refentry id="function.hw-incollections">
|
|
<refnamediv>
|
|
<refname>hw_InCollections</refname>
|
|
<refpurpose>check if object ids in collections</refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<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>.
|
|
When the fourth parameter <parameter>return_collections</parameter> is 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. When the fourth parameter is 1, however, 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>
|
|
</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
|
|
-->
|