IPS_DeleteRole

 bool IPS_DeleteRole (string $Rolle) 

Parameterliste

Rückgabewert

Konnte die Funktion erfolgreich ausgeführt werden, liefert sie als Ergebnis TRUE, andernfalls FALSE.

Beschreibung

Die Funktion löscht die Rolle mit dem Namen Rolle mitsamt ihren Berechtigungen. Die Rolle wird dabei automatisch von allen Benutzern entfernt, denen sie zugewiesen war – diese verlieren somit alle Berechtigungen, die sie nur über diese Rolle erhalten haben.

Existiert die Rolle nicht, schlägt die Funktion mit "Role with name '…' does not exist" fehl. Die Rolle @admin kann nicht gelöscht werden ("Role @admin cannot be deleted!").

Der ausführende Benutzer muss Administrator sein (siehe IPS_IsAdministrator), ansonsten schlägt die Funktion mit "Administrator permissions are required for this action!" fehl.

Die Rollenverwaltung steht nur mit einer Lizenz zur Verfügung, welche das RBAC-Feature enthält. Andernfalls schlägt die Funktion mit "This function is only available for licenses with the RBAC feature enabled!" fehl. Sind mehr Benutzer angelegt, als die Lizenz erlaubt, schlägt die Funktion mit "Your license is currently limited to … users. Please consider upgrading the license to more users!" fehl.

Beispiel

if (IPS_RoleExists('Bewohner')) {
    IPS_DeleteRole('Bewohner');
}