API noyau/module - Historique des versions

Laucho : /* API date/temps */

2013-05-06T15:42:35Z

‎API date/temps

Marcelos : /* bab_getFileMimeType() */

2011-03-08T11:40:42Z

‎bab_getFileMimeType()

Jeraiz le 11 décembre 2009 à 09:59

2009-12-11T09:59:41Z

Paul : /* API Moteur d'indexation */ déplacée vers la page indexation

2009-06-16T15:03:35Z

‎API Moteur d'indexation : déplacée vers la page indexation

Paul : /* API ACL */

2009-03-05T18:59:08Z

‎API ACL

Paul : /* API Groupes */

2009-03-05T18:51:02Z

‎API Groupes

Paul : /* API date/temps */

2009-03-05T18:49:35Z

‎API date/temps

Paul : /* API Utilisateur */

2009-03-05T18:48:56Z

‎API Utilisateur

Voir les modifications

Paul : /* API Annuaires */

2009-03-05T18:47:49Z

‎API Annuaires

Paul le 5 mars 2009 à 18:43

2009-03-05T18:43:47Z

@@ Ligne 6 : / Ligne 6 : @@
 Ces fonctions se trouvent dans le fichier addonapi.php qui se trouve dans le répertoire '''"utilit"''' de la distribution.
-== API date/temps ==
+== API dates/heures ==
 Voir l'article : [[API des dates]]

@@ Ligne 134 : / Ligne 134 : @@
 * '''$file''' :
 *: Chemin complet (sur le système) vers le fichier
 ===bab_getFileContentDisposition()===

← Version précédente		Version du 11 décembre 2009 à 09:59
Ligne 268 :		Ligne 268 :

	:'''function bab_getActiveSessions()'''		:'''function bab_getActiveSessions()'''
		+
		+	== API Authentification ==
		+	===bab_requireCredential()===
		+
		+	L'appel à cette fonction force l'affichage du formulaire d'authentification d'Ovidentia. Après renseignement de l'identifiant et du mot de passe, l'utilisateur est automatiquement redirigé vers la page d'origine où bab_requireCredential() a été appelée.
		+
		+	Exemple d'utilisation : l'utilisateur courant se situe sur une page restreinte par des droits d'accès. On a vérifié que l'utilisateur courant n'avait pas les droits nécessaires : on cherche donc à l'amener sur le formulaire d'authentification.
		+
		+	Cette fonction peut s'avérer très utile dans le cas d'urls externes. Par exemple : un utilisateur reçoit un e-mail contenant une adresse url vers le portail Ovidentia. Si bab_requireCredential() a été utilisé, l'utilisateur sera redirigé vers le formulaire d'authentification s'il n'avait pas les droits nécessaires.
		+
		+	'''function bab_requireCredential($message)'''
		+
		+	* '''$message'''
		+	*: Message d'erreurs qui sera affiché avec le formulaire d'authentification
		+
		+
		+	===bab_requireAccess===
		+
		+	L'appel à cette fonction force l'affichage du formulaire d'authentification d'Ovidentia. Après renseignement de l'identifiant et du mot de passe, l'utilisateur est automatiquement redirigé vers la page d'origine où bab_requireAccess() a été appelée.
		+
		+	Cette fonction est quasi-similaire à bab_requireCredential(). Elle contient cependant 2 paramètres supplémentaires permettant de faciliter son utilisation avec des droits ACL (tables *_groups).
		+
		+	'''function bab_requireAccess($tables, $idObject, $loginMessage)'''
		+
		+	* '''$tables'''
		+	*: nom de la table ACL ou tableau contenant les noms des tables ACL à tester. Attention : la redirection vers le formulaire d'authentification sera effectuée si l'utilisateur n'a pas accès dans l'un des droits d'accès (OU).
		+	* '''$idObject'''
		+	*: Identifiant de l'objet à tester avec les tables ACL
		+	* '''$loginMessage'''
		+	*: Message d'erreurs qui sera affiché avec le formulaire d'authentification

← Version précédente		Version du 16 juin 2009 à 15:03
Ligne 180 :		Ligne 180 :
	:'''function bab_getDebug()'''		:'''function bab_getDebug()'''

−	~~== API Moteur d'indexation ==~~
−	~~===bab_searchEngineInfos()===~~

−	~~Retourne des informations sur le moteur d'indexation installé ou false si aucun moteur n'est installé.~~
−
−	~~Si un moteur est utilisé, la fonction retourne un tableau avec les clefs suivantes :~~
−
−	*name : nom du moteur
−	*description : description du moteur
−	*types : un tableau avec les types mimes supportés par l'indexation
−	*indexes : un tableau avec la liste des fichiers d'index is le moteur gère des fichiers d'index
−
−	~~Pour plus d'information sur l'indexation, voir la documentation spécifique : [[Indexation]]~~
−
−
−	~~:'''function bab_searchEngineInfos()'''~~

	== API Registry ==		== API Registry ==

@@ Ligne 44 : / Ligne 44 : @@
 == API ACL ==
-Il existe d'autres fonctions dans le fichier admin/acl.php qui sont disponibles. Pour voir toutes les fonctions en rapport avec les ACL, consultez la documentation [[Access Control List]]
+Consultez la documentation [[Access Control List#Fonctions pour tester les droits]]
-−
-===bab_isAccessValidByUser()===
-−
-Tester les droits d'accès pour un utilisateur spécifique
-−
-:'''function bab_isAccessValidByUser($table, $idobject, $iduser)'''
-−
-* '''$table''' :
-*: Nom de la table de droit
-* '''$idobject''' :
-*: Nombre entier, id de l'objet concerné par le droit a tester, par exemple l'id du thème d'article ou l'id du forum
-* '''$iduser''' :
-*: id de l'utilisateur
-−
-===bab_isAccessValid()===
-−
-Tester les doits d'accès pour l'utilisateur courant
-−
-:'''function bab_isAccessValid($table, $idobject)'''
-−
-* '''$table''' :
-*: Nom de la table de droit
-* '''$idobject''' :
-*: Nombre entier, id de l'objet concerné par le droit a tester, par exemple l'id du thème d'article ou l'id du forum
-−
-===bab_getUserIdObjects()===
-−
-Retourne un tableau contenant la liste des id accessibles par l'utilisateur courant
-−
-:'''function bab_getUserIdObjects($table)'''
-−
-* '''$table''' :
-*: Nom de la table de droit
-−
-===bab_getGroupsAccess()===
-−
-Retourne la liste des groupes d'Ovidentia qui ont accès à un objet
-−
-:'''function bab_getGroupsAccess($table, $idobject)'''
-−
-* '''$table''' :
-*: Nom de la table de droit
-* '''$idobject''' :
-*: Nombre entier, id de l'objet concerné par le droit a tester, par exemple l'id du thème d'article ou l'id du forum
 == API Calendrier popup ==

@@ Ligne 203 : / Ligne 203 : @@
 == API Groupes ==
+Voir l'article : [[API des groupes]]
-−
-===bab_getGroupsMembers()===
-Retourne un tableau contenant les utilisateurs membres du ou des groupes $ids.
-*Le tableau contient pour chaque utilisateur son ID ( "id" ), son email ("email") et son nom complet ("name")
-:'''function bab_getGroupsMembers($ids)'''
-* '''$ids''' :
-*: ID du groupe ou un tableau d'id de groupes
-−
-===bab_isMemberOfGroup()===
-Vérifie si l'utilisateur est l'utilisateur courant ou l'utilisateur d'ID $userid est membre du groupe $group.
-:'''function bab_isMemberOfGroup($group, $userid="")'''
-* '''$group''' :
-*: ID du groupe ou chaîne contenant le nom du groupe
-* '''$userid''' :
-*: ID de l'utilisateur. Si vide le système utilise l'ID de l'utilisateur courant.
-−
-−
-La fonction retourne l'id du groupe si l'utilisateur en fait parti, ou false
-−
-===bab_attachUserToGroup()===
-Affecte un utilisateur à un groupe
-:'''function bab_attachUserToGroup($iduser, $idgroup)'''
-* '''$iduser''' :
-*: ID de l'utilisateur à affecter au groupe
-* '''$idgroup''' :
-*: ID du groupe
-−
-===bab_detachUserFromGroup()===
-Détache un utilisateur d'un groupe. C'est à dire qu'il ne sera plus membre de ce groupe.
-:'''function bab_detachUserFromGroup($iduser, $idgroup)'''
-* '''$iduser''' :
-*: ID de l'utilisateur a enlever du groupe
-* '''$idgroup''' :
-*: ID du groupe
-−
-===bab_getGroupName()===
-−
-Obtenir le nom du groupe en fonction de son ID
-−
-:'''function bab_getGroupName($id, $fpn=true)'''
-−
-* '''$id''' :
-*: Id numérique du groupe
-* '''$fpn''' :
-*: Boolean qui permet de spécifier si le nom retourné contiens les groupes parents, si le paramètre n'est pas indiqué, le chemin complet vers le groupe est retourné.
-−
-===bab_getGroups()===
-−
-Obtenir la liste des groupes dans un tableau
-−
-:'''function bab_getGroups($parent=BAB_REGISTERED_GROUP, $all=true)'''
-−
-===bab_createGroup()===
-−
-Créer un groupe d'utilisateurs
-−
-:'''function bab_createGroup( $name, $description, $managerid, $parent = 1)'''
-−
-===bab_updateGroup()===
-−
-Modifier un groupe d'utilisateurs
-−
-:'''function bab_updateGroup( $id, $name, $description, $managerid)'''
-−
-===bab_removeGroup()===
-−
-Supprimer un groupe d'utilisateurs (les utilisateurs ne sont pas supprimés)
-−
-:'''function bab_removeGroup($id)'''
-−
 == API Debug ==

@@ Ligne 358 : / Ligne 358 : @@
 == API Annuaires ==
-===bab_getDirEntry()===
+Voir l'article : [[API des utilisateurs et des annuaires#Les fiches d'annuaires]]
-−
-Retourne une fiche d'annuaire ou une liste de fiches d'annuaires.
-−
-retourne false si il y a une erreur dans les paramètres
-−
-retourne un tableau vide si l'utilisateur n'a pas accès aux informations
-−
-:'''function bab_getDirEntry($id = false, $type = BAB_DIR_ENTRY_ID_USER, $id_directory = NULL )'''
-−
-−
-* '''$id''' :
-*: Ce paramètre est optionnel, les valeurs possibles sont :
-*:
-*: false : si le type est BAB_DIR_ENTRY_ID_USER, l'id de l'utilisateur connecté sera utilisé.
-*: un nombre entier : utilisable pour tout les types
-*: un tableau de nombre entiers : une liste d'id peut être utilisée pour les types BAB_DIR_ENTRY_ID_USER et BAB_DIR_ENTRY_ID dans ce cas la fonction retournera plusieurs fiches d'annuaire dans un tableau.
-−
-* '''type''' :
-*: Ce paramètre est optionnel, il correspond au type d'information fourni dans le premier paramètre de la fonction, les valeurs possibles sont
-*:
-*: BAB_DIR_ENTRY_ID_USER : $id est un id d'utilisateur
-*: BAB_DIR_ENTRY_ID : $id est un id de fiche d'annuaire
-*: BAB_DIR_ENTRY_ID_DIRECTORY : $id est un id d'annuaire, dans ce cas seul la liste des champs de l'annuaire est retournée
-*: BAB_DIR_ENTRY_ID_GROUP : $id est un id de groupe d'utilisateur, dans ce cas seul la liste des champs de l'annuaire de groupe est retournée
-*:
-*: La valeur par défaut est BAB_DIR_ENTRY_ID_USER
-−
-* '''$id_directory''' :
-*: Ce paramètre est optionnel, peut être spécifié si le type est BAB_DIR_ENTRY_ID
-−
-===bab_getUserDirectories()===
-−
-Retourne une liste d'annuaires visibles par l'utilisateur
-−
-:'''function bab_getUserDirectories()'''
-−
-===bab_getUserDirEntryLink()===
-−
-Cette fonction permet d'obtenir un lien vers une fiche d'annuaire, pour un utilisateur ou un ID de fiche d'annuaire.
-−
-retourne false si la fiche n'est pas accessible
-−
-:'''function bab_getUserDirEntryLink($id = false, $type = BAB_DIR_ENTRY_ID_USER, $id_directory = false)'''
-−
-* '''$id''' :
-*: Ce paramètre est optionnel, les valeurs possibles sont :
-*:
-*: false : si le type est BAB_DIR_ENTRY_ID_USER, l'id de l'utilisateur connecté sera utilisé.
-*: un nombre entier : utilisable pour tout les types
-−
-* '''type''' :
-*: Ce paramètre est optionnel, il correspond au type d'information fourni dans le premier paramètre de la fonction, les valeurs possibles sont
-*:
-*: BAB_DIR_ENTRY_ID_USER : $id est un id d'utilisateur
-*: BAB_DIR_ENTRY_ID : $id est un id de fiche d'annuaire
-*:
-*: La valeur par défaut est BAB_DIR_ENTRY_ID_USER
-−
-* '''$id_directory''' :
-*: Ce paramètre est optionnel, peut être spécifié si le type est BAB_DIR_ENTRY_ID
 == API Groupes ==

@@ Ligne 8 : / Ligne 8 : @@
 == API date/temps ==
+[[API des dates]]
-===bab_mktime()===
-Retourne un time stamp à partir d'une date MySQL ( ISO DATE ou ISO DATETIME par exemple : '2006-03-10 17:37:02' ou '2006-03-10')
-:'''function bab_mktime($time)'''
-−
-* '''$time''' :
-*: Date au format de ISO DATETIME de MySQL ( par ex: 2006-03-10 17:37:02 )
-−
-===bab_formatDate()===
-Retourne une chaîne contenant la date/heure formatée selon le format spécifié
-:'''function bab_formatDate($format, $time)'''
-−
-* '''$format''' :
-*: Format désiré. Par exemple '%'
-*: %d   Une représentation courte du jour ( sur trois caractères )
-*: %D   Jour de la semaine complet par exemple Lundi
-*: %j   Jour du mois ( padding avec zéros )
-*: %m   Une représentation courte du mois ( sur trois caractères )
-*: %M   Mois complet par exemple Avril
-*: %n   Une représentation abrégée du mois ( sur trois caractères )
-*: %Y   Représentation numérique de l'année, 4 caractères
-*: %y   Année sur deux carcatères
-*: %H   Heure au format 24 heures ( padding avec zéros )
-*: %i   Minutes ( padding avec zéros )
-*: %S   Format de la date courte préférée de l'utilisateur
-*: %L   Format de la date longue préférée de l'utilisateur
-*: %T   Format du temps préféré de l'utilisateur
-−
-* '''$time''' :
-*: Time stamp unix
-−
-===bab_time()===
-Retourne une chaîne contenant l'heure formatée selon les préférences de l'utilisateur
-:'''function bab_time($time)'''
-−
-* '''$time''' :
-*: Time stamp unix
-−
-===bab_longDate()===
-Retourne une chaîne contenant la date/heure dans un format long
-:'''function bab_longDate($time, $hour=true)'''
-* '''$time''' :
-*: Time stamp unix
-:'''function bab_longDate($time, $hour=true)'''
-* '''$hour''' :
-*: Si true la fonctionne retourne l'heure aussi sinon uniquement la date
-−
-===bab_shortDate()===
-Retourne une chaîne contenant la date/heure dans un format court
-:'''function bab_shortDate($time, $hour=true)'''
-* '''$time''' :
-*: Time stamp unix
-:'''function bab_longDate($time, $hour=true)'''
-* '''$hour''' :
-*: Si true la fonctionne retourne l'heure aussi sinon uniquement la date
 == API Navigateur ==