php-doc-en/reference/hwapi/functions/hwapi-insert.xml

<?xml version='1.0' encoding='iso-8859-1' ?>
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/hwapi.xml, last change in rev 1.1 -->
  <refentry id="function.hwapi-insert">
   <refnamediv>
    <refname>hw_api->insert</refname>
    <refpurpose>Inserts a new object</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
    <methodsynopsis>
     <type>object</type><methodname>insert</methodname>
     <methodparam><type>array</type><parameter>parameter</parameter></methodparam>
    </methodsynopsis>
    <para>
     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.
     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:
     <variablelist>
      <varlistentry>
       <term><constant>HW_API_INSERT_NORMAL</constant></term>
       <listitem>
        <simpara>
         The object in inserted into the server.
        </simpara>
       </listitem>
      </varlistentry>
      <varlistentry>
       <term><constant>HW_API_INSERT_FORCE_VERSION_CONTROL</constant></term>
       <listitem>
        <simpara>
        </simpara>
       </listitem>
      </varlistentry>
      <varlistentry>
       <term><constant>HW_API_INSERT_AUTOMATIC_CHECKOUT</constant></term>
       <listitem>
        <simpara>
        </simpara>
       </listitem>
      </varlistentry>
      <varlistentry>
       <term><constant>HW_API_INSERT_PLAIN</constant></term>
       <listitem>
        <simpara>
        </simpara>
       </listitem>
      </varlistentry>
      <varlistentry>
       <term><constant>HW_API_INSERT_KEEP_TIME_MODIFIED</constant></term>
       <listitem>
        <simpara>
        </simpara>
       </listitem>
      </varlistentry>
      <varlistentry>
       <term><constant>HW_API_INSERT_DELAY_INDEXING</constant></term>
       <listitem>
        <simpara>
        </simpara>
       </listitem>
      </varlistentry>
     </variablelist>
    </para>
    <para>
     See also <function>hwapi_replace</function>.
    </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
-->