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/inc/plugin.php
Fonction
plugin_trier

    Nom ou pseudo de l'auteur de la proposition

Code original

/**
 * Trier les plugins en vériant leur dépendances (qui doivent être présentes)
 *
 * Pour tester "utilise", il faut connaître tous les plugins
 * qui seront forcément absents à la fin,
 * car absent de la liste des plugins actifs.
 * 
 * Il faut donc construire une liste ordonnée.
 * 
 * Cette fonction détecte des dépendances circulaires,
 * avec un doute sur un "utilise" qu'on peut ignorer.
 * Mais ne pas insérer silencieusement et risquer un bug sournois latent
 * 
 * @uses plugin_version_compatible()
 * 
 * @param array $infos 
 *     Répertoire (plugins, plugins-dist, ...) => Couples (prefixes => infos completes) des plugins qu'ils contiennent
 * @param array $liste_non_classee
 *     Couples (prefixe => description) des plugins qu'on souhaite utiliser
 * @return array
 *     Tableau de 3 éléments :
 *     - $liste : couples (prefixes => description) des plugins valides
 *     - $ordre : couples (prefixes => infos completes) des plugins triés
 *                (les plugins nécessités avant les plugins qui les utilisent)
 *     - $liste_non_classee : couples (prefixes => description) des plugins 
 *                qui n'ont pas satisfait leurs dépendances
**/
function plugin_trier($infos, $liste_non_classee) {
	$toute_la_liste = $liste_non_classee;
	$liste = $ordre = array();
	$count = 0;
 
	while ($c = count($liste_non_classee) and $c != $count) { // tant qu'il reste des plugins a classer, et qu'on ne stagne pas
		#echo "tour::";var_dump($liste_non_classee);
		$count = $c;
		foreach ($liste_non_classee as $p => $resume) {
			$plug = $resume['dir'];
			$dir_type = $resume['dir_type'];
			$info1 = $infos[$dir_type][$plug];
			// si des plugins sont necessaires,
			// on ne peut inserer qu'apres eux
			foreach ($info1['necessite'] as $need) {
				$nom = strtoupper($need['nom']);
				$compat = isset($need['compatibilite']) ? $need['compatibilite'] : '';
				if (!isset($liste[$nom]) or !plugin_version_compatible($compat, $liste[$nom]['version'])) {
					$info1 = false;
					break;
				}
			}
			if (!$info1) {
				continue;
			}
			// idem si des plugins sont utiles,
			// sauf si ils sont de toute facon absents de la liste
			foreach ($info1['utilise'] as $need) {
				$nom = strtoupper($need['nom']);
				$compat = isset($need['compatibilite']) ? $need['compatibilite'] : '';
				if (isset($toute_la_liste[$nom])) {
					if (!isset($liste[$nom]) or
						!plugin_version_compatible($compat, $liste[$nom]['version'])
					) {
						$info1 = false;
						break;
					}
				}
			}
			if ($info1) {
				$ordre[$p] = $info1;
				$liste[$p] = $liste_non_classee[$p];
				unset($liste_non_classee[$p]);
			}
		}
	}
 
	return array($liste, $ordre, $liste_non_classee);
}

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.