phpDocumentor

MySql
in package

Classe simplifiant l'utilisation de MySql

Table of Contents

Constants

ErrorOpen  = 'MySql::ErrorOpen'
ErrorQuery  = 'MySql::ErrorQuery'
ErrorServer  = 'MySql::ErrorServer'
ErrorTableDoesntExist  = 'MySql::ErrorTableDoesntExist'

Properties

$mysqli  : mysqli|null
$server  : string|null

Methods

createTableSql()  : string
génère le code SQL de création d'une table à partir d'une constante de définition du schéma.
getTuples()  : array<int, array<string, string>>
renvoie le résultat d'une requête sous la forme d'une liste de tuples
open()  : void
ouvre une connexion MySQL
query()  : bool|MySqlResult
exécute une requête MySQL, soulève une exception en cas d'erreur, retourne le résultat soit TRUE soit un objet MySqlResult
server()  : string
retourne le nom du serveur

Constants

ErrorOpen

public mixed ErrorOpen = 'MySql::ErrorOpen'

ErrorQuery

public mixed ErrorQuery = 'MySql::ErrorQuery'

ErrorServer

public mixed ErrorServer = 'MySql::ErrorServer'

ErrorTableDoesntExist

public mixed ErrorTableDoesntExist = 'MySql::ErrorTableDoesntExist'

Properties

$mysqli

public static mysqli|null $mysqli = \null

$server

public static string|null $server = \null

Methods

createTableSql()

génère le code SQL de création d'une table à partir d'une constante de définition du schéma.

public static createTableSql(string $tableName, array{description: string, comment: string, columns: array} $schema) : string

Cette constante est un dictionnaire ayant la structure suivante:

  • le champ 'description' décrit la structure du dictionnaire,
  • le champ 'comment' précise la table concernée,
  • le champ obligatoire 'columns' définit le dictionnaire des colonnes avec pour chaque entrée:
    • la clé définit le nom SQL de la colonne,\n"
    • le champ 'type' obligatoire définit le type SQL de la colonne,
    • le champ 'keyOrNull' définit si la colonne est ou non une clé et si elle peut ou non être nulle
    • le champ 'comment' précise un commentaire sur la colonne.
    • pour les colonnes de type 'enum' correspondant à une énumération le champ 'enum' définit les valeurs possibles dans un dictionnaire où chaque entrée a:
      • pour clé la valeur de l'énumération et
      • pour valeur une définition et/ou un commentaire sur cette valeur.
Parameters
$tableName : string
$schema : array{description: string, comment: string, columns: array}
Return values
string

getTuples()

renvoie le résultat d'une requête sous la forme d'une liste de tuples

public static getTuples(string $sql) : array<int, array<string, string>>

Plus pratique que query() quand on sait que le nombre de n-uplets retournés est faible

Parameters
$sql : string
Return values
array<int, array<string, string>>

open()

ouvre une connexion MySQL

public static open(string $mysqlParams) : void

Sur localhost si la base utilisée n'existe pas alors elle est créée. Enregistre le handle en variable statique.

Parameters
$mysqlParams : string

query()

exécute une requête MySQL, soulève une exception en cas d'erreur, retourne le résultat soit TRUE soit un objet MySqlResult

public static query(string $sql) : bool|MySqlResult
Parameters
$sql : string
Return values
bool|MySqlResult

server()

retourne le nom du serveur

public static server() : string
Return values
string 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results