From b492c82e3c3b8e388ee9556eb129c7b9af6dc43a Mon Sep 17 00:00:00 2001
From: amemo <amemo@rezo.net>
Date: Fri, 9 May 2014 13:31:08 +0000
Subject: [PATCH] =?UTF-8?q?Documentation=20du=20code=20:=20-=20init=5Fbody?=
=?UTF-8?q?=20(par=20Ybbet)=20:=C2=A0=20-=20init=5Fbody=5Fclass=20(par=20Y?=
=?UTF-8?q?bbet)=20:=C2=A0=20-=20init=5Fentete=20(par=20Ybbet)=20:=C2=A0?=
=?UTF-8?q?=20-=20init=5Fhead=20(par=20Ybbet)=20:=C2=A0$dummy=20ne=20sembl?=
=?UTF-8?q?e=20pas=20utilis=C3=A9=E2=80=A6=20Code=20historique=20=3F=20cf.?=
=?UTF-8?q?=20$id=5Frubrique?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
Relecteur : Matthieu Marcillaud
---
ecrire/inc/commencer_page.php | 58 +++++++++++++++++++++++++++++++----
1 file changed, 52 insertions(+), 6 deletions(-)
diff --git a/ecrire/inc/commencer_page.php b/ecrire/inc/commencer_page.php
index 0e0cebb257..6454301aef 100644
--- a/ecrire/inc/commencer_page.php
+++ b/ecrire/inc/commencer_page.php
@@ -55,8 +55,23 @@ function inc_commencer_page_dist($titre = "", $rubrique = "accueil", $sous_rubri
. '<div class="largeur">';
}
-// envoi du doctype et du <head><title>...</head>
-// http://doc.spip.org/@init_entete
+/**
+ * Envoi du DOCTYPE et du `<head><title>...</head>`
+ *
+ * @uses _DOCTYPE_ECRIRE
+ * @uses textebrut()
+ * @uses typo()
+ * @uses html_lang_attributes()
+ * @uses init_head()
+ *
+ * @param string $titre
+ * Titre de la page
+ * @param integer $dummy
+ * Valeur non utilisée…
+ * @param bool $minipres
+ * @return string
+ * Entête du fichier HTML avec le DOCTYPE
+ */
function init_entete($titre='', $dummy=0, $minipres=false) {
include_spip('inc/texte');
if (!$nom_site_spip = textebrut(typo($GLOBALS['meta']["nom_site"])))
@@ -73,13 +88,37 @@ function init_entete($titre='', $dummy=0, $minipres=false) {
. init_head($titre, $dummy, $minipres)
. "</head>\n";
}
-
+/**
+ * Retourne le code HTML du head (intégration des JS et CSS) de l'espace privé
+ *
+ * Code HTML récupéré du squelette `prive/squelettes/head/dist`
+ *
+ * @param string $titre
+ * @param integer $dummy
+ * @param bool $minipres
+ * @return string
+ */
function init_head($titre='', $dummy=0, $minipres=false) {
return recuperer_fond("prive/squelettes/head/dist",array('titre'=>$titre,'minipres'=>$minipres?' ':''));
}
-// fonction envoyant la double serie d'icones de redac
-// http://doc.spip.org/@init_body
+/**
+ * Fonction envoyant la double série d'icônes de rédac
+ *
+ * @uses init_body_class()
+ * @uses inc_bandeau_dist()
+ *
+ * @pipeline_appel body_prive
+ *
+ * @global mixed $connect_id_auteur
+ * @global mixed $auth_can_disconnect
+ *
+ * @param string $rubrique
+ * @param string $sous_rubrique
+ * @param integer $id_rubrique
+ * @param bool $menu
+ * @return string
+ */
function init_body($rubrique='accueil', $sous_rubrique='accueil', $id_rubrique='',$menu=true) {
global $connect_id_auteur, $auth_can_disconnect;
@@ -96,7 +135,14 @@ function init_body($rubrique='accueil', $sous_rubrique='accueil', $id_rubrique='
return $res
. $bandeau();
}
-
+/**
+ * Calcule les classes CSS à intégrer à la balise `<body>` de l'espace privé
+ *
+ * Les classes sont calculées en fonction des préférences de l'utilisateur,
+ * par exemple s'il choisit d'avoir ou non les icônes.
+ *
+ * @return string Classes CSS (séparées par des espaces)
+ */
function init_body_class() {
$GLOBALS['spip_display'] = isset($GLOBALS['visiteur_session']['prefs']['display'])
? $GLOBALS['visiteur_session']['prefs']['display']
--
GitLab