hw_api::remove
(PHP 4, PHP 5 < 5.2.0, PECL hwapi SVN)
hw_api::remove — Eliminar un objeto
Descripción
$parameter
) : boolElimina un objeto desde un padre especificado. Las colecciones serán eliminadas recursivamente.
Parámetros
-
parameter -
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.
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.
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.
Valores devueltos
Devuelve TRUE en caso de éxito o FALSE en caso de error.
add a note
