<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Check if object ids in collections</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.hw-identify.html">hw_Identify</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.hw-info.html">hw_Info</a></div>
<div class="up"><a href="ref.hw.html">Hyperwave Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.hw-incollections" class="refentry">
<div class="refnamediv">
<h1 class="refname">hw_InCollections</h1>
<p class="verinfo">(PHP 4)</p><p class="refpurpose"><span class="refname">hw_InCollections</span> — <span class="dc-title">Check if object ids in collections</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.hw-incollections-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">array</span> <span class="methodname"><strong>hw_incollections</strong></span>
( <span class="methodparam"><span class="type">int</span> <code class="parameter">$connection</code></span>
, <span class="methodparam"><span class="type">array</span> <code class="parameter">$object_id_array</code></span>
, <span class="methodparam"><span class="type">array</span> <code class="parameter">$collection_id_array</code></span>
, <span class="methodparam"><span class="type">int</span> <code class="parameter">$return_collections</code></span>
)</div>
<p class="para rdfs-comment">
Checks whether a set of objects (documents or collections)
specified by the <em><code class="parameter">object_id_array</code></em> is part of
the collections listed in <em><code class="parameter">collection_id_array</code></em>.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.hw-incollections-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">connection</code></em></span>
<dd>
<p class="para">
The connection identifier.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">object_id_array</code></em></span>
<dd>
<p class="para">
An array of object ids.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">collection_id_array</code></em></span>
<dd>
<p class="para">
An array of collection ids.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">return_collections</code></em></span>
<dd>
<p class="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.
</p>
<p class="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.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.hw-incollections-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns an array of object ids.
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.hw-identify.html">hw_Identify</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.hw-info.html">hw_Info</a></div>
<div class="up"><a href="ref.hw.html">Hyperwave Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
