13.2 Classe ActionUsage

La classe ActionUsage gère la définition et la validation des paramètres d'une action.

Elle permet de spécifier et contrôler la présence de paramètres requis ou optionnels, et de retourner un texte d'aide précisant les paramètres requis lorsque la validation échoue.

La classe ActionUsage hérite de la classe ApiUsage.

13.2.1 Constructeur

new ActionUsage ( Action & $action )

13.2.1.1 Liste des paramètres

(Action) action

L'objet $action courant.

13.2.1.2 Exemples

function mon_action(Action & $action) {
    $usage = new ActionUsage($action);
    $docId = $usage->addRequiredParameter("id", "document identifier");
    $usage->verify();
 
    doSomethingWith($docId);
}

13.2.1.3 Notes

Cette classe est utilisée pour les actions déclenchés par le serveur web ou via le script wsh.

Lorqu'il est déclenché par le serveur web, les paramètres sont récupérées par les variables suivantes dans l'ordre indiqué :

1. $_GET : Variable HTTP GET
2. $_POST : Variable HTTP POST (formulaire)
3. $_FILES : 3.2.21 Formulaire avec fichier

Les variables GET sont prioritaires aux variables POST qui sont prioritaires aux variables FILES.

Les variables HTTP suivantes sont déclarées :

• sole : indicateur du format de la page (obsolète) - gardé pour compatibilité
• authtype : mode d'authentification 3.2.23
• dcpopen-authorization : jeton d'authentification 3.2.23
• privateid : si authtype=open (obsolète) - gardé pour compatibilité. 3.2.23

Si le mode strict n'est pas désactivé, ces variables restent autorisées.

Dans le cas d'un fichier, la valeur retournée par les méthodes add*Parameter() est un tableau contenant le contenu de la variable HTTP :

• name : Le nom original du fichier, tel que sur la machine du client web.
• type :Le type MIME du fichier, si le navigateur a fourni cette information.
• size : La taille, en octets, du fichier téléchargé.
• tmp_name : Le nom temporaire du fichier qui sera chargé sur la machine serveur.
• error : Le code d'erreur associé au téléchargement de fichier.

13.2.1.4 Voir aussi

• ApiUsage