<!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>Delete an object</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="hwapi.parents.html">hw_api::parents</a></div>
<div class="next" style="text-align: right; float: right;"><a href="hwapi.replace.html">hw_api::replace</a></div>
<div class="up"><a href="ref.hwapi.html">Hyperwave API Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="hwapi.remove" class="refentry">
<div class="refnamediv">
<h1 class="refname">hw_api::remove</h1>
<p class="verinfo">(PHP 4, PHP 5 < 5.2.0, PECL hwapi SVN)</p><p class="refpurpose"><span class="refname">hw_api::remove</span> — <span class="dc-title">Delete an object</span></p>
</div>
<div class="refsect1 description" id="refsect1-hwapi.remove-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><strong>hw_api::remove</strong></span>
( <span class="methodparam"><span class="type">array</span> <code class="parameter">$parameter</code></span>
)</div>
<p class="para rdfs-comment">
Removes an object from the specified parent. Collections
will be removed recursively.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-hwapi.remove-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">parameter</code></em></span>
<dd>
<p class="para">
You can pass an optional object query to remove only those objects
which match the query. An object will be deleted physically if it is
the last instance.
</p>
<p class="para">
The parameter array contains the required elements 'objectidentifier'
and 'parentidentifier'. If you want to remove a user or group
'parentidentifier' can be skipped.
</p>
<p class="para">
The optional parameter 'mode' determines how the deletion is
performed. In normal mode the object will not be removed physically
until all instances are removed. In physical mode all instances of the
object will be deleted immediately. In removelinks mode all references
to and from the objects will be deleted as well. In nonrecursive the
deletion is not performed recursive. Removing a collection which is
not empty will cause an error.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-hwapi.remove-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns <strong><code>TRUE</code></strong> on success or <strong><code>FALSE</code></strong> on failure.
</p>
</div>
<div class="refsect1 seealso" id="refsect1-hwapi.remove-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"><a href="hwapi.move.html" class="xref">hw_api::move</a></li>
</ul>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="hwapi.parents.html">hw_api::parents</a></div>
<div class="next" style="text-align: right; float: right;"><a href="hwapi.replace.html">hw_api::replace</a></div>
<div class="up"><a href="ref.hwapi.html">Hyperwave API Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
