
Documentation
Note : Non mise à jour depuis le TP7 (ou TP6). La gestion des erreurs et des retours de résultat a changé depuis. Les définitions des fonctions restent cependant pour la plupart encore valables.
Il est recommandé de visualiser le site sur cette adresse pour éviter tout problème avec la base de donnée: https://iut-dev.sl-projects.com/
Objet
Les fonctions publiques statiques retournent des arrays se basant sur ce format :
[
"status" => "fail|success",
"message" => "message d'erreur"
]
addObject
Permet d'insérer un objet dans la base de données
- @param String $tableName
- @param array $columns
- @return array|string[]
Le paramètre $columns
doit être un array indexé comme ceci :
[
"index" => "valeur",
"index2" => "valeur2"
]
Retourne en plus pdoError
de l'index message
en cas d'erreur.
[
"status" => "fail",
"message" => "L'insertion de l'objet a échoué.",
"pdoError" => $e
]
describeObject
Permet de décrire une table représentant un objet. Exécute SHOW FULL COLUMNS FROM $tableName
sur le serveur.
- @param $tableName
- @return array
Retourne columns
.
[
"status" => "success",
"columns" => [
// Colonnes du retour de la commande sql
]
]
modifyObject
Permet la modification d'un objet dans la base de données
- @param String $tableName
- @param array $id
- @param array $columns
- @return array|string[]
Le paramètre $id
doit respecter ce format :
[
"name" => "nom_de_la_colonne",
"value" => "Valeur de la clé primaire"
]
Le paramètre $columns
doit être un array indexé comme ceci :
[
"index" => "valeur",
"index2" => "valeur2"
]
getObject
Permet la récupération d'un objet depuis la base de données
- @param string $tableName
- @param array $id
- @return array|string[]
Le paramètre $id
doit respecter ce format :
[
"name" => "nom_de_la_colonne",
"value" => "Valeur de la clé primaire"
]
Retourne data
avec les colonnes de l'objet demandé.
[
"status" => "success",
"message" => "Récupération réussie.",
"data" => [
// Colonnes
]
]
verifyTableAndFormat
Permet de vérifier le format du nom de la table et des nom des colonnes + vérifier l'existance de la table.
- @param String $tableName
- @param array|null $columns
- @return array|string[]
Le paramètre $columns
est optionnel. Renverra en plus pdoError
de l'index message
en cas d'erreur si $columns
a été utilisé.
[
"status" => "fail",
"message" => "Le format du nom de la table est incorrect."
]
[
"status" => "fail",
"message" => "La table $tableName ne semble pas exister.",
"pdoError" => $e
]
[
"status" => "success",
"message" => "Validation réussie."
]
Routes
Les pages sont générées à partir du paramètre url action=nomDeLaPage
.
"lireAuteur" => ControleurAuteur::lireAuteur(),
"lireAuteurs" => ControleurAuteur::lireAuteurs(),
"creerObjet" => ControleurObjet::createObject(),
"lireAdherent" => ControleurAdherent::lireAdherent(),
"lireAdherents" => ControleurAdherent::lireAdherents(),
"lireLivre" => ControleurLivre::lireLivre(),
"lireLivres" => ControleurLivre::lireLivres(),
"describeTable" => ControleurObjet::describeTable(),
default => ControleurAuteur::lireAuteur(),
describeTable
describeTable retourne le résultat de ControleurObjet::describeTable()
au format JSON.