Bontiv-Sourceer source code viewer
Root | Help
./PhpMyCMS/docs/sql_driver.txt
/**
 * SQL Manager
 *
 * @version $Id$
 * @copyright 2009
 *
 * Ce fichier permet l'utilisation sécirisé de MySQL
 */

/** Documentation Technique
*
* ---------------
* Ouverture d'un objet, définition du serveur
*
* Pour ouvrir un objet $obj pour se connecter à un serveur $serv, on tape :
* $obj = DB_Driver::Open($serv);
* Si une connexion vers le serveur avait déjà été ouverte, alors $obj retournera
* l'objet qui avait déjà été initialisé. Si aucun serveur est spécifié, alors
* le serveur SQL défini dans le fichier de configuration sera utilisé.
*
* ----------------
* Définir les paramètres de connexion
* Object: DB_Driver()
* Method: SetConfig($User, $Pass, $Base, $Prefix)
*
* ---- Liste des arguments
* --$User : Utilisateur utilisé pour la connexion.
* --$Pass : Mot de passe à utiliser.
* --$Base : Non de la base de donnée à utiliser
* --$Prefix : Préfixe à utiliser pour les tables.
*
* ---- Valeur de retour
* Retourne false si la connexion a échoué, sinon retourne un identifiant de connexion.
*
* -----------------
* Définir la table de donnée courante
* Object: DB_Driver
* Value: table
*
* Contient le non de la table utilisé pour les oparations. Pour changr de table
* courante, changer cette valeur.
*
* -----------------
* Lire une base de données
* Object: DB_Driver
* Method: Select($condition = array(), $Colone = array('*'), $Sort)
*
* Permet de lire une table de données. La table lut est fixé par la valeur table
* de l'objet.
*
* ---- Liste des arguments
* --$condition (défaut: array()) : Tableau conteant les informations pour trier
* les éléments (pour définir le WHERE). Dans se tableau, les clé doivent être
* des noms de colone de la table et les valeurs représente à quel valeur doit
* etre la colone pour que le resultat soit affiché.
* Exemple: pour faire WHERE ma_colone = 'ma valeur' on doit envoyer le tableau
* array('ma_colone' => 'ma valeur').
*
* --$Colone (défaut: array('*')) : tableau représentant les colones que l'on
* veux récupérer dans la table. Par défaut on retourne toutes les colones de la
* table.
*
* --$Sort (defaut: NULL) : Nom de la colone que l'on veut utiliser pour l'ordre
* d'affichage DESC, ou alors on ajoute un - devant le nom pour avoir l'ordre
* ASC. Si ce paramètre vaut NULL, alors les enregistrements ne seront pas triés.
* Peut aussi être un tableau assiciatif (pour utiliser une limite).
* $Sort['order'] : voir $Sort en mode chaine de caractère.
* $Sort['nbr'] : Nombre d'enregistrement à prendre.
* $Sort['start'] : Numéro du premier enregistrement à prendre ($Sort['nbr']
* doit être défini.
*
* ---- Valeur de retour
* retourne le resultat de mysql_query() avec la requette construite.
*
*-----------------
* Effacer des données dans une table
* Object: DB_Driver
* Method: DeleteFrom($condition = array())
*
* Utilise la table courante pour l'effacement.
*
* ---- Liste des arguments
* --$condition : tableau des conditions que doit respecter un enregistrement
* pour être effacé. Pour en savoir plus, allez voir dans Select().
*
* -----------------
* Insert un enregistrement
* Object: DB_Driver
* Method: InsertInto($infos)
*
* Utilise la table courante pour l'insertion.
*
* ---- Liste des arguments
* --$infos : tableau représentant les valeurs à ajouter dans la table. Sous la
* forme: array( 'nom d'une colone' => 'valeur qui sera dedans'). Exemple :
* $sql->InsertInto(array(
* 'pseudo' => 'bontiv',
* 'pass' => 'EITR354RYSIEY4DSERREE',
* 'identifiant' => 'titou'
* ));
*
* ---- Valeur de retour
* Si la table pocède une clée auto_incrémenté, alors retourne la valeur de cette
* clé qui identifie le nouvel enregistrement. S'il n'y a pas de clé, alors
* retourne 0.
* **/
Presented with Bontiv-Sourceer