mirror of
https://github.com/php/doc-ja.git
synced 2026-03-27 16:42:17 +01:00
edc3d6b148
git-svn-id: https://svn.php.net/repository/phpdoc/ja/trunk@324071 c90b9560-bf6c-de11-be94-00142212c4b1
92 lines
3.0 KiB
XML
92 lines
3.0 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.remove">
|
|
<refnamediv>
|
|
<refname>hw_api::remove</refname>
|
|
<refpurpose>オブジェクトを削除する</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>bool</type><methodname>hw_api::remove</methodname>
|
|
<methodparam><type>array</type><parameter>parameter</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
指定した親から、オブジェクトを削除します。コレクションは、
|
|
再帰的に削除されます。
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>parameter</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
オプションのオブジェクトクエリを渡し、
|
|
条件を満たすオブジェクトのみを削除することも可能です。
|
|
それが最後のインスタンスである場合、オブジェクトは物理的に削除されます。
|
|
</para>
|
|
<para>
|
|
パラメータの配列には、必須要素
|
|
'objectidentifier' および 'parentidentifier' が含まれます。
|
|
ユーザーやグループを削除したい場合には 'parentidentifier' は省略することができます。
|
|
</para>
|
|
<para>
|
|
オプションのパラメータ 'mode' は、削除をどのように行うかを指定します。
|
|
normal モードは、すべてのインスタンスが削除されるまで物理的な削除を行いません。
|
|
physical モードは、オブジェクトの全インスタンスが即時に削除されます。
|
|
removelinks モードは、そのオブジェクトが参照している先、
|
|
およびそのオブジェクトを参照している元も含めて削除されます。
|
|
nonrecursive の場合は、再帰的な削除は行われません。
|
|
空でないコレクションを削除しようとすると、エラーが発生します。
|
|
</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.move" /></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
|
|
-->
|