Documentation de l'objet bab database : Différence entre versions

De OviWiki
Aller à : navigation, rechercher
(Nouvelle page : == Introduction == Dans Ovidentia, l'objet bab_datable est instancié qu'une seule fois, existe donc un variable global $babDB disponible en permanence qui contiens cet objet. Dans ...)
 
 
(5 révisions intermédiaires par le même utilisateur non affichées)
Ligne 1 : Ligne 1 :
 +
[[Catégorie:Développement de modules]]
 +
 
== Introduction ==
 
== Introduction ==
  
Ligne 7 : Ligne 9 :
  
 
=== $babDB->db_query(string) ===
 
=== $babDB->db_query(string) ===
 +
 +
Exécuter une requète SQL
  
 
paramètre : la requête SQL à executer
 
paramètre : la requête SQL à executer
  
 
valeur retournée : la ressource MySQL
 
valeur retournée : la ressource MySQL
 +
 +
 +
=== $babDB->db_queryWem(string) ===
 +
 +
Exécuter une requète SQL sans gestionnaire d'erreur, le script continue son exécution même en cas d'erreur
 +
 +
paramètre : la requête SQL à executer
 +
 +
valeur retournée : la ressource MySQL
 +
 +
=== $babDB->db_error() ===
 +
 +
valeur retournée : FALSE si il n'y a pas eu d'erreur dans le dernière requête ou un message d'erreur en chaîne de caractères si il y a eu une erreur lors de la dernière requête.
  
  
 
=== $babDB->db_fetch_assoc(ressource) ===
 
=== $babDB->db_fetch_assoc(ressource) ===
  
cette fonction permet d'obtenir la ligne suivante du résultat d'un requète
+
cette fonction permet d'obtenir la ligne suivante du résultat d'une requête
  
 
paramètre : ressource MySQL obtenue à partir d'une requête SQL
 
paramètre : ressource MySQL obtenue à partir d'une requête SQL
  
 
valeur retournée : un tableau associatif, les clés du tableau sont les noms des colonnes.
 
valeur retournée : un tableau associatif, les clés du tableau sont les noms des colonnes.
 +
 +
 +
 +
=== $babDB->db_insert_id() ===
 +
 +
cette fonction permet d'obtenir la valeur de la colonne auto-incrémentée de la dernière requête INSERT
 +
 +
 +
 +
 +
=== $babDB->db_fetch_array(ressource) ===
 +
 +
cette fonction permet d'obtenir la ligne suivante du résultat d'une requête
 +
 +
paramètre : ressource MySQL obtenue à partir d'une requête SQL
 +
 +
valeur retournée : un tableau associatif, les clés du tableau sont les noms des colonnes et des clés numériques.
 +
 +
 +
 +
=== $babDB->db_num_rows(ressource) ===
 +
 +
cette fonction permet d'obtenir le nombre de lignes de résultats d'une requête SELECT
 +
 +
paramètre : ressource MySQL obtenue à partir d'une requête SQL
 +
 +
valeur retournée : nombre entier
 +
 +
 +
 +
=== $babDB->db_affected_rows([ressource]) ===
 +
 +
Retourne le nombre de lignes affectées lors de la dernière requête INSERT, UPDATE, REPLACE ou DELETE
 +
 +
paramètre : ressource MySQL obtenue à partir d'une requête SQL, si le paramètre n'est pas indiqué, c'est la dernière requête qui sera prise en compte
 +
 +
valeur retournée : nombre entier
 +
 +
 +
 +
 +
=== $babDB->db_data_seek(ressource, int) ===
 +
 +
Déplace le pointeur interne de résultat MySQL
 +
 +
paramètre 1 : ressource MySQL obtenue à partir d'une requête SQL
 +
 +
paramètre 2 : Position souhaité dans la liste des résultats
 +
 +
valeur retournée : Cette fonction retourne TRUE en cas de succès, FALSE en cas d'échec.
 +
 +
== Protéger les valeurs dans les requêtes ==
 +
 +
=== $babDB->db_escape_string(string) ===
 +
 +
Encoder une chaîne de caractères avant de l'utiliser dans une requête.
 +
 +
=== $babDB->db_escape_like(string) ===
 +
 +
Encoder une chaîne de caractères avant de l'utiliser dans une requête comme paramètre de LIKE, les caractères spéciaux de LIKE sont encodés en plus.
 +
 +
=== $babDB->quote(string|array) ===
 +
 +
dans le cas d'une chaîne, encoder et mettre des guillemets simples.
 +
 +
dans le cas d'un tableau, encoder toutes les valeurs du tableau et mettre des guillemets simples, la valeur de sortie sera une chaîne réalisée avec les valeurs du tableau séparées par des virgules.
 +
 +
=== $babDB->backTick(string) ===
 +
 +
Protéger un nom de colonne ou de table avec des accents.

Version actuelle en date du 11 janvier 2008 à 18:22


Introduction

Dans Ovidentia, l'objet bab_datable est instancié qu'une seule fois, existe donc un variable global $babDB disponible en permanence qui contiens cet objet. Dans une fonction, il faut faire global $babDB pour rendre disponible la variable dans le contexte du module.


Méthodes

$babDB->db_query(string)

Exécuter une requète SQL

paramètre : la requête SQL à executer

valeur retournée : la ressource MySQL


$babDB->db_queryWem(string)

Exécuter une requète SQL sans gestionnaire d'erreur, le script continue son exécution même en cas d'erreur

paramètre : la requête SQL à executer

valeur retournée : la ressource MySQL

$babDB->db_error()

valeur retournée : FALSE si il n'y a pas eu d'erreur dans le dernière requête ou un message d'erreur en chaîne de caractères si il y a eu une erreur lors de la dernière requête.


$babDB->db_fetch_assoc(ressource)

cette fonction permet d'obtenir la ligne suivante du résultat d'une requête

paramètre : ressource MySQL obtenue à partir d'une requête SQL

valeur retournée : un tableau associatif, les clés du tableau sont les noms des colonnes.


$babDB->db_insert_id()

cette fonction permet d'obtenir la valeur de la colonne auto-incrémentée de la dernière requête INSERT



$babDB->db_fetch_array(ressource)

cette fonction permet d'obtenir la ligne suivante du résultat d'une requête

paramètre : ressource MySQL obtenue à partir d'une requête SQL

valeur retournée : un tableau associatif, les clés du tableau sont les noms des colonnes et des clés numériques.


$babDB->db_num_rows(ressource)

cette fonction permet d'obtenir le nombre de lignes de résultats d'une requête SELECT

paramètre : ressource MySQL obtenue à partir d'une requête SQL

valeur retournée : nombre entier


$babDB->db_affected_rows([ressource])

Retourne le nombre de lignes affectées lors de la dernière requête INSERT, UPDATE, REPLACE ou DELETE

paramètre : ressource MySQL obtenue à partir d'une requête SQL, si le paramètre n'est pas indiqué, c'est la dernière requête qui sera prise en compte

valeur retournée : nombre entier



$babDB->db_data_seek(ressource, int)

Déplace le pointeur interne de résultat MySQL

paramètre 1 : ressource MySQL obtenue à partir d'une requête SQL

paramètre 2 : Position souhaité dans la liste des résultats

valeur retournée : Cette fonction retourne TRUE en cas de succès, FALSE en cas d'échec.

Protéger les valeurs dans les requêtes

$babDB->db_escape_string(string)

Encoder une chaîne de caractères avant de l'utiliser dans une requête.

$babDB->db_escape_like(string)

Encoder une chaîne de caractères avant de l'utiliser dans une requête comme paramètre de LIKE, les caractères spéciaux de LIKE sont encodés en plus.

$babDB->quote(string|array)

dans le cas d'une chaîne, encoder et mettre des guillemets simples.

dans le cas d'un tableau, encoder toutes les valeurs du tableau et mettre des guillemets simples, la valeur de sortie sera une chaîne réalisée avec les valeurs du tableau séparées par des virgules.

$babDB->backTick(string)

Protéger un nom de colonne ou de table avec des accents.