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
base_auxiliaires

    Nom ou pseudo de l'auteur de la proposition

Code original

/**
 * Déclare les tables auxiliaires du Core
 *
 * @param array $tables_auxiliaires
 *     Description des tables auxiliaires déjà déclarées
 * @return void
 **/
function base_auxiliaires(&$tables_auxiliaires) {
	$spip_resultats = array(
		'recherche' => "char(16) DEFAULT '' NOT NULL",
		'id' => 'INT UNSIGNED NOT NULL',
		'points' => "INT UNSIGNED DEFAULT '0' NOT NULL",
		'table_objet' => "varchar(30) DEFAULT '' NOT NULL",
		'serveur' => "char(16) DEFAULT '' NOT NULL", // hash md5 partiel du serveur de base ('' pour le serveur principal)
		'maj' => 'TIMESTAMP'
	);
 
	$spip_resultats_key = array(// pas de cle ni index, ca fait des insertions plus rapides et les requetes jointes utilisees en recheche ne sont pas plus lentes ...
	);
 
	$spip_auteurs_liens = array(
		'id_auteur' => "bigint(21) DEFAULT '0' NOT NULL",
		'id_objet' => "bigint(21) DEFAULT '0' NOT NULL",
		'objet' => "VARCHAR (25) DEFAULT '' NOT NULL",
		'vu' => "VARCHAR(6) DEFAULT 'non' NOT NULL"
	);
 
	$spip_auteurs_liens_key = array(
		'PRIMARY KEY' => 'id_auteur,id_objet,objet',
		'KEY id_auteur' => 'id_auteur',
		'KEY id_objet' => 'id_objet',
		'KEY objet' => 'objet',
	);
 
	$spip_meta = array(
		'nom' => 'VARCHAR (255) NOT NULL',
		'valeur' => "text DEFAULT ''",
		'impt' => "ENUM('non', 'oui') DEFAULT 'oui' NOT NULL",
		'maj' => 'TIMESTAMP'
	);
 
	$spip_meta_key = array(
		'PRIMARY KEY' => 'nom'
	);
 
	$spip_jobs_liens = array(
		'id_job' => "bigint(21) DEFAULT '0' NOT NULL",
		'id_objet' => "bigint(21) DEFAULT '0' NOT NULL",
		'objet' => "VARCHAR (25) DEFAULT '' NOT NULL",
	);
 
	$spip_jobs_liens_key = array(
		'PRIMARY KEY' => 'id_job,id_objet,objet',
		'KEY id_job' => 'id_job'
	);
 
	$tables_auxiliaires['spip_auteurs_liens'] = array(
		'field' => &$spip_auteurs_liens,
		'key' => &$spip_auteurs_liens_key
	);
 
	$tables_auxiliaires['spip_meta'] = array(
		'field' => &$spip_meta,
		'key' => &$spip_meta_key
	);
	$tables_auxiliaires['spip_resultats'] = array(
		'field' => &$spip_resultats,
		'key' => &$spip_resultats_key
	);
	$tables_auxiliaires['spip_jobs_liens'] = array(
		'field' => &$spip_jobs_liens,
		'key' => &$spip_jobs_liens_key
	);
 
}

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.