API−LCS API−LCS: Documentation bibliothèque des fonctions LCS

API−LCS
Documentation bibliothèque des fonctions LCS
Jean−Luc « jLCF >:−> » Chrétien
Administrateur Système et Réseau
Lycée Pierre et Marie Curie
Équipe académique tice
21, rue du moulin au Roy
14000 Caen
Tél : +33.(0)2.31.56.61.42
jean−[email protected]−caen.fr
Copyright © 2003 par jLCF
API−LCS: Documentation bibliothèque des fonctions
LCS
Sommaire
Table des matières
1. Exploitation de l'API−LCS par les utilisateurs
1.1. Principe
1.2. Exemples d'usage
A. Source du document
Liste des exemples
1−1. Déclaration de la bibliothèque de fonctions
1−2. Exploitation du retour de la fonction auth_lcs()
1−3. Exploitation du retour de la fonction people_get_variables()
Suivant: Exploitation de l'API−LCS par les utilisateurs
API−LCS: Documentation bibliothèque des fonctions
LCS
Suivant, Précédent
Chapitre 1. Exploitation de l'API−LCS par les
utilisateurs
Table des matières
1.1. Principe
1.2. Exemples d'usage
1.1. Principe
A partir de la version 1.1 du Serveur de communication LCS, les utilisateurs disposent d'une bibliothèque de
fonctions permettant d'exploiter les informations concernant l'authentification et certaines informations
propres à un utilisateur (nom, prénom, mèle, groupes d'appartenance...). Ainsi un utilisateur ayant son «espace
perso» d'ouvert pourra utiliser ces informations dans ses propres scripts php.
Sommaire
Précédent: API−LCS
Suivant: Exemples d'usage
API−LCS: Documentation bibliothèque des fonctions
LCS
Suivant, Précédent
Chapitre 1. Exploitation de l'API−LCS par les utilisateurs
1.2. Exemples d'usage
Exemple 1−1. Déclaration de la bibliothèque de fonctions
Pour pouvoir exploiter les fonctions de l'API−LCS, l'utilisateur devra inclure dans ces scripts php la directive
suivante :
<?php
// script php déposé dans le repertoir public_html de l'utilisateur
// Inclusion des fonctions de l'API−LCS
include ("/var/www/lcs/includes/user_lcs.inc.php");
...
...
?>
Exemple 1−2. Exploitation du retour de la fonction auth_lcs()
<?php
// script php déposé dans le repertoir public_html de l'utilisateur
// Inclusion des fonctions de l'API−LCS
include ("/var/www/lcs/includes/user_lcs.inc.php");
$login = auth_lcs();
if ($login) {
// Si $login alors traitement
} else {
// Sinon redirection vers le formulaire d'authentification
header("Location:$urlauth");
}
?>
Exemple 1−3. Exploitation du retour de la fonction people_get_variables()
La fonction people_get_variables($login, true) retourne (si l''utilisateur $login existe) deux tableaux :
•
$user : qui retourne les paramètres de l'utilisateur :
♦
$user["fullname"] : Le nom complet de l'utilisateur.
♦
$user["nom"] : Le nom de l'utilisateur.
♦
$user["prenom"] : Le prénom de l'utilisateur.
♦
$user["description"] : La description de l'utilisateur.
♦
$user["email"] : L'adresse mèl de l'utilisateur.
•
$groups : qui retourne les groupes d'appartenance de l'utilisateur
<?php
include ("/var/www/lcs/includes/user_lcs.inc.php");
$login = auth_lcs();
if ( $login) {
list($user, $groups)=people_get_variables($login, true);
echo "<H3>Exemple d'exploitation du retour de la fonction people_get_variables()</H3>\n";
echo "<H4>Bonjour ".$user["fullname"]." vous êtes authentifié sur le serveur LCS</H4>\n";
if ($user["description"]) echo "<P>Vous êtes ".$user["description"]."</P>\n";
if ( count($groups) ) {
echo "<U>Membre des groupes</U> :<BR>\n<UL>\n";
for ($loop=0; $loop < count ($groups) ; $loop++) {
echo "<LI>".$groups[$loop]["cn"];
echo "<font size=\"−2\"> ".$groups[$loop]["description"];
echo "</font></LI>\n";
}
echo "</UL>\n";
}
echo "<U>Adresse mèl</U> : ".$user["email"]."\n";
} else {
header("Location:$urlauth");
}
?>
Sommaire, Niveau supérieur
Précédent: Exploitation de l'API−LCS par les utilisateurs
Suivant: Source du document
API−LCS: Documentation bibliothèque des fonctions
LCS
Précédent
Annexe A. Source du document
ce document est disponible :
•
en ligne : Documentation LCS API−LCS
•
au format xml, fichier source, dtd docbook−xml version 3.1 : api_lcs.xml
•
au format pdf : api_lcs.pdf
Sommaire
Précédent: Exemples d'usage