1
0
mirror of https://github.com/php/doc-es.git synced 2026-03-26 00:12:06 +01:00
Files
archived-doc-es/reference/hwapi/hw_api/checkin.xml
2014-09-05 20:55:10 +00:00

136 lines
3.6 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 14af302c9c0e561fa6f9cdd956268758ba9a89c5 Maintainer: regiemix Status: ready -->
<!-- Reviewed: no -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="hwapi.checkin">
<refnamediv>
<refname>hw_api::checkin</refname>
<refpurpose>Registra un objeto</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>hw_api::checkin</methodname>
<methodparam><type>array</type><parameter>parameter</parameter></methodparam>
</methodsynopsis>
<para>
Esta función registra un objeto o una jerarquía entera de objetos.
El array de parámetros contiene el elemento obligatorio
'objectIdentifier' y los elementos opcionales 'version', 'comment', 'mode'
y
'objectQuery'. 'version' especifica la versión del objeto. Consiste en
la versión mayor y menor separada por un punto. Si la versión no está
definida, se incrementa la menor versión. 'mode' puede ser uno de los siguientes
valores:
<variablelist>
<varlistentry>
<term>HW_API_CHECKIN_NORMAL</term>
<listitem>
<simpara>
Registra y consolida el objeto. El objeto debe ser un documento.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>HW_API_CHECKIN_RECURSIVE</term>
<listitem>
<simpara>
Si el objeto a registrar es una colección, todos los hijos serán
registrados recursivamente si son documentos. Si se intenta registrar
una colección devolverá un error.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>HW_API_CHECKIN_FORCE_VERSION_CONTROL</term>
<listitem>
<simpara>
Registra un objeto aunque no pase el control de versiones.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>HW_API_CHECKIN_REVERT_IF_NOT_CHANGED</term>
<listitem>
<simpara>
Valida si la versión nueva es diferente de la última versión. A menos que
este sea el caso, el objeto será registrado.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>HW_API_CHECKIN_KEEP_TIME_MODIFIED</term>
<listitem>
<simpara>
Conserva la fecha de modificación del objeto más reciente.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>HW_API_CHECKIN_NO_AUTO_COMMIT</term>
<listitem>
<simpara>
El objeto no se consolida automáticamente (commit) en el momento de ser registrado.
</simpara>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>parameter</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><xref linkend="hwapi.checkout" /></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:"~/.phpdoc/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
-->