<!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>Checks in an object</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="ref.hwapi.html">Hyperwave API Functions</a></div>
<div class="next" style="text-align: right; float: right;"><a href="hwapi.checkout.html">hw_api::checkout</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.checkin" class="refentry">
<div class="refnamediv">
<h1 class="refname">hw_api::checkin</h1>
<p class="verinfo">(PHP 4, PHP 5 < 5.2.0, PECL hwapi SVN)</p><p class="refpurpose"><span class="refname">hw_api::checkin</span> — <span class="dc-title">Checks in an object</span></p>
</div>
<div class="refsect1 description" id="refsect1-hwapi.checkin-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><strong>hw_api::checkin</strong></span>
( <span class="methodparam"><span class="type">array</span> <code class="parameter">$parameter</code></span>
)</div>
<p class="para rdfs-comment">
This function checks in an object or a whole hierarchy of objects.
The parameters array contains the required element
'objectIdentifier' and the optional element 'version', 'comment', 'mode'
and
'objectQuery'. 'version' sets the version of the object. It consists of
the major and minor version separated by a period. If the version is not
set, the minor version is incremented. 'mode' can be one of the following
values:
<dl>
<dt>
<span class="term">HW_API_CHECKIN_NORMAL</span>
<dd>
<span class="simpara">
Checks in and commits the object. The object must be a document.
</span>
</dd>
</dt>
<dt>
<span class="term">HW_API_CHECKIN_RECURSIVE</span>
<dd>
<span class="simpara">
If the object to check in is a collection, all children will be
checked in recursively if they are documents. Trying to check in
a collection would result in an error.
</span>
</dd>
</dt>
<dt>
<span class="term">HW_API_CHECKIN_FORCE_VERSION_CONTROL</span>
<dd>
<span class="simpara">
Checks in an object even if it is not under version control.
</span>
</dd>
</dt>
<dt>
<span class="term">HW_API_CHECKIN_REVERT_IF_NOT_CHANGED</span>
<dd>
<span class="simpara">
Check if the new version is different from the last version. Unless
this is the case the object will be checked in.
</span>
</dd>
</dt>
<dt>
<span class="term">HW_API_CHECKIN_KEEP_TIME_MODIFIED</span>
<dd>
<span class="simpara">
Keeps the time modified from the most recent object.
</span>
</dd>
</dt>
<dt>
<span class="term">HW_API_CHECKIN_NO_AUTO_COMMIT</span>
<dd>
<span class="simpara">
The object is not automatically committed on check-in.
</span>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 parameters" id="refsect1-hwapi.checkin-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">
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-hwapi.checkin-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.checkin-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"><a href="hwapi.checkout.html" class="xref">hw_api::checkout</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="ref.hwapi.html">Hyperwave API Functions</a></div>
<div class="next" style="text-align: right; float: right;"><a href="hwapi.checkout.html">hw_api::checkout</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>
