hw_api::remove
(PHP 4, PHP 5 < 5.2.0, PECL hwapi SVN)
hw_api::remove — Efface un objet
Description
$parameter
)Efface un objet avec un parent spécifique. Les collections seront effacées récursivement.
Liste de paramètres
-
parameter -
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.
Le paramètre
parameterest un tableau qui contient les éléments obligatoires "objectidentifier" et "parentidentifier". Si vous souhaitez effacer un utilisateur ou un groupe, "parentidentifier" peut être omis.L'élément optionnel "mode" 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 "removelinks" toutes les références vers et depuis l'objet seront aussi effacées. En mode "nonrecursif", l'effacement n'est pas récursif. Effacer une collection qui n'est pas vide causera une erreur.
Valeurs de retour
Cette fonction retourne TRUE en cas de
succès ou FALSE si une erreur survient.
