<!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>Inserts a new object</title> </head> <body><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="hwapi.info.html">hw_api::info</a></div> <div class="next" style="text-align: right; float: right;"><a href="hwapi.insertanchor.html">hw_api::insertanchor</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.insert" class="refentry"> <div class="refnamediv"> <h1 class="refname">hw_api::insert</h1> <p class="verinfo">(PHP 4, PHP 5 < 5.2.0, PECL hwapi SVN)</p><p class="refpurpose"><span class="refname">hw_api::insert</span> — <span class="dc-title">Inserts a new object</span></p> </div> <div class="refsect1 description" id="refsect1-hwapi.insert-description"> <h3 class="title">Description</h3> <div class="methodsynopsis dc-description"> <span class="type"><span class="type hw_api_object">hw_api_object</span></span> <span class="methodname"><strong>hw_api::insert</strong></span> ( <span class="methodparam"><span class="type">array</span> <code class="parameter">$parameter</code></span> )</div> <p class="para rdfs-comment"> Insert a new object. The object type can be user, group, document or anchor. Depending on the type other object attributes has to be set. </p> </div> <div class="refsect1 parameters" id="refsect1-hwapi.insert-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"> The parameter array contains the required elements 'object' and 'content' (if the object is a document) and the optional parameters 'parameters', 'mode' and 'attributeSelector'. The 'object' must contain all attributes of the object. 'parameters' is an object as well holding further attributes like the destination (attribute key is 'Parent'). 'content' is the content of the document. 'mode' can be a combination of the following flags: <dl> <dt> <span class="term"><strong><code>HW_API_INSERT_NORMAL</code></strong></span> <dd> <span class="simpara"> The object in inserted into the server. </span> </dd> </dt> <dt> <span class="term"><strong><code>HW_API_INSERT_FORCE_VERSION_CONTROL</code></strong></span> <dd> <span class="simpara"> </span> </dd> </dt> <dt> <span class="term"><strong><code>HW_API_INSERT_AUTOMATIC_CHECKOUT</code></strong></span> <dd> <span class="simpara"> </span> </dd> </dt> <dt> <span class="term"><strong><code>HW_API_INSERT_PLAIN</code></strong></span> <dd> <span class="simpara"> </span> </dd> </dt> <dt> <span class="term"><strong><code>HW_API_INSERT_KEEP_TIME_MODIFIED</code></strong></span> <dd> <span class="simpara"> </span> </dd> </dt> <dt> <span class="term"><strong><code>HW_API_INSERT_DELAY_INDEXING</code></strong></span> <dd> <span class="simpara"> </span> </dd> </dt> </dl> </p> </dd> </dt> </dl> </p> </div> <div class="refsect1 returnvalues" id="refsect1-hwapi.insert-returnvalues"> <h3 class="title">Return Values</h3> <p class="para"> </p> </div> <div class="refsect1 seealso" id="refsect1-hwapi.insert-seealso"> <h3 class="title">See Also</h3> <p class="para"> <ul class="simplelist"> <li class="member"><a href="hwapi.replace.html" class="xref">hw_api::replace</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.info.html">hw_api::info</a></div> <div class="next" style="text-align: right; float: right;"><a href="hwapi.insertanchor.html">hw_api::insertanchor</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>