API noyau/module : Différence entre versions

De OviWiki
Aller à : navigation, rechercher
(→‎bab_composeUserName())
(→‎bab_userIsloggedin())
Ligne 167 : Ligne 167 :
  
 
===bab_userIsloggedin()===
 
===bab_userIsloggedin()===
 +
Retourne '''true''' si l'utilisateur courant est authentifié. Sinon elle retourne '''false'''
 
:'''function bab_userIsloggedin()'''
 
:'''function bab_userIsloggedin()'''
 +
 
===bab_registerUser()===
 
===bab_registerUser()===
 
:'''function bab_registerUser($firstname, $lastname, $middlename, $email, $nickname, $password1, $password2, $confirmed, &$error, $bgroup = true)'''
 
:'''function bab_registerUser($firstname, $lastname, $middlename, $email, $nickname, $password1, $password2, $confirmed, &$error, $bgroup = true)'''

Version du 26 février 2008 à 17:49

Sommaire

Introduction

Cette partie contient l'ensemble des fonctions mises à la disposition des modules par le noyau. Ces fonctions se trouvent dans le fichier addonappi.php qui se trouve dans le répertoire "utilit" de la distribution.


API date/temps

bab_time()

Retourne une chaîne contenant la date/heure formatée selon les préférences de l'utilisateur

function bab_time($time)
  • $time :
    Time stamp unix

bab_mktime()

Retourne un time stamp à partir d'une date MySQL ( DATETIME : '2006-03-10 17:37:02')

function bab_mktime($time)
  • $time :
    Date au format de 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
     %j Jour du mois ( padding avec zéros )
     %m Une représentation courte du mois ( sur trois caractères )
     %M Mois
     %n Une représentation numérique courte 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_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

bab_browserOS()

Retourne le système d'exploitation ( windows, macos, linux ou chaîne vide si autre )

function bab_browserOS()

bab_browserAgent()

Retourne le type de navigateur ( konqueror, opera, msie, nn6, nn4 ou chaîne vide si autre )

function bab_browserAgent()

bab_browserVersion()

Retourne la version du navigateur

function bab_browserVersion()

API Traduction

bab_translate()

Permet de traduire une chaîne

function bab_translate($str, $folder = "", $lang="")
  • $str :
    Contient la chaîne à traduire
  • $folder :
    Sous répertoire du répertoire lang ( pour les modules )
  • $lang :
    Vers quelle langue il faut faire la traduction. Si vide le système utilise la langue courante

bab_getAvailableLanguages()

Retourne un tableau contenant les différentes langues disponibles

function bab_getAvailableLanguages()


API Utilisateur

bab_isUserAdministrator()

Retourne true si l'utilisateur est administrateur. Sinon false

function bab_isUserAdministrator()

bab_isUserGroupManager()

Retourne true si l'utilisateur est gestionnaire du groupe d'id $grpid. Sinon false

function bab_isUserGroupManager($grpid="")
  • $grpid :
    ID du groupe pour lequel on souhaite savoir si l'utilisateur est gestionnaire. Si vide la fonction retiourne true si l'utilisateur est gestionnaire d'au moins un groupe.


bab_getUserName()

Retourne le nom complet de l'utilisateur d'ID $id.Sinon une chaîne vide.

function bab_getUserName($id)
  • $id :
    ID de l'utilisateur

bab_getUserEmail()

Retourne l'adresse email de l'utilisateur d'ID $id.Sinon une chaîne vide.

function bab_getUserEmail($id)
  • $id :
    ID de l'utilisateur

bab_getUserNickname()

Retourne l'identifiant de l'utilisateur d'ID $id.Sinon une chaîne vide.

function bab_getUserNickname($id)
  • $id :
    ID de l'utilisateur

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.


bab_getUserIdByEmail()

Retourne l'ID de l'utilisateur à partir de son adresse email. Retourne 0 si aucun utilisateur

function bab_getUserIdByEmail($email)
  • $email :
    Adresse email de l'utilisateur

bab_getUserIdByNickname()

Retourne l'ID de l'utilisateur à partir de son identifiant. Retourne 0 si aucun utilisateur

function bab_getUserIdByNickname($nickname)
  • $nickname :
    Identifiant de l'utilisateur

bab_getUserId()

Retourn l'ID de l'utilisateur à partir de son nom. Sinon 0.

function bab_getUserId( $name )
  • $name :
    Nom de l'utilisateur

bab_getUserGroups()

Retourne un tableau contenant les ID et les noms des groupes auxquels l'utilisateur appartient.

function bab_getUserGroups($id = "")
  • $id :
    ID de l'utilisateur. Si vide le système utilise celui de l'utilisateur courant

bab_composeUserName()

Retourne une chaîne contenant le nom complet de l'utilisateur selon les préférences du site ( nom/prénom ou prénom/nom )

function bab_composeUserName( $F, $L)
  • $F :
    Prénom de l'utilisateur
  • $L :
    Nom de l'utilisateur

bab_userIsloggedin()

Retourne true si l'utilisateur courant est authentifié. Sinon elle retourne false

function bab_userIsloggedin()

bab_registerUser()

function bab_registerUser($firstname, $lastname, $middlename, $email, $nickname, $password1, $password2, $confirmed, &$error, $bgroup = true)

bab_attachUserToGroup()

function bab_attachUserToGroup($iduser, $idgroup)

bab_detachUserFromGroup()

function bab_detachUserFromGroup($iduser, $idgroup)

bab_getUserInfos()

function bab_getUserInfos($id_user)

bab_updateUserById()

function bab_updateUserById($id, $info, &$error)

bab_uppdateUserById()

function bab_uppdateUserById($id, $info, &$error)

bab_updateUserByNickname()

function bab_updateUserByNickname($nickname, $info, &$error)

API ACL

bab_isAccessValidByUser()

function bab_isAccessValidByUser($table, $idobject, $iduser)

bab_isAccessValid()

function bab_isAccessValid($table, $idobject, $iduser=)

bab_getUserIdObjects()

function bab_getUserIdObjects($table)

bab_getUsersAccess()

function bab_getUsersAccess($table)

bab_getGroupsAccess()

function bab_getGroupsAccess($table, $idobject)


API Calendrier popup

bab_calendarPopup()

function bab_calendarPopup($callback, $month="", $year="", $low="", $high="")


API Création des répertoires

bab_mkdir()

function bab_mkdir($path, $mode=)


API templates/OVML

bab_printTemplate()

function bab_printTemplate( &$class, $file, $section="")

bab_printOvmlTemplate()

function bab_printOvmlTemplate($file, $args=array())

bab_abbr()

function bab_abbr($text, $type, $max_length)


API fichiers

bab_getFileMimeType()

function bab_getFileMimeType($file)

bab_getFileContentDisposition()

function bab_getFileContentDisposition()


API Annuaires

bab_getUserDirFields()

function bab_getUserDirFields($id = false)

bab_getDirEntry()

function bab_getDirEntry($id = false, $type = BAB_DIR_ENTRY_ID_USER, $id_directory = NULL )

bab_getUserDirectories()

function bab_getUserDirectories()

bab_getUserDirEntryLink()

function bab_getUserDirEntryLink($id = false, $type = BAB_DIR_ENTRY_ID_USER, $id_directory = false)


API Groupes

bab_getGroupName()

function bab_getGroupName($id, $fpn=true)

bab_getGroups()

function bab_getGroups($parent=BAB_REGISTERED_GROUP, $all=true)

bab_createGroup()

function bab_createGroup( $name, $description, $managerid, $parent = 1)

bab_updateGroup()

function bab_updateGroup( $id, $name, $description, $managerid)

bab_removeGroup()

function bab_removeGroup($id)


API Debug

bab_debug()

function bab_debug($data, $severity = DBG_TRACE)

bab_getDebug()

function bab_getDebug()

bab_toHtml()

function bab_toHtml($str, $option = BAB_HTML_ENTITIES)


API Moteur d'indexation

bab_searchEngineInfos()

function bab_searchEngineInfos()

API Registry

bab_getRegistryInstance()

function bab_getRegistryInstance()

Documentation Base de registre

API GET/POST

bab_rp()

function bab_rp($name, $default = "")

bab_pp()

function bab_pp($name, $default = "")

bab_gp()

function bab_gp($name, $default = "")

API Divers

bab_locale()

function bab_locale()

bab_isMagicQuotesGpcOn()

function bab_isMagicQuotesGpcOn()

bab_getActiveSessions()

function bab_getActiveSessions()
Récupérée de « https://wiki.ovidentia.fr/index.php?title=API_noyau/module&oldid=3172 »