Proposer une amélioration de commentaire

Le commentaire à poster est au format «docblock» (de phpDoc) qui peut être enrichi de tags spécifiques pour SPIP.
Fichier
ecrire/base/objets.php
Fonction
lister_tables_objets_sql

    Nom ou pseudo de l'auteur de la proposition

Code original

/**
 * Lister les infos de toutes les tables sql declarées
 *
 * Si un argument est fourni, on ne renvoie que les infos de cette table.
 * Elle est auto-declarée si inconnue jusqu'alors.
 *
 * @api
 * @param string $table_sql
 *   table_sql demandee explicitement
 * @param array $desc
 *   description connue de la table sql demandee
 * @return array|bool
 */
function lister_tables_objets_sql($table_sql = null, $desc = array()) {
	static $deja_la = false;
	static $infos_tables = null;
	static $md5 = null;
	static $plugin_hash = null;
 
	// plugins hash connu ? non si _CACHE_PLUGINS_OPT est pas encore chargé.
	$_PLUGINS_HASH = defined('_PLUGINS_HASH') ? _PLUGINS_HASH : '!_CACHE_PLUGINS_OPT';
 
	// prealablement recuperer les tables_principales
	if (is_null($infos_tables) or $plugin_hash !== $_PLUGINS_HASH) {
		// pas de reentrance (cas base/serial)
		if ($deja_la) {
			spip_log('Re-entrance anormale sur lister_tables_objets_sql : '
				. var_export(debug_backtrace(), true), _LOG_CRITIQUE);
 
			return ($table_sql === '::md5' ? $md5 : array());
		}
		$deja_la = true;
		$plugin_hash = $_PLUGINS_HASH; // avant de lancer les pipelines
 
		// recuperer les declarations explicites ancienne mode
		// qui servent a completer declarer_tables_objets_sql
		base_serial($GLOBALS['tables_principales']);
		base_auxiliaires($GLOBALS['tables_auxiliaires']);
		$infos_tables = array(
			'spip_articles' => array(
				'page' => 'article',
				'texte_retour' => 'icone_retour_article',
				'texte_modifier' => 'icone_modifier_article',
				'texte_creer' => 'icone_ecrire_article',
				'texte_objets' => 'public:articles',
				'texte_objet' => 'public:article',
				'texte_signale_edition' => 'texte_travail_article',
				'info_aucun_objet' => 'info_aucun_article',
				'info_1_objet' => 'info_1_article',
				'info_nb_objets' => 'info_nb_articles',
				'texte_logo_objet' => 'logo_article',
				'texte_langue_objet' => 'titre_langue_article',
				'texte_definir_comme_traduction_objet' => 'trad_lier',
				'titre' => 'titre, lang',
				'date' => 'date',
				'principale' => 'oui',
				'introduction_longueur' => '500',
				'champs_editables' => array(
					'surtitre',
					'titre',
					'soustitre',
					'descriptif',
					'nom_site',
					'url_site',
					'chapo',
					'texte',
					'ps',
					'virtuel'
				),
				'champs_versionnes' => array(
					'id_rubrique',
					'surtitre',
					'titre',
					'soustitre',
					'jointure_auteurs',
					'descriptif',
					'nom_site',
					'url_site',
					'chapo',
					'texte',
					'ps'
				),
				'field' => array(
					'id_article' => 'bigint(21) NOT NULL',
					'surtitre' => "text DEFAULT '' NOT NULL",
					'titre' => "text DEFAULT '' NOT NULL",
					'soustitre' => "text DEFAULT '' NOT NULL",
					'id_rubrique' => "bigint(21) DEFAULT '0' NOT NULL",
					'descriptif' => "text DEFAULT '' NOT NULL",
					'chapo' => "mediumtext DEFAULT '' NOT NULL",
					'texte' => "longtext DEFAULT '' NOT NULL",
					'ps' => "mediumtext DEFAULT '' NOT NULL",
					'date' => "datetime DEFAULT '0000-00-00 00:00:00' NOT NULL",
					'statut' => "varchar(10) DEFAULT '0' NOT NULL",
					'id_secteur' => "bigint(21) DEFAULT '0' NOT NULL",
					'maj' => 'TIMESTAMP',
					'export' => "VARCHAR(10) DEFAULT 'oui'",
					'date_redac' => "datetime DEFAULT '0000-00-00 00:00:00' NOT NULL",
					'visites' => "integer DEFAULT '0' NOT NULL",
					'referers' => "integer DEFAULT '0' NOT NULL",
					'popularite' => "DOUBLE DEFAULT '0' NOT NULL",
					'accepter_forum' => "CHAR(3) DEFAULT '' NOT NULL",
					'date_modif' => "datetime DEFAULT '0000-00-00 00:00:00' NOT NULL",
					'lang' => "VARCHAR(10) DEFAULT '' NOT NULL",
					'langue_choisie' => "VARCHAR(3) DEFAULT 'non'",
					'id_trad' => "bigint(21) DEFAULT '0' NOT NULL",
					'nom_site' => "tinytext DEFAULT '' NOT NULL",
					'url_site' => "text DEFAULT '' NOT NULL",
					'virtuel' => "text DEFAULT '' NOT NULL",
				),
				'key' => array(
					'PRIMARY KEY' => 'id_article',
					'KEY id_rubrique' => 'id_rubrique',
					'KEY id_secteur' => 'id_secteur',
					'KEY id_trad' => 'id_trad',
					'KEY lang' => 'lang',
					'KEY statut' => 'statut, date',
				),
				'join' => array(
					'id_article' => 'id_article',
					'id_rubrique' => 'id_rubrique'
				),
				'rechercher_champs' => array(
					'surtitre' => 5,
					'titre' => 8,
					'soustitre' => 5,
					'chapo' => 3,
					'texte' => 1,
					'ps' => 1,
					'nom_site' => 1,
					'url_site' => 1,
					'descriptif' => 4
				),
				'rechercher_jointures' => array(
					'auteur' => array('nom' => 10),
				),
				'statut' => array(
					array(
						'champ' => 'statut',
						'publie' => 'publie',
						'previsu' => 'publie,prop,prepa/auteur',
						'post_date' => 'date',
						'exception' => array('statut', 'tout')
					)
				),
				'statut_titres' => array(
					'prepa' => 'info_article_redaction',
					'prop' => 'info_article_propose',
					'publie' => 'info_article_publie',
					'refuse' => 'info_article_refuse',
					'poubelle' => 'info_article_supprime'
				),
				'statut_textes_instituer' => array(
					'prepa' => 'texte_statut_en_cours_redaction',
					'prop' => 'texte_statut_propose_evaluation',
					'publie' => 'texte_statut_publie',
					'refuse' => 'texte_statut_refuse',
					'poubelle' => 'texte_statut_poubelle',
				),
				'texte_changer_statut' => 'texte_article_statut',
				'aide_changer_statut' => 'artstatut',
				'tables_jointures' => array(
					'profondeur' => 'rubriques',
					#'id_auteur' => 'auteurs_liens' // declaration generique plus bas
				),
			),
			'spip_auteurs' => array(
				'page' => 'auteur',
				'texte_retour' => 'icone_retour',
				'texte_ajouter' => 'titre_ajouter_un_auteur',
				'texte_modifier' => 'admin_modifier_auteur',
				'texte_objets' => 'icone_auteurs',
				'texte_objet' => 'public:auteur',
				'info_aucun_objet' => 'info_aucun_auteur',
				'info_1_objet' => 'info_1_auteur',
				'info_nb_objets' => 'info_nb_auteurs',
				'texte_logo_objet' => 'logo_auteur',
				'texte_creer_associer' => 'creer_et_associer_un_auteur',
				'titre' => "nom AS titre, '' AS lang",
				'date' => 'date',
				'principale' => 'oui',
				'champs_editables' => array('nom', 'email', 'bio', 'nom_site', 'url_site', 'imessage', 'pgp'),
				'champs_versionnes' => array('nom', 'bio', 'email', 'nom_site', 'url_site', 'login'),
				'field' => array(
					'id_auteur' => 'bigint(21) NOT NULL',
					'nom' => "text DEFAULT '' NOT NULL",
					'bio' => "text DEFAULT '' NOT NULL",
					'email' => "tinytext DEFAULT '' NOT NULL",
					'nom_site' => "tinytext DEFAULT '' NOT NULL",
					'url_site' => "text DEFAULT '' NOT NULL",
					'login' => 'VARCHAR(255) BINARY',
					'pass' => "tinytext DEFAULT '' NOT NULL",
					'low_sec' => "tinytext DEFAULT '' NOT NULL",
					'statut' => "varchar(255)  DEFAULT '0' NOT NULL",
					'webmestre' => "varchar(3)  DEFAULT 'non' NOT NULL",
					'maj' => 'TIMESTAMP',
					'pgp' => "TEXT DEFAULT '' NOT NULL",
					'htpass' => "tinytext DEFAULT '' NOT NULL",
					'en_ligne' => "datetime DEFAULT '0000-00-00 00:00:00' NOT NULL",
					'alea_actuel' => 'tinytext',
					'alea_futur' => 'tinytext',
					'prefs' => 'text',
					'cookie_oubli' => 'tinytext',
					'source' => "VARCHAR(10) DEFAULT 'spip' NOT NULL",
					'lang' => "VARCHAR(10) DEFAULT '' NOT NULL"
				),
				'key' => array(
					'PRIMARY KEY' => 'id_auteur',
					'KEY login' => 'login',
					'KEY statut' => 'statut',
					'KEY en_ligne' => 'en_ligne',
				),
				'join' => array(
					'id_auteur' => 'id_auteur',
					'login' => 'login'
				),
				'rechercher_champs' => array(
					'nom' => 5,
					'bio' => 1,
					'email' => 1,
					'nom_site' => 1,
					'url_site' => 1,
					'login' => 1
				),
				// 2 conditions pour les auteurs : statut!=poubelle,
				// et avoir des articles publies
				'statut' => array(
					array(
						'champ' => 'statut',
						'publie' => '!5poubelle',
						'previsu' => '!5poubelle',
						'exception' => 'statut'
					),
					array(
						'champ' => array(
							array('spip_auteurs_liens', 'id_auteur'),
							array(
								'spip_articles',
								array('id_objet', 'id_article', 'objet', 'article')
							),
							'statut'
						),
						'publie' => 'publie',
						'previsu' => '!',
						'post_date' => 'date',
						'exception' => array('statut', 'lien', 'tout')
					),
				),
				'statut_images' => array(
					'auteur-6forum-16.png',
					'0minirezo' => 'auteur-0minirezo-16.png',
					'1comite' => 'auteur-1comite-16.png',
					'6forum' => 'auteur-6forum-16.png',
					'5poubelle' => 'auteur-5poubelle-16.png',
					'nouveau' => ''
				),
				'statut_titres' => array(
					'titre_image_visiteur',
					'0minirezo' => 'titre_image_administrateur',
					'1comite' => 'titre_image_redacteur_02',
					'6forum' => 'titre_image_visiteur',
					'5poubelle' => 'titre_image_auteur_supprime',
				),
				'tables_jointures' => array(#'auteurs_liens' // declaration generique plus bas
				),
			),
			'spip_rubriques' => array(
				'page' => 'rubrique',
				'url_voir' => 'rubrique',
				'url_edit' => 'rubrique_edit',
				'texte_retour' => 'icone_retour',
				'texte_objets' => 'public:rubriques',
				'texte_objet' => 'public:rubrique',
				'texte_modifier' => 'icone_modifier_rubrique',
				'texte_creer' => 'icone_creer_rubrique',
				'texte_ajouter' => 'titre_ajouter_une_rubrique',
				'texte_creer_associer' => 'creer_et_associer_une_rubrique',
				'info_aucun_objet' => 'info_aucun_rubrique',
				'info_1_objet' => 'info_1_rubrique',
				'info_nb_objets' => 'info_nb_rubriques',
				'texte_logo_objet' => 'logo_rubrique',
				'texte_langue_objet' => 'titre_langue_rubrique',
				'texte_definir_comme_traduction_objet' => 'texte_definir_comme_traduction_rubrique',
				'titre' => 'titre, lang',
				'date' => 'date',
				'principale' => 'oui',
				'introduction_longueur' => '600',
				'champs_editables' => array('titre', 'texte', 'descriptif', 'extra'),
				'champs_versionnes' => array('titre', 'descriptif', 'texte'),
				'field' => array(
					'id_rubrique' => 'bigint(21) NOT NULL',
					'id_parent' => "bigint(21) DEFAULT '0' NOT NULL",
					'titre' => "text DEFAULT '' NOT NULL",
					'descriptif' => "text DEFAULT '' NOT NULL",
					'texte' => "longtext DEFAULT '' NOT NULL",
					'id_secteur' => "bigint(21) DEFAULT '0' NOT NULL",
					'maj' => 'TIMESTAMP',
					'statut' => "varchar(10) DEFAULT '0' NOT NULL",
					'date' => "datetime DEFAULT '0000-00-00 00:00:00' NOT NULL",
					'lang' => "VARCHAR(10) DEFAULT '' NOT NULL",
					'langue_choisie' => "VARCHAR(3) DEFAULT 'non'",
					'statut_tmp' => "varchar(10) DEFAULT '0' NOT NULL",
					'date_tmp' => "datetime DEFAULT '0000-00-00 00:00:00' NOT NULL",
					'profondeur' => "smallint(5) DEFAULT '0' NOT NULL"
				),
				'key' => array(
					'PRIMARY KEY' => 'id_rubrique',
					'KEY lang' => 'lang',
					'KEY id_parent' => 'id_parent',
				),
				'rechercher_champs' => array(
					'titre' => 8,
					'descriptif' => 5,
					'texte' => 1
				),
				'statut' => array(
					array(
						'champ' => 'statut',
						'publie' => 'publie',
						'previsu' => '!',
						'exception' => array('statut', 'tout')
					),
				),
				'tables_jointures' => array(#'id_auteur' => 'auteurs_liens' // declaration generique plus bas
				),
			),
			// toutes les tables ont le droit a une jointure sur les auteurs
			array('tables_jointures' => array('id_auteur' => 'auteurs_liens'))
		);
 
		// avant d'appeller les pipeline qui peuvent generer une reentrance a l'install
		// initialiser la signature
		$md5 = md5(serialize($infos_tables));
 
		$GLOBALS['tables_principales'] = pipeline('declarer_tables_principales', $GLOBALS['tables_principales']);
		$GLOBALS['tables_auxiliaires'] = pipeline('declarer_tables_auxiliaires', $GLOBALS['tables_auxiliaires']);
		$infos_tables = pipeline('declarer_tables_objets_sql', $infos_tables);
 
		// completer les informations manquantes ou implicites
		$all = array();
		foreach (array_keys($infos_tables) as $t) {
			// les cles numeriques servent a declarer
			// les proprietes applicables a tous les objets
			// on les mets de cote
			if (is_numeric($t)) {
				$all = array_merge_recursive($all, $infos_tables[$t]);
				unset($infos_tables[$t]);
			} else {
				$infos_tables[$t] = renseigner_table_objet_sql($t, $infos_tables[$t]);
			}
		}
 
		// repercuter les proprietes generales communes a tous les objets
		foreach (array_keys($infos_tables) as $t) {
			foreach ($all as $i => $v) {
				if (in_array($i, array('tables_jointures', 'champs_versionnes'))) {
					$add = $all[$i];
					// eviter les doublons de declaration de table jointure (ex des mots sur auteurs)
					// pour les declarations generiques avec cles numeriques
					if ($i == 'tables_jointures' and isset($infos_tables[$t][$i]) and count($infos_tables[$t][$i])) {
						$doublons = array_intersect($infos_tables[$t][$i], $add);
						foreach ($doublons as $d) {
							if (is_numeric(array_search($d, $infos_tables[$t][$i]))
								and is_numeric($k = array_search($d, $add))
							) {
								unset($add[$k]);
							}
						}
					}
					$infos_tables[$t][$i] = array_merge(isset($infos_tables[$t][$i]) ? $infos_tables[$t][$i] : array(), $add);
				} else {
					$infos_tables[$t][$i] = array_merge_recursive(
						isset($infos_tables[$t][$i]) ? $infos_tables[$t][$i] : array(),
						$all[$i]
					);
				}
			}
		}
 
		// completer les tables principales et auxiliaires
		// avec celles declarees uniquement dans declarer_table_objets_sql
		// pour assurer la compat en transition
		foreach ($infos_tables as $table => $infos) {
			$principale_ou_auxiliaire = ($infos['principale'] ? 'tables_principales' : 'tables_auxiliaires');
			// memoriser des champs eventuels declares par des plugins dans le pipeline tables_xxx
			// qui a ete appelle avant
			$mem = (isset($GLOBALS[$principale_ou_auxiliaire][$table]) ? $GLOBALS[$principale_ou_auxiliaire][$table] : array());
			// l'ajouter au tableau
			$GLOBALS[$principale_ou_auxiliaire][$table] = array();
			if (isset($infos['field']) and isset($infos['key'])) {
				foreach (array('field', 'key', 'join') as $k) {
					if (isset($infos_tables[$table][$k])) {
						$GLOBALS[$principale_ou_auxiliaire][$table][$k] = &$infos_tables[$table][$k];
					}
				}
			} else {
				// ici on ne renvoie que les declarations, donc RIEN
				// pour avoir la vrai description en base, il faut passer par trouver_table
				$GLOBALS[$principale_ou_auxiliaire][$table] = array();
			}
			if (count($mem)) {
				foreach (array_keys($mem) as $k) {
					if (isset($GLOBALS[$principale_ou_auxiliaire][$table][$k])) {
						$GLOBALS[$principale_ou_auxiliaire][$table][$k] = array_merge(
							$GLOBALS[$principale_ou_auxiliaire][$table][$k],
							$mem[$k]
						);
					} else {
						$GLOBALS[$principale_ou_auxiliaire][$table][$k] = $mem[$k];
					}
				}
			}
		}
 
		// recuperer les interfaces (table_titre, table_date)
		// on ne le fait que dans un second temps pour que table_objet soit fonctionnel
		// dans le pipeline de declarer_tables_interfaces
		include_spip('public/interfaces');
		foreach (array_keys($infos_tables) as $t) {
			$infos_tables[$t] = renseigner_table_objet_interfaces($t, $infos_tables[$t]);
		}
 
		$deja_la = false;
		// signature
		$md5 = md5(serialize($infos_tables));
	}
	if ($table_sql === '::md5') {
		return $md5;
	}
	if ($table_sql and !isset($infos_tables[$table_sql])) {
		#$desc = renseigner_table_objet_sql($table_sql,$desc);
		$desc = renseigner_table_objet_interfaces($table_sql, $desc);
 
		return $desc;
	}
	if ($table_sql) {
		return isset($infos_tables[$table_sql]) ? $infos_tables[$table_sql] : array();
	}
 
	return $infos_tables;
}

Le commentaire au format « docblock » peut être complété des éléments suivants sécifiques
à SPIP.

Sur un entête de fichier :

  • @package SPIP\Core\x (pour un fichier du core, x dépendant du fichier)
  • @package SPIP\Nom\x (pour un fichier de plugin, Nom étant le nom du plugin)

Sur un entête de fonction :

  • @pipeline x : indique que la fonction est une utilisation d’un pipeline
  • @pipeline_appel x : indique que la fonction appelle le pipeline indiqué
  • @balise : indique que la fonction est une compilation de balise
  • @filtre : indique un |filtre
  • @critere : indique que la fonction est une compilaiton de critère
  • @boucle : indique que la fonction est une compilaiton de boucle
Vous inscrire sur ce site

L’espace privé de ce site est ouvert aux visiteurs, après inscription. Une fois enregistré, vous pourrez consulter les articles en cours de rédaction, proposer des articles et participer à tous les forums.

Identifiants personnels

Indiquez ici votre nom et votre adresse email. Votre identifiant personnel vous parviendra rapidement, par courrier électronique.