<!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>Replaces an object</title> </head> <body><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="hwapi.remove.html">hw_api::remove</a></div> <div class="next" style="text-align: right; float: right;"><a href="hwapi.setcommittedversion.html">hw_api::setcommittedversion</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.replace" class="refentry"> <div class="refnamediv"> <h1 class="refname">hw_api::replace</h1> <p class="verinfo">(PHP 4, PHP 5 < 5.2.0, PECL hwapi SVN)</p><p class="refpurpose"><span class="refname">hw_api::replace</span> — <span class="dc-title">Replaces an object</span></p> </div> <div class="refsect1 description" id="refsect1-hwapi.replace-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::replace</strong></span> ( <span class="methodparam"><span class="type">array</span> <code class="parameter">$parameter</code></span> )</div> <p class="para rdfs-comment"> Replaces the attributes and the content of an object. </p> </div> <div class="refsect1 parameters" id="refsect1-hwapi.replace-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 'objectIdentifier' and 'object' and the optional parameters 'content', 'parameters', 'mode' and 'attributeSelector'. 'objectIdentifier' contains the object to be replaced. 'object' contains the new object. 'content' contains the new content. 'parameters' contain extra information for HTML documents. HTML_Language is the letter abbreviation of the language of the title. HTML_Base sets the base attribute of the HTML document. </p> <p class="para"> 'mode' can be a combination of the following flags: <dl> <dt> <span class="term"><strong><code>HW_API_REPLACE_NORMAL</code></strong></span> <dd> <span class="simpara"> The object on the server is replace with the object passed. </span> </dd> </dt> <dt> <span class="term"><strong><code>HW_API_REPLACE_FORCE_VERSION_CONTROL</code></strong></span> <dd> <span class="simpara"> </span> </dd> </dt> <dt> <span class="term"><strong><code>HW_API_REPLACE_AUTOMATIC_CHECKOUT</code></strong></span> <dd> <span class="simpara"> </span> </dd> </dt> <dt> <span class="term"><strong><code>HW_API_REPLACE_AUTOMATIC_CHECKIN</code></strong></span> <dd> <span class="simpara"> </span> </dd> </dt> <dt> <span class="term"><strong><code>HW_API_REPLACE_PLAIN</code></strong></span> <dd> <span class="simpara"> </span> </dd> </dt> <dt> <span class="term"><strong><code>HW_API_REPLACE_REVERT_IF_NOT_CHANGED</code></strong></span> <dd> <span class="simpara"> </span> </dd> </dt> <dt> <span class="term"><strong><code>HW_API_REPLACE_KEEP_TIME_MODIFIED</code></strong></span> <dd> <span class="simpara"> </span> </dd> </dt> </dl> </p> </dd> </dt> </dl> </p> </div> <div class="refsect1 returnvalues" id="refsect1-hwapi.replace-returnvalues"> <h3 class="title">Return Values</h3> <p class="para"> </p> </div> <div class="refsect1 seealso" id="refsect1-hwapi.replace-seealso"> <h3 class="title">See Also</h3> <p class="para"> <ul class="simplelist"> <li class="member"><a href="hwapi.insert.html" class="xref">hw_api::insert</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.remove.html">hw_api::remove</a></div> <div class="next" style="text-align: right; float: right;"><a href="hwapi.setcommittedversion.html">hw_api::setcommittedversion</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>