Documentation du code de SPIP et de ses plugins

SPIP

trouver_table.php

Table of Contents

Functions

base_trouver_table_dist()  : array<string|int, mixed>|null
Retourne la description d'une table SQL

Functions

base_trouver_table_dist()

Retourne la description d'une table SQL

base_trouver_table_dist(string $nom[, string $serveur = '' ][, bool $table_spip = true ][, array<string|int, mixed> $options = [] ]) : array<string|int, mixed>|null

Cela sert notamment au moment de la compilation des boucles, critères et balise.

Les champs et clés de la tables sont retrouvés prioritairement via le gestionnaire de base de données. Les descriptions sont complétées, pour les tables éditoriales, des informations déclarées ou construites par la déclaration des objets éditoriaux.

Parameters
$nom : string

Nom de la table Vide '' demande de vider le cache des discriptions

$serveur : string = ''

Nom du connecteur

$table_spip : bool = true

Indique s'il faut transformer le préfixe de table

$options : array<string|int, mixed> = []
  • bool log_missing: true: (par défaut) pour écrire un log en cas de table absente. false: log uniquement en niveau debug.
Tags
example

$trouver_table = charger_fonction('trouver_table', 'base'); $desc = $trouver_table('spip_groupes_mots');

Cette fonction intervient à la compilation, mais aussi pour la balise contextuelle EXPOSE ou certains critères.

L'ensemble des descriptions de table d'un serveur est stocké dans un fichier cache/sql_desc.txt par soucis de performance. Un appel avec $nom vide est une demande explicite de vidange de ce cache

see
lister_tables_objets_sql()
Return values
array<string|int, mixed>|null

null si pas de connexion sql ou table introuvable tableau de description de la table sinon, en particulier :

  • field : tableau des colonnes SQL et leur description (comme dans serial.php ou objets.php)
  • key : tableau des KEY (comme dans serial.php ou objets.php)
  • table et table_sql : nom de la table (avec spip_ en préfixe)
  • id_table : nom SPIP de la table (type de boucle) le compilateur produit FROM $r['table'] AS $r['id_table']
  • Toutes les autres informations des objets éditoriaux si la table est l'un d'eux.

        
On this page

Search results