Présentation

ICopixUserHandler est l'interface que devront respecter l'ensemble des gestionnaires d'authentification que vous serez amené à développer.

interface ICopixUserHandler {
    public function login  ($pParams);
    public function logout ($pParams);
    public function getInformations ($pUserId);
    public function find ($pParams = array ());
}

Connexion / Déconnexion

Les méthodes de connexion / déconnexion acceptent en entrée un paramètre sous la forme d'un tableau associatif.

A l'heure actuelle, seule la méthode de login dispose de clefs réservées, à savoir :

• login : le login demandé pour la connexion
• password : le mot de passe en clair demandé pour la connexion

Les méthodes de connexion / déconnexions retourne une réponse sous la forme d'un objet de type CopixUserLogResponse.

Informations sur l'utilisateur

La méthode getInformations accepte en paramètre l'identifiant de l'utilisateur pour le handler donné.

Elle retourne un objet de classe quelconque implémentant l'interface ICopixUser avec autant de propriétés que d'informations supplémentaires à connaitre sur notre utilisateur.

Recherche d'utilisateurs

La méthode find est chargée de rechercher des utilisateurs en fonction de plusieurs critères.

Les critères ne sont pas figés et vous pouvez en prendre en charge autant que vous le souhaitez. Toutefois, votre méthode se doit d'être capable de rechercher les utilisateurs en fonctions des critères suivants :

• id pour l'identifiant de l'utilisateur
• login pour le login de l'utilisateur
• caption pour le nom complet de l'utilisateur

En outre, cette méthode renvoie un tableau d'objets implémentant l'interface ICopixUser.