Présentation

L'interface ICopixUser s'applique aux objets renvoyés par les méthodes getInformations() et find() de ICopixUserHandler. En outre, l'objet CopixUser implémente lui-même cette interface.

Cette interface permet de s'assurer que différents ICopixUserHandler renverront tous des informations respectant une convention minimale (l'interface ICopixUser). Cela permet donc à du code ayant besoin d'informations sur un utilisateur de ne pas avoir à ce soucier du CopixUserHandler? qui a réellement généré l'information.

API

getCaption()

string public function getCaption()

Retourne le libellé d'un utilisateur : une chaîne destinée à être présentée à l'utilsateur.

getHandler()

string public function getHandler()

Retourne l'identifiant du gestionnaire d'utilisateurs. Cette chaîne peut être utilisée pour obtenir un instance du gestionnaire avec CopixUserHandlerFactory?.

getLogin()

string public function getLogin()

Retourne le login de l'utilisateur, qui est la chaîne utilisée pour s'identifier auprès du gestionnaire d'utilisateurs renvoyé par getHandler().

getId()

string public function getId()

Retourne l'identifiant de l'utilisateur. Cet identifiant est une valeur propre au gestionnaire d'utilisateur et permet de distinguer deux utilisateurs différents.

Exemple

J'ai besoin d'afficher le libellé d'un utilisateur dont je n'ai que le nom d'UserHandler? ($userHandler) et l'identifiant de l'utilisateur ($userId).

Voici comment faire :

<?php
// Récupère une instance de l'UserHandler ($handler respecte ICopixUserHandler)
$handler = CopixUserHandlerFactory::create($userHandler);
// Récupère les informations sur l'utilisateur ($userInfo respecte ICopixUser)
$userInfo = $handler->getInformations($userId);
// Affiche le libellé
echo $userInfo->getCaption();
?>

Cette méthode fonctionnera quelque soit le UserHandler? qui correspond à $userHandler.