mirror of
https://github.com/macintoshplus/doc-fr.git
synced 2026-03-29 12:22:19 +02:00
79c7478ede
git-svn-id: https://svn.php.net/repository/phpdoc/fr/trunk@259743 c90b9560-bf6c-de11-be94-00142212c4b1
98 lines
2.9 KiB
XML
98 lines
2.9 KiB
XML
<?xml version="1.0" encoding="iso-8859-1"?>
|
|
<!-- $Revision: 1.15 $ -->
|
|
<!-- EN-Revision: 1.10 Maintainer: yannick Status: ready -->
|
|
<!-- Reviewed: yes -->
|
|
|
|
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.hwapi-remove">
|
|
<refnamediv>
|
|
<refname>hw_api->remove</refname>
|
|
<refpurpose>Efface un objet</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<classsynopsis>
|
|
<ooclass><classname>hw_api</classname></ooclass>
|
|
<methodsynopsis>
|
|
<type>bool</type><methodname>remove</methodname>
|
|
<methodparam><type>array</type><parameter>parameter</parameter></methodparam>
|
|
</methodsynopsis>
|
|
</classsynopsis>
|
|
<para>
|
|
Efface un objet avec un parent spécifique. Les collections
|
|
seront effacées récursivement.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>parameter</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
Vous pouvez passez un objet optionnel de requête pour filtrer les objets qui
|
|
seront effacés. Un objet sera effacé physiquement si c'est sa dernière
|
|
instance.
|
|
</para>
|
|
<para>
|
|
Le paramètre <parameter>parameter</parameter> est un tableau
|
|
qui contient les éléments obligatoires <literal>"objectidentifier"</literal> et <literal>"parentidentifier"</literal>.
|
|
Si vous souhaitez effacer un utilisateur ou un groupe, <literal>"parentidentifier"</literal>
|
|
peut être omis.
|
|
</para>
|
|
<para>
|
|
L'élément optionnel <literal>"mode"</literal> détermine comment l'effacement
|
|
est réalisé. En mode normal, l'objet sera effacé physiquement lorsque
|
|
toutes ses instances seront supprimées. En mode physique, toutes les
|
|
instances d'un objet seront supprimées immédiatement. En mode
|
|
<literal>"removelinks"</literal> toutes les références vers et depuis l'objet seront aussi
|
|
effacées. En mode <literal>"nonrecursif"</literal>, l'effacement n'est pas récursif.
|
|
Effacer une collection qui n'est pas vide causera une erreur.
|
|
</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="function.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:"../../../../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
|
|
-->
|