1
0
mirror of https://github.com/php/doc-ja.git synced 2026-04-29 11:03:19 +02:00
Files
archived-doc-ja/reference/hwapi/hw_api/checkin.xml
T
TAKAGI Masahiro 8aa8aa561d sync with en.
git-svn-id: https://svn.php.net/repository/phpdoc/ja/trunk@322540 c90b9560-bf6c-de11-be94-00142212c4b1
2012-01-21 12:05:47 +00:00

134 lines
4.1 KiB
XML

<?xml version="1.0" encoding="UTF-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 0d604bbc9d3b741d53e7fac26f5b24c306751e9a Maintainer: takagi Status: ready -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="hwapi.checkin">
<refnamediv>
<refname>hw_api::checkin</refname>
<refpurpose>オブジェクトをチェックインする</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>
この関数は、オブジェクトあるいはオブジェクト階層の全体をチェックインします。
パラメータ配列の中には、必須要素 'objectIdentifier'
およびオプションの要素 'version'、'comment'、'mode'、'objectQuery'
が含まれます。'version' ではオブジェクトのバージョンを設定します。
これは、メジャーバージョンとマイナーバージョンをピリオドで区切ったものです。
version が設定されていない場合、マイナーバージョンがひとつ加算されます。
'mode' は以下の値のいずれかです。
<variablelist>
<varlistentry>
<term>HW_API_CHECKIN_NORMAL</term>
<listitem>
<simpara>
オブジェクトをチェックインし、コミットします。
オブジェクトは文書でなければなりません。
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>HW_API_CHECKIN_RECURSIVE</term>
<listitem>
<simpara>
チェックインするオブジェクトがコレクションであった場合、
もし子要素が文書であればそれらもすべて再帰的にチェックインされます。
コレクションをチェックインしようとすると、エラーが発生することがあります。
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>HW_API_CHECKIN_FORCE_VERSION_CONTROL</term>
<listitem>
<simpara>
バージョン管理されていないオブジェクトも強制的にチェックインします。
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>HW_API_CHECKIN_REVERT_IF_NOT_CHANGED</term>
<listitem>
<simpara>
新しいバージョンが以前のバージョンと変わっているかどうかを調べます。
変わっている場合にのみオブジェクトがチェックインされます。
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>HW_API_CHECKIN_KEEP_TIME_MODIFIED</term>
<listitem>
<simpara>
直近のオブジェクトの更新時刻を保持します。
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>HW_API_CHECKIN_NO_AUTO_COMMIT</term>
<listitem>
<simpara>
オブジェクトのチェックイン時に、自動的なコミットは行われません。
</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
-->