/***************************************************************************\
* SPIP, Systeme de publication pour l'internet *
* *
- * Copyright (c) 2001-2016 *
+ * Copyright (c) 2001-2017 *
* Arnaud Martin, Antoine Pitrou, Philippe Riviere, Emmanuel Saint-James *
* *
* Ce programme est un logiciel libre distribue sous licence GNU/GPL. *
* Pour plus de details voir le fichier COPYING.txt ou l'aide en ligne. *
\***************************************************************************/
-if (!defined('_ECRIRE_INC_VERSION')) return;
+/**
+ * Gestion du formulaire de d'édition de rubrique
+ *
+ * @package SPIP\Core\Rubriques\Formulaires
+ **/
+
+if (!defined('_ECRIRE_INC_VERSION')) {
+ return;
+}
include_spip('inc/actions');
include_spip('inc/editer');
-// http://doc.spip.org/@inc_editer_article_dist
-function formulaires_editer_rubrique_charger_dist($id_rubrique='new', $id_parent=0, $retour='', $lier_trad=0, $config_fonc='rubriques_edit_config', $row=array(), $hidden=''){
- return formulaires_editer_objet_charger('rubrique',$id_rubrique,$id_parent,$lier_trad,$retour,$config_fonc,$row,$hidden);
+
+/**
+ * Chargement du formulaire d'édition d'une rubrique
+ *
+ * @see formulaires_editer_objet_charger()
+ *
+ * @param int|string $id_rubrique
+ * Identifiant de la rubrique. 'new' pour une nouvelle rubrique
+ * @param int $id_parent
+ * Identifiant de la rubrique parente
+ * @param string $retour
+ * URL de redirection après le traitement
+ * @param int $lier_trad
+ * Identifiant éventuel d'une rubrique source de traduction
+ * @param string $config_fonc
+ * Nom de la fonction ajoutant des configurations particulières au formulaire
+ * @param array $row
+ * Valeurs de la ligne SQL de la rubrique, si connue
+ * @param string $hidden
+ * Contenu HTML ajouté en même temps que les champs cachés du formulaire.
+ * @return array
+ * Environnement du formulaire
+ **/
+function formulaires_editer_rubrique_charger_dist(
+ $id_rubrique = 'new',
+ $id_parent = 0,
+ $retour = '',
+ $lier_trad = 0,
+ $config_fonc = 'rubriques_edit_config',
+ $row = array(),
+ $hidden = ''
+) {
+ return formulaires_editer_objet_charger(
+ 'rubrique',
+ $id_rubrique,
+ $id_parent,
+ $lier_trad,
+ $retour,
+ $config_fonc,
+ $row,
+ $hidden
+ );
}
-function rubriques_edit_config($row)
-{
+/**
+ * Choix par défaut des options de présentation
+ *
+ * @param array $row
+ * Valeurs de la ligne SQL d'une rubrique, si connue
+ * return array
+ * Configuration pour le formulaire
+ */
+function rubriques_edit_config($row) {
global $spip_lang;
$config = $GLOBALS['meta'];
$config['langue'] = $spip_lang;
$config['restreint'] = (!$GLOBALS['connect_toutes_rubriques']);
+
return $config;
}
/**
- * Identifier le formulaire en faisant abstraction des parametres qui
- * ne representent pas l'objet edite
+ * Identifier le formulaire en faisant abstraction des paramètres qui
+ * ne représentent pas l'objet édité
+ *
+ * @param int|string $id_rubrique
+ * Identifiant de la rubrique. 'new' pour une nouvelle rubrique
+ * @param int $id_parent
+ * Identifiant de la rubrique parente
+ * @param string $retour
+ * URL de redirection après le traitement
+ * @param int $lier_trad
+ * Identifiant éventuel d'une rubrique source de traduction
+ * @param string $config_fonc
+ * Nom de la fonction ajoutant des configurations particulières au formulaire
+ * @param array $row
+ * Valeurs de la ligne SQL de la rubrique, si connue
+ * @param string $hidden
+ * Contenu HTML ajouté en même temps que les champs cachés du formulaire.
+ * @return string
+ * Hash du formulaire
*/
-function formulaires_editer_rubrique_identifier_dist($id_rubrique='new', $id_parent=0, $retour='', $lier_trad=0, $config_fonc='rubriques_edit_config', $row=array(), $hidden=''){
- return serialize(array(intval($id_rubrique),$lier_trad));
+function formulaires_editer_rubrique_identifier_dist(
+ $id_rubrique = 'new',
+ $id_parent = 0,
+ $retour = '',
+ $lier_trad = 0,
+ $config_fonc = 'rubriques_edit_config',
+ $row = array(),
+ $hidden = ''
+) {
+ return serialize(array(intval($id_rubrique), $lier_trad));
}
-function formulaires_editer_rubrique_verifier_dist($id_rubrique='new', $id_parent=0, $retour='', $lier_trad=0, $config_fonc='rubriques_edit_config', $row=array(), $hidden=''){
+/**
+ * Vérifications du formulaire d'édition d'une rubrique
+ *
+ * @see formulaires_editer_objet_verifier()
+ *
+ * @param int|string $id_rubrique
+ * Identifiant de la rubrique. 'new' pour une nouvelle rubrique
+ * @param int $id_parent
+ * Identifiant de la rubrique parente
+ * @param string $retour
+ * URL de redirection après le traitement
+ * @param int $lier_trad
+ * Identifiant éventuel d'une rubrique source de traduction
+ * @param string $config_fonc
+ * Nom de la fonction ajoutant des configurations particulières au formulaire
+ * @param array $row
+ * Valeurs de la ligne SQL de la rubrique, si connue
+ * @param string $hidden
+ * Contenu HTML ajouté en même temps que les champs cachés du formulaire.
+ * @return array
+ * Erreurs du formulaire
+ **/
+function formulaires_editer_rubrique_verifier_dist(
+ $id_rubrique = 'new',
+ $id_parent = 0,
+ $retour = '',
+ $lier_trad = 0,
+ $config_fonc = 'rubriques_edit_config',
+ $row = array(),
+ $hidden = ''
+) {
// auto-renseigner le titre si il n'existe pas
- titre_automatique('titre',array('descriptif','texte'));
+ titre_automatique('titre', array('descriptif', 'texte'));
// on ne demande pas le titre obligatoire : il sera rempli a la volee dans editer_rubrique si vide
- $erreurs = formulaires_editer_objet_verifier('rubrique',$id_rubrique,array());
+ $erreurs = formulaires_editer_objet_verifier('rubrique', $id_rubrique, array());
+
return $erreurs;
}
-function formulaires_editer_rubrique_traiter_dist($id_rubrique='new', $id_parent=0, $retour='', $lier_trad=0, $config_fonc='rubriques_edit_config', $row=array(), $hidden=''){
- return formulaires_editer_objet_traiter('rubrique',$id_rubrique,$id_parent,$lier_trad,$retour,$config_fonc,$row,$hidden);
+/**
+ * Traitements du formulaire d'édition d'une rubrique
+ *
+ * @see formulaires_editer_objet_traiter()
+ *
+ * @param int|string $id_rubrique
+ * Identifiant de la rubrique. 'new' pour une nouvelle rubrique
+ * @param int $id_parent
+ * Identifiant de la rubrique parente
+ * @param string $retour
+ * URL de redirection après le traitement
+ * @param int $lier_trad
+ * Identifiant éventuel d'une rubrique source de traduction
+ * @param string $config_fonc
+ * Nom de la fonction ajoutant des configurations particulières au formulaire
+ * @param array $row
+ * Valeurs de la ligne SQL de la rubrique, si connue
+ * @param string $hidden
+ * Contenu HTML ajouté en même temps que les champs cachés du formulaire.
+ * @return array
+ * Retour des traitements
+ **/
+function formulaires_editer_rubrique_traiter_dist(
+ $id_rubrique = 'new',
+ $id_parent = 0,
+ $retour = '',
+ $lier_trad = 0,
+ $config_fonc = 'rubriques_edit_config',
+ $row = array(),
+ $hidden = ''
+) {
+ return formulaires_editer_objet_traiter(
+ 'rubrique',
+ $id_rubrique,
+ $id_parent,
+ $lier_trad,
+ $retour,
+ $config_fonc,
+ $row,
+ $hidden
+ );
}
-
-?>