php-doc-en/reference/hwapi/functions/hwapi-replace.xml
Hannes Magnusson c030e2adf7 Upgrade to DocBook5:
- All id attributes are now xml:id
 - Add docbook namespace to all root elements
 - Replace <ulink /> with <link xlink:href />
 - Minor markup fixes here and there


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@238160 c90b9560-bf6c-de11-be94-00142212c4b1
2007-06-20 22:25:43 +00:00

137 lines
3.8 KiB
XML

<?xml version='1.0' encoding='iso-8859-1' ?>
<!-- $Revision: 1.9 $ -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.hwapi-replace">
<refnamediv>
<refname>hw_api->replace</refname>
<refpurpose>Replaces an object</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<classsynopsis>
<ooclass><classname>hw_api</classname></ooclass>
<methodsynopsis>
<type>hw_api_object</type><methodname>replace</methodname>
<methodparam><type>array</type><parameter>parameter</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
<para>
Replaces the attributes and the content of an object.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>parameter</parameter></term>
<listitem>
<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.
</para>
<para>
'mode' can be a combination of the following flags:
<variablelist>
<varlistentry>
<term><constant>HW_API_REPLACE_NORMAL</constant></term>
<listitem>
<simpara>
The object on the server is replace with the object passed.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><constant>HW_API_REPLACE_FORCE_VERSION_CONTROL</constant></term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><constant>HW_API_REPLACE_AUTOMATIC_CHECKOUT</constant></term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><constant>HW_API_REPLACE_AUTOMATIC_CHECKIN</constant></term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><constant>HW_API_REPLACE_PLAIN</constant></term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><constant>HW_API_REPLACE_REVERT_IF_NOT_CHANGED</constant></term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><constant>HW_API_REPLACE_KEEP_TIME_MODIFIED</constant></term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
</variablelist>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><xref linkend="function.hwapi-insert" /></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->