trouver_table

La fonction trouver_table() (base_trouver_table_dist) est déclarée dans ecrire/base/trouver_table.php et permet d’obtenir une description d’une table SQL. Elle permet de récupérer la liste des colonnes, des clés, des jointures déclarées, et d’autres informations.

En tant que fonction surchargeable, elle s’utilise avec charger_fonction :

  1. $trouver_table = charger_fonction('trouver_table', 'base');
  2. $desc = $trouver_table($table, $serveur);

Télécharger

Ses paramètres sont :

  1. $table : le nom de la table (’spip_articles’ ou ’articles’)
  2. $serveur : optionnel, le nom de la connexion SQL utilisée, qui est par défaut celle de l’installation de SPIP.

Le tableau $desc retourné est de cette forme :

  1. 'field' => array('colonne' => 'description'),
  2. 'key' => array(
  3. 'PRIMARY KEY' => 'colonne',
  4. 'KEY nom' => 'colonne' // ou 'colonne1, colonne2'
  5. ),
  6. 'join' => array('colonne' => 'colonne'),
  7. 'table' => 'spip_tables'
  8. 'id_table' => $table,
  9. 'connexion' => 'nom_connexion',
  10. 'titre' => 'colonne_titre AS titre, colonne_langue AS lang'
  11. );

Télécharger

  • La clé field est un tableau associatif listant toutes les colonnes de la table et donnant leur description SQL,
  • key est un autre tableau listant les clés primaires et secondaires,
  • join liste les colonnes de jointures possibles, si déclarés dans la description des tables principales ou auxiliaires
  • table est le véritable nom de la table (hors préfixe : si le préfixe des tables est différent de « spip », c’est « spip_tables » qui sera tout de même retourné),
  • id_table est le paramètre $table donné,
  • connexion est le nom du fichier de connexion, si différent de celui d’installation,
  • titre est une déclaration SQL de SELECT indiquant où est la colonne titre ou où est la colonne langue (sert entre autre pour calculer les URLs) ; exemples : « titre, lang », « nom AS titre, '' AS lang »

Cette fonction met en cache le résultat de l’analyse afin d’éviter des accès intempestifs au serveur SQL. Pour forcer un recalcul de ce cache, il faut appeler la fonction avec une chaine vide :

  1. $trouver_table = charger_fonction('trouver_table', 'base');
  2. $desc = $trouver_table('');

Télécharger

Note : Lorsqu’une table est demandée sans préfixe « spip_ », c’est le nom de la table avec le préfixe donné pour le site qui sera retourné (pour peu que la table soit déclarée à SPIP). Demander une table « spip_tables » cherchera l’existence véritable de cette table (le préfixe n’est pas remplacé par celui utilisé pour le site). Dans l’avenir, une option sera probablement ajoutée à la fonction trouver_table(), comme pour sql_showtable afin de pouvoir modifier automatiquement le préfixe.

Exemple

La fonction creer_champs_extras() du plugin « Champs Extras » permet de créer les colonnes SQL décrites par les instances d’objets « ChampExtra » transmises ($c->table est le nom de la table SQL, $c->champ celui de la colonne). La fonction renvoie false si une colonne n’a pas été créée :

  1. function creer_champs_extras($champs) {
  2. // la fonction met a jour les tables concernées avec maj_tables()
  3. // [...]
  4. // Elle teste ensuite si les nouveaux champs sont bien crees :
  5. // pour chaque champ a creer, on verifie qu'il existe bien maintenant !
  6. $trouver_table = charger_fonction('trouver_table','base');
  7. $trouver_table(''); // recreer la description des tables.
  8. $retour = true;
  9. foreach ($champs as $c){
  10. if ($table = table_objet_sql($c->table)) {
  11. $desc = $trouver_table($table);
  12. if (!isset($desc['field'][$c->champ])) {
  13. extras_log("Le champ extra '" . $c->champ . "' sur $table n'a pas ete cree :(", true);
  14. $retour = false;
  15. }
  16. } else {
  17. $retour = false;
  18. }
  19. }
  20. return $retour;
  21. }

Télécharger

Auteur Matthieu Marcillaud Publié le : Mis à jour : 12/05/17

Traductions : English, français