mirror of
https://github.com/php/doc-es.git
synced 2026-03-26 16:32:13 +01:00
96d8829aac
git-svn-id: https://svn.php.net/repository/phpdoc/es/trunk@334774 c90b9560-bf6c-de11-be94-00142212c4b1
94 lines
2.7 KiB
XML
94 lines
2.7 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.remove">
|
|
<refnamediv>
|
|
<refname>hw_api::remove</refname>
|
|
<refpurpose>Eliminar un objeto</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>
|
|
Elimina un objeto desde un padre especificado. Las colecciones
|
|
serán eliminadas recursivamente.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>parameter</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
Se puede pasar un objeto opcional de tipo query para eliminar únicamente los objetos que
|
|
coincidan con la query. Un objeto será eliminado físicamente si se trata de
|
|
la última instancia.
|
|
</para>
|
|
<para>
|
|
El parámetro es un array que contiene los elementos obligatorios 'objectidentifier'
|
|
y 'parentidentifier'. En caso de querer eliminar un usuario o grupo,
|
|
'parentidentifier' puede ser omitido.
|
|
</para>
|
|
<para>
|
|
El parámetro opcional 'mode' determina cómo se realizará la
|
|
eliminación. En modo normal el objeto no será eliminado físicamente
|
|
hasta que todas las instancias sean eliminadas. En modo físico todas las instancias del
|
|
objeto serán eliminadas inmediatamente. En modo 'removelinks' todas las referencias
|
|
hacia y desde los objetos serán eliminadas también. En modo 'nonrecursive' la
|
|
eliminación no se realizará recursivamente. Eliminar una colección que
|
|
no está vacía generará un error.
|
|
</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
|
|
-->
|