13.1.3 Action::canExecute

13.1.3.1 Description

string canExecute ( string $actname [, int $appid = ""] )

Permet de vérifier si l'utilisateur connecté a le droit d'exécuter une action donnée.

13.1.3.2 Avertissements

N/A

13.1.3.3 Liste des paramètres

(string) actname

Le nom de l'action dont on souhaite vérifier le droit d'exécution pour l'utilisateur connecté.

(int) appid

Identifiant de l'application de l'action dont on souhaite vérifier le droit d'exécution. Par défaut, l'application de l'objet Action est utilisée.

13.1.3.4 Valeur de Retour

Retourne une chaîne vide si l'utilisateur a le droit d'exécuter l'action donnée, ou une chaîne non vide lorsque l'utilisateur n'a pas le droit d'exécuter l'action donnée ou s'il y a une erreur dans la vérification du droit.

13.1.3.5 Erreurs / Exceptions

En cas d'erreur dans la vérification des droits (ex. application ou action non existante), une chaîne non vide est retournée avec le message d'erreur rencontré.

13.1.3.6 Historique

N/A

13.1.3.7 Exemples

• Exemple #1 Vérifier si l'utilisateur a le droit d'exécuter l'action MY_ACTION de l'application de l'action courante

$err = $action->canExecute('MY_ACTION');
if ($err != '') {
    /*
     * User is not allowed to execute MY_ACTION,
     * or MY_ACTION does not exists
     */
    [...]
}
/*
 * User is allowed to execute MY_ACTION
 */
[...]

• Exemple #2 Vérifier si l'utilisateur a le droit d'exécuter l'action MY_ACTION de l'application MY_APP

$null = null;
 
$application = new \Application();
$err = $application->set('MY_APP', $null);
if ($err != '') {
    throw new Exception(sprintf("Could not find application with name 'MY_APP': %s", $err));
}
 
$err = $action->canExecute('MY_ACTION', $application->id);
if ($err != '') {
    /*
     * User is not allowed to execute MY_ACTION from MY_APP,
     * or MY_ACTION from MY_APP does not exists
     */
    [...]
}
/*
 * User is allowed to execute MY_ACTION from MY_APP
 */
[...]

13.1.3.8 Notes

N/A

13.1.3.9 Voir aussi

N/A