Créer un nouvel objet éditorial A pas de chat…

mardi 20 octobre 2009, par Matthieu Marcillaud

| 50

Nous allons étudier comment créer un nouvel objet éditorial très simple et sans relation, pour SPIP 2.0. De ces explications vont naître un petit plugin d’exemple. Mais le tout fait appel à un grand nombre de fonctions de SPIP et n’est pas évident à mettre en œuvre. Nous en profitons pour relever un défi : aucun affichage géré en PHP, mais tout en squelette SPIP.

Nous allons définir un nouvel objet SPIP. Cet objet sera un « chat » ! Pourquoi pas ? Nous allons voir dans un premier temps comment créer la table SQL correspondante et donner un exemple de mise à jour. Nous décrirons ensuite la création d’une page de visualisation des chats, celle pour éditer un chat existant, et le formulaire CVT qui correspond. Enfin, nous ajouterons une action pour pouvoir supprimer un chat ! Et que la SPA ne m’en veuille pas trop, ce n’est qu’un exemple ! Et pour terminer, nous verrons comment interfacer le plugin « Champs Extras 2 » sur le nouvel objet !

Création du plugin

On commence par un fichier plugin.xml rudimentaire. On déclare dedans cependant une information qui peut être utile : 1 dépendance, à SPIP 2.

<plugin>
	<nom>Chats (plugin d'exemple)</nom>
	<auteur>Matthieu Marcillaud</auteur>
	<version>1.0</version>
	<etat>stable</etat>
	<description>
		Ce plugin est un exemple de cr&eacute;ation
		d'un nouvel objet &eacute;ditorial dans SPIP
	</description>
	<lien>http://marcimat.magraine.net/?article344</lien>
	<icon>images/chat-128.png</icon>
	<prefix>chats</prefix>
 
	<necessite id="SPIP" version="[2.0.9;]" />
 
</plugin>

Nous créons un premier dossier images pour stocker les images relatives au plugin, et un dossier lang pour stocker les traductions, avec un premier fichier dedans chats_fr.php contenant quelques premiers mots :

<?php
 
// This is a SPIP language file  --  Ceci est un fichier langue de SPIP
if (!defined("_ECRIRE_INC_VERSION")) return;
 
$GLOBALS[$GLOBALS['idx_lang']] = array(
	// C
	'chats' => 'Chats',
);
 
?>

Déclaration de la table spip_chats

Nous allons déclarer une table très simple « spip_chats » contenant les champs :

id_chat
race
nom
age
maj (mise à jour)

Pour cela nous devons utiliser des pipelines adaptés : declarer_tables_principales et declarer_tables_interfaces. Nous ajoutons donc leur appel dans le fichier plugin.xml :

<pipeline>
	<nom>declarer_tables_interfaces</nom>
	<inclure>base/chats.php</inclure>
</pipeline>
<pipeline>
	<nom>declarer_tables_principales</nom>
	<inclure>base/chats.php</inclure>
</pipeline>

Nous créons alors le fichier base/chats.php contenant les fonctions qui seront appelés par les pipelines en question. Voici son contenu. La première fonction chats_declarer_tables_interfaces indique que l’on peut utiliser le raccourcis « CHATS » comme table de boucle SPIP et que la balise #RACE reçoit par défaut des traitements typographiques. La seconde fonction chats_declarer_tables_principales déclare la table « spip_chats » et ses champs SQL associés.

<?php
 
function chats_declarer_tables_interfaces($interface){
	$interface['table_des_tables']['chats'] = 'chats';	
	$interface['table_des_traitements']['RACE']['chats'] = _TRAITEMENT_TYPO;
	return $interface;
}
 
 
function chats_declarer_tables_principales($tables_principales){
	//-- Table CHATS ------------------------------------------
	$chats = array(
			"id_chat"	=> "bigint(21) NOT NULL",
			"race"	=> "tinytext DEFAULT '' NOT NULL",
			"nom"	=> "tinytext DEFAULT '' NOT NULL",
			"annee_naissance"	=> "int(4) DEFAULT '0' NOT NULL",
			"maj"	=> "TIMESTAMP"
			);
 
	$chats_key = array(
			"PRIMARY KEY"	=> "id_chat",
			);
 
	$tables_principales['spip_chats'] =
		array('field' => &$chats, 'key' => &$chats_key);
 
	return $tables_principales;
}
 
?>

Installation/désinstallation de la table spip_chats

Pour gérer l’installation et la désinstallation, il faut indiquer un numéro de version des informations SQL du plugin ainsi qu’un fichier d’installation dans plugin.xml :

<version_base>1.0</version_base>
<install>base/chats_upgrade.php</install>

Ce fichier base/chats_upgrade.php contient deux fonctions :

chats_upgrade sert à l’installation et aux mises à jour. Ici, à la première activation du plugin, $current_version vaut encore "0.0" et la fonction creer_base() est executée. Cette fonction crée les tables SQL déclarées à SPIP mais absentes de la base de donnée. Par conséquent, la table spip_chats sera créée ;
chats_vider_tables sert pour la désinstallation. Elle supprime simplement la table SQL spip_chats ainsi que la variable meta contenant le numéro de version SQL installé du plugin.

<?php
include_spip('inc/meta');
include_spip('base/create');
 
function chats_upgrade($nom_meta_base_version, $version_cible){
	$current_version = "0.0";
 
	if (isset($GLOBALS['meta'][$nom_meta_base_version]))
		$current_version = $GLOBALS['meta'][$nom_meta_base_version];
 
	if ($current_version=="0.0") {
		creer_base();
		ecrire_meta($nom_meta_base_version, $current_version=$version_cible);
	}
}
 
function chats_vider_tables($nom_meta_base_version) {
	sql_drop_table("spip_chats");
	effacer_meta($nom_meta_base_version);
}
 
?>

Mise à jour de la table

Mince ! Nous avons oublié les champs « robe » et « infos » ! Mettons à jour le plugin :

on ajoute la déclaration des champs dans base/chats.php ("robe" => "tinytext DEFAULT '' NOT NULL", et "infos" => "text DEFAULT '' NOT NULL", au dessus de « maj ») ;
on modifie la version SQL du plugin dans plugin.xml (<version_base>1.1</version_base>) ;
on crée une mise à jour dans la fonction chats_upgrade() de base/chats_upgrade.php qui devient :

function chats_upgrade($nom_meta_base_version, $version_cible){
	$current_version = "0.0";
 
	if ($current_version=="0.0") {
		creer_base();
		ecrire_meta($nom_meta_base_version, $current_version=$version_cible);
	}
	if (version_compare($current_version,"1.1","<")){
		// ajout du champ "robe" et "infos"
		maj_tables('spip_chats');
		ecrire_meta($nom_meta_base_version,$current_version="1.1");
	}
}

On remarque que l’on teste si la version des tables SQL du plugin est inférieur à la nouvelle version renseignée dans plugin.xml. Si c’est le cas, on lance la fonction maj_tables('spip_chats') qui va créer tous les champs manquant de la table désignée. Cette fonction ne fait qu’ajouter des champs, en aucun cas elle ne supprime ou modifie des champs existants. Pour des opérations plus complexes, il faut utiliser les fonctions sql_* adaptées, tel que sql_alter().

Création du bouton pour accéder à la liste des chats

Commençons par créer un bouton dans le menu d’édition pour amener à la page qui listera les chats. On ajoute au plugin.xml la déclaration suivante d’un bouton, ainsi que l’usage du pipelines d’autorisations :

<bouton id='chats' parent='naviguer'>
	<icone>images/chat-24.png</icone>
	<titre>chats:chats</titre>
</bouton>
<pipeline>
	<nom>autoriser</nom>
	<inclure>chats_autorisations.php</inclure>
</pipeline>

Le bouton indique que l’on crée un lien vers la page ?exec=chats (indiquée par l’attribut id) dans le menu « Édition » de SPIP. A chaque bouton est associé une autorisation de le voir. Nous créons donc le fichier chats_autorisations.php pour déclarer cette fonction (autoriser_chats_bouton_dist) :

<?php
if (!defined("_ECRIRE_INC_VERSION")) return;
 
// fonction pour le pipeline, n'a rien a effectuer
function chats_autoriser(){}
 
// declarations d'autorisations
function autoriser_chats_bouton_dist($faire, $type, $id, $qui, $opt) {
	return autoriser('voir', 'chats', $id, $qui, $opt);
}
 
function autoriser_chats_voir_dist($faire, $type, $id, $qui, $opt) {
	return true;
}
 
?>


Bouton d’accès aux Chats

Création d’une page privée pour lister les chats

Nous créons alors le fichier prive/exec/chats.html. Il liste les chats présents et propose des actions pour « voir », « modifier » ou « supprimer » chaque chat. Dans la colonne de navigation, une description du plugin ainsi qu’un lien pour créer un nouveau chat est présent. Le filtre icone utilisé qui facilite la création d’icone en squelette provient du plugin « spip_bonux ». Nous devons donc ajouter cette dépendance dans le fichier plugin.xml. De nouvelles autorisations permettent de gérer l’affichage des actions possibles, il faut aussi les renseigner.

Le fichier ne doit retourner aucun contenu si le visiteur n’a pas le droit de voir cette page. On place donc la même autorisation que pour le bouton du menu qui conditionne l’affichage du contenu. Dedans, une inclusion appelle une boucle sur la table chats.

[(#AUTORISER{voir, chats})
	<h1><:chats:liste_des_chats:></h1>
 
	<div class='ajax'>
	<INCLURE{fond=inclure/liste_chats,env,ajax} />
	</div>
 
	<!--#navigation-->
	<div class='cadre cadre-info'>
		<p><:chats:description_chats:></p>
 
		[(#AUTORISER{modifier, chat})
			[(#URL_ECRIRE{chat_edit}
				|parametre_url{new,oui}
				|icone{<:chats:action_ajouter:>, #CHEMIN{images/chat-24.png}, center, creer.gif})]
		]
	</div>
	<!--/#navigation-->
]

Contenu de inclure/liste_chats.html :

<B_chats>
<table class='chats spip'>
	<thead>
	<tr>
		<th><:chats:label_id:></th>
		<th><:chats:label_nom:></th>
		<th><:chats:label_race:></th>
		<th><:chats:label_robe:></th>
		<th><:chats:label_annee_naissance:></td>
		<th><:chats:label_actions:></td>
	</tr>
	</thead>
	<tbody>
<BOUCLE_chats(CHATS){par nom}{pagination 10}>
	<tr class="[(#COMPTEUR_BOUCLE|alterner{row_odd,row_even})]">
		<td>#ID_CHAT</td>
		<td>#NOM</td>
		<td>#RACE</td>
		<td>#ROBE</td>
		[(#SET{nb,[(#DATE{Y}|moins{#ANNEE_NAISSANCE})]})]
		<td>[(#ANNEE_NAISSANCE|oui)<:chats:nb_ans{nb=#GET{nb}}:>]</td>
		<td>
			[(#AUTORISER{voir,chat,#ID_CHAT})
				<a href='[(#URL_ECRIRE{chat_voir}|parametre_url{id_chat,#ID_CHAT})]'><:chats:action_voir:></a>
			]
			[(#AUTORISER{modifier,chat,#ID_CHAT})
				|
				<a href='[(#URL_ECRIRE{chat_edit}|parametre_url{id_chat,#ID_CHAT})]'><:chats:action_modifier:></a>
				|
				<a href='[(#URL_ACTION_AUTEUR{supprimer_chat,#ID_CHAT,#SELF})]'><:chats:action_supprimer:></a>
			]
		</td>
	</tr>
</BOUCLE_chats>
	</tbody>
</table>
[<p class='pagination'>(#PAGINATION)</p>]
</B_chats>

Les autorisations correspondantes sont ajoutées au fichier chats_autorisations.php :

function autoriser_chat_voir_dist($faire, $type, $id, $qui, $opt) {
	return autoriser('modifier', 'chat', $id, $qui, $opt);
}
 
function autoriser_chat_modifier_dist($faire, $type, $id, $qui, $opt) {
	return in_array($qui['statut'], array('0minirezo', '1comite'));
}


Liste des chats

Création d’une page privée pour voir un chat

Nous cherchons maintenant à afficher une page, nommée « chat_voir » qui détaille un chat. On va créer pour cela 3 fichiers :

prive/exec/chat_voir.html gère l’ensemble de la page,
prive/contenu/chat.html, s’occupe simplement du contenu à afficher au centre et
prive/infos/chat.html décrit l’objet dans la colonne gauche.

Code de prive/exec/chat_voir.html. Comme précédemment, une autorisation teste si on a le droit d’acceder au contenu. Ici, on utilise la boucle CONDITION du plugin « spip_bonux » pour pouvoir insérer des boucles dans la condition. En l’occurrence une boucle sur le chat sélectionné.

Un lien pour modifier ansi que le titre sont affichés avant d’appeler le fichier affichant le contenu ([(#INCLURE{fond=prive/contenu/chat,id=#ID_CHAT})]) dont tout le contenu est envoyé au pipeline « afficher_contenu_objet » (qui servira notamment au plugin « Champs Extras »).

Enfin, dans la navigation, on appelle le pipeline « boite_infos » ; c’est lui qui chargera le fichier prive/infos/chat.html.

<BOUCLE_si_autorise(CONDITION){si (#ID_CHAT|intval|et{#AUTORISER{voir,chat,#ID_CHAT}})}>
<BOUCLE_chat(CHATS){id_chat}{tout}>
<div class='fiche_objet'>
	[(#AUTORISER{modifier,chat,#ID_CHAT})
		<div class='bandeau_actions'>
 
			[(#URL_ECRIRE{chat_edit}
				|parametre_url{id_chat,#ID_CHAT}
				|parametre_url{retour,#SELF}
				|icone{<:chats:action_modifier:>, #CHEMIN{images/chat-24.png}, #LANG_RIGHT, edit.gif})]
		</div>
	]
 
 
	<h1>#NOM</h1>
 
	<div id='wysiwyg'>
		[(#PIPELINE{afficher_contenu_objet,[(#ARRAY{
			args,[(#ARRAY{
				type,chat,
				id_objet,#ID_CHAT,
				contexte,[(#ARRAY{
					id_chat,#ID_CHAT})]})],
			data,[(#INCLURE{fond=prive/contenu/chat,id=#ID_CHAT})]})]})]
	</div>
</div>
 
<!--#navigation-->
[(#REM) Ce pipeline charge prive/infos/$type ]
[<div class='cadre cadre-info'>
	(#PIPELINE{boite_infos,[(#ARRAY{
		args,[(#ARRAY{
			type,chat,
			id,#ID_CHAT})],
		data,''})]})
</div>]
<!--/#navigation-->
</BOUCLE_chat>
</BOUCLE_si_autorise>

Le second fichier prive/contenu/chat.html affiche le contenu du chat et se présente comme une liste de champs à afficher. C’est le même code répété pour chaque champ (pour notre exemple) :

<BOUCLE_afficher_contenu(CHATS){id_chat=#ENV{id}}{tout}>
<div class="champ contenu_nom[ (#NOM*|strlen|?{'',vide})]">
	<div class='label'><:chats:label_nom:></div>
	<div dir='#LANG_DIR' class='#EDIT{nom} nom'>#NOM</div>
</div>
<div class="champ contenu_race[ (#RACE*|strlen|?{'',vide})]">
	<div class='label'><:chats:label_race:></div>
	<div dir='#LANG_DIR' class='#EDIT{race} race'>#RACE</div>
</div>
<div class="champ contenu_robe[ (#ROBE*|strlen|?{'',vide})]">
	<div class='label'><:chats:label_robe:></div>
	<div dir='#LANG_DIR' class='#EDIT{robe} robe'>#ROBE</div>
</div>
<div class="champ contenu_annee_naissance[ (#ANNEE_NAISSANCE*|strlen|?{'',vide})]">
	<div class='label'><:chats:label_annee_naissance:></div>
	<div dir='#LANG_DIR' class='#EDIT{annee_naissance} annee_naissance'>#ANNEE_NAISSANCE</div>
</div>
<div class="champ contenu_infos[ (#INFOS*|strlen|?{'',vide})]">
	<div class='label'><:chats:label_infos:></div>
	<div dir='#LANG_DIR' class='#EDIT{infos} infos'>#INFOS</div>
</div>
</BOUCLE_afficher_contenu>

Le dernier fichier prive/infos/chat.html décrit quelques statistiques des objets. Ici rien d’intéressant ne nous concerne, on affiche simplement l’identifiant du chat :

<BOUCLE_chat_info(CHATS){id_chat=#ENV{id}}{tout}>
<div class='infos'>
	<div class='numero'>
		<:chats:info_gauche_numero_chat:>
		<p>#ID_CHAT</p>
	</div>
</div>
</BOUCLE_chat_info>


Vue du chat

Création d’une page privée pour ajouter ou modifier un chat

Nous créons pour cela 2 fichiers :

prive/exec/chat_edit.html gère l’affichage de l’ensemble de la page et appelle le fichier suivant
prive/editer/chat.html charge le formulaire. On pourrait cela dit mettre l’intégralité de ce fichier dans le premier. Cette inclusion est simplement là pour reprendre le même schéma que le core de SPIP.

Le code le prive/exec/chat_edit.html calcule une icone de retour (pour revenir en arrière sans valider le formulaire), et un titre, puis appelle l’inclusion avec ces valeurs. Le hic est la nécessité de récupérer soit une variable id_chat par GET, soit par POST (lorsqu’on réaffiche un formulaire qui a une erreur). Le cache à zéro et le calcul [(#VAL{id_chat}|_request|sinon{new})] nous le permet.

#CACHE{0}
[(#SET{id_chat,[(#VAL{id_chat}|_request|sinon{new})]})]
<BOUCLE_si_autorise(CONDITION){si (#AUTORISER{modifier,chat,#GET{id_chat}})}>
 
	[(#SET{retour, #URL_ECRIRE{chats}})]
	<BOUCLE_titre(CHATS){id_chat=#GET{id_chat}}{tout}>
		[(#SET{titre, #NOM})]
		[(#SET{retour, [(#URL_ECRIRE{chat_voir}|parametre_url{id_chat,#ID_CHAT})]})]
	</BOUCLE_titre>
 
	[(#INCLURE{fond=prive/editer/chat,
		id_chat=#GET{id_chat},
		icone_retour=[(#ENV{retour,#GET{retour}}
			|icone{<:icone_retour:>, #CHEMIN{images/chat-24.png}, #LANG_LEFT })],
		titre=#GET{titre}
	})]
 
</BOUCLE_si_autorise>

Le second fichier, prive/editer/chat.html affiche l’icone, le titre, et appelle le formulaire d’édition CVT.

<div class='cadre-formulaire-editer'>
<div class="entete-formulaire">
	#ENV**{icone_retour}
	[<:chats:info_modifier_chat:>
	<h1>(#ENV{titre,<:chats:texte_nouveau_chat:>})</h1>]
</div>
 
#FORMULAIRE_EDITER_CHAT{#ENV{id_chat,new},#ENV{redirect}}
</div>

Création du formulaire CVT d’édition

Nous créons 3 fichiers en tout :

formulaires/editer_chat.html contenant le HTML du formulaire,
formulaires/editer_chat.php contenant les 3 fonctions Charger, Vérifier et Traiter, mais qui appellent simplement des fonctions SPIP génériques,
action/editer_chat.php qui contient le traitement du formulaire.

Le code HTML du formulaire CVT, utilise ici la balise #SAISIE du plugin « saisies » simplement pour se simplifier l’écriture (Oui je sais, y l’heure actuelle ce plugin n’est pas documenté !). Le fichier formulaires/editer_chat.html contient :

<div class='formulaire_spip formulaire_editer formulaire_#FORM formulaire_#FORM-#ENV{id_chat,nouveau}'>
 
	[<p class="reponse_formulaire reponse_formulaire_ok">(#ENV**{message_ok})</p>]
	[<p class="reponse_formulaire reponse_formulaire_erreur">(#ENV*{message_erreur})</p>]
 
	[(#ENV{editable}|oui)
	<form method='post' action='#ENV{action}'><div>
		#ACTION_FORMULAIRE{#ENV{action}}
		<input type='hidden' name='id_chat' value='#ENV{id_chat}' />
		<ul>
		[(#SAISIE{input, nom,
			label=<:chats:label_nom:>,
			obligatoire=oui})]
 
		[(#SAISIE{input, race,
			label=<:chats:label_race:>})]
 
		[(#SAISIE{input, robe,
			label=<:chats:label_robe:>,
			size=4})]		
 
		[(#SAISIE{input, annee_naissance,
			label=<:chats:label_annee_naissance:>,
			size=4})]
 
		[(#SAISIE{textarea, infos,
			label=<:chats:label_infos:>,
			explication=<:chats:explication_infos:>})]			
		</ul>
		[(#REM) ajouter les saisies supplementaires : extra et autre, a cet endroit ]
		<!--extra-->
		<p class="boutons"><input type='submit' class='submit' value='<:bouton_enregistrer:>' /></p>
	</div></form>
	]
</div>


Edition d’un chat

Le fichier PHP correspondant formulaires/editer_chat.php quant à lui contient :

<?php
 
if (!defined("_ECRIRE_INC_VERSION")) return;
 
include_spip('inc/actions');
include_spip('inc/editer');
 
function formulaires_editer_chat_charger_dist($id_chat='new', $retour=''){
	$valeurs = formulaires_editer_objet_charger('chat', $id_chat, '', '', $retour, '');
	return $valeurs;
}
 
function formulaires_editer_chat_verifier_dist($id_chat='new', $retour=''){
	$erreurs = formulaires_editer_objet_verifier('chat', $id_chat, array('nom'));
	return $erreurs;
}
 
function formulaires_editer_chat_traiter_dist($id_chat='new', $retour=''){
	return formulaires_editer_objet_traiter('chat', $id_chat, '', '', $retour, '');
}
 
?>

Les fonctions génériques formulaires_editer_objet_$action() ont des arguments prédéfinis. Certains nous sont inutiles et nous mettons simplement une chaine vide '' à la place. Les deux premières fonctions (charger et vérifier) peuvent être complètement prises en charge sans rien faire de plus (si nous n’avons pas de besoins particuliers). Seule la fonction traiter nécessite de créer une action de traitement, dans un fichier action/editer_chat.php.

Ce dernier fichier contient 3 fonctions :

action_editer_chat_dist() verifie l’argument, appelle insert_chat() si on a besoin d’un nouveau chat, puis appelle revisions_chats($id_chat) qui va appliquer les modifications.
insert_chat() crée un nouvel enregistrement de chat, en appelant juste avant le pipeline « pre_insertion ».
revisions_chats($id_chat), récupère les champs postés du formulaire, puis appelle la fonction générique « modifier_contenu » en passant le nom de la table, l’identifiant, et les champs à modifier. Cette fonction appellera automatiquement les pipelines « pre_edition » et « post_edition ». Peu connu, on peut aussi lui passer en paramètre d’option la clé pour invalider le cache en même temps.

Voici le contenu de ce fichier :

<?php
 
if (!defined("_ECRIRE_INC_VERSION")) return;
 
function action_editer_chat_dist() {
	$securiser_action = charger_fonction('securiser_action', 'inc');
	$arg = $securiser_action();
 
	// pas de chat ? on en cree un nouveau, mais seulement si 'oui' en argument.
	if (!$id_chat = intval($arg)) {
		if ($arg != 'oui') {
			include_spip('inc/headers');
			redirige_url_ecrire();
		}
		$id_chat = insert_chat();
	}
 
	if ($id_chat) $err = revisions_chats($id_chat);
	return array($id_chat,$err);
}
 
 
function insert_chat() {
	$champs = array(
		'nom' => _T('chats:item_nouveau_chat')
	);
 
	// Envoyer aux plugins
	$champs = pipeline('pre_insertion', array(
		'args' => array(
			'table' => 'spip_chats',
		),
		'data' => $champs
	));
 
	$id_chat = sql_insertq("spip_chats", $champs);
	return $id_chat;
}
 
 
// Enregistrer certaines modifications d'un chat
function revisions_chats($id_chat, $c=false) {
 
	// recuperer les champs dans POST s'ils ne sont pas transmis
	if ($c === false) {
		$c = array();
		foreach (array('nom', 'race', 'robe', 'annee_naissance', 'infos') as $champ) {
			if (($a = _request($champ)) !== null) {
				$c[$champ] = $a;
			}
		}
	}
 
	include_spip('inc/modifier');
	modifier_contenu('chat', $id_chat, array(
			'nonvide' => array('nom' => _T('info_sans_titre')),
			'invalideur' => "id='id_chat/$id_chat'"
		),
		$c);
}
?>

Création de l’action de suppression

L’action de suppression nécessite de créer un fichier action/supprimer_chat.php qui va réaliser la suppression après avoir vérifié que l’argument attendu est correct.

<?php
 
if (!defined("_ECRIRE_INC_VERSION")) return;
 
function action_supprimer_chat_dist() {
	$securiser_action = charger_fonction('securiser_action', 'inc');
	$arg = $securiser_action();
 
	if (!preg_match(",^(\d+)$,", $arg, $r)) {
		 spip_log("action_supprimer_chat_dist $arg pas compris");
	} else {
		action_supprimer_chat_post($r[1]);
	}
}
 
function action_supprimer_chat_post($id_chat) {
	sql_delete("spip_chats", "id_chat=" . sql_quote($id_chat));
 
	include_spip('inc/invalideur');
	suivre_invalideur("id='id_chat/$id_chat'");
}
?>

Interface avec « Champs Extras 2 »

Figurez-vous que c’est le plus simple maintenant, car notre objet CHAT traverse tous les pipelines qu’il faut pour que Champs Extras insère de nouveaux champs à cet objet.

Il suffit donc de déclarer à Champs Extras que l’objet Chat peut-être utilisé. Pour cela, on déclare utiliser un pipeline dans plugin.xml, et l’on crée un fichier chats_pipelines.php pour accueillir la fonction correspondante.

plugin.xml :

<!-- avec plugin champs extras 2 -->
<pipeline>
	<nom>objets_extensibles</nom>
	<inclure>chats_pipelines.php</inclure>
</pipeline>

chats_pipelines.php :

<?php
 
function chats_objets_extensibles($objets){
		return array_merge($objets, array('chat' => _T('chats:chats')));
}
 
?>


Champs Extras des Chats: Liste des champs extras déclarés.


Edition d’un chat avec extras


Vue du chat avec extra

Conclusions

Cet objet « Chat » très sommaire montre que réaliser l’interface et l’outil de modification nécessite encore beaucoup de code et de squelettes SPIP. Cependant, créer un nouvel objet est possible et de nombreuses fonctions de l’API de SPIP 2.0 permettent un gain de temps appréciable.

Le chemin parcouru par SPIP en quelques temps est bien visible mais il reste encore des outils qui mériteraient d’être simplifiées et améliorées, comme créer une fonction inserer_contenu($objet, $champs) pour la création d’éléments, ou encore $c = recuperer_champs_post($noms). Je n’ai pas réussi, sans chercher non plus, si on avait un moyen de créer un fil d’ariane sur les pages exec en squelette, mais je n’ai pas ce souvenir.

Tout cela m’a entre autre permis de distinguer qu’un plugin « Tables Extras » est difficilement envisageable encore sans faire écrire du code, mais en même temps que des parties pourraient se réaliser automatiquement.

Documents joints

Plugin Chats
20 octobre 2009 - Zip - 22.4 ko

Le plugin (code au moment de la création de l’article)

Vos commentaires

0
10
20
30

# Le 30 juillet à 17:52, par Jonathan En réponse à : Créer un nouvel objet éditorial

Est-ce que c’est envisageable de créer un nouvel objet spip en lien avec une zone restreinte du plugin accès restreint ? Quelle serait la bonne méthode ? J’imagine une table de liaison genre spip_zones_chats (pour reprendre ton exemple) et dont la structure ressemblerait à la table spip_zones_rubriques (pour mettre en correspondance #ID_CHAT avec #ID_ZONE ). Et si oui faut-il déclarer mon nouvel objet CHAT au plugin accès restreint ?

Répondre à ce message
# Le 4 mai 2012 à 19:10, par zwan En réponse à : Créer un nouvel objet éditorial

Salut,
Je debute dans la creation de plugin mais j’avoue que je me suis vraiment casser la tete avec ce probleme de SPIP.

Mon plugin est en principe tres simple : permettre aux internautes d’envoyer leur noms et contacts au webmaster.

J’ai donc créé une table inscrits qui est peuplé par les entrées des internautes. Rien de sorcier : avec les formulaires CVT c’est vite fait.

Mon probleme c’est quand je veux afficher les donner de cette table dans l’interface privé.
La page du plugin s’affiche bien mais c’est comme si la table etait vide.
Bizarre ! Je regarde dans le log, et je constate que SPIP cherche une table inconnue : show_tous qui est en fait l’url du bouton principal (ou son id, l’un ou lautre donne le meme resultat !
J ai meme changer le nom du fichier d’exec a register_tous et changer l’url du bouton et là encore SPIP se met a chercher une table register_tous.
J’ai fouillé partout et je trouve aucune idée de ce qui se passe.

Voila un extrait de mon fichier plugin.xml

<plugin> ... <version> 0.8 </version> <version_base> 0.8 </version_base> <etat> test </etat> <prefix> register </prefix> <install>base/register_installation.php</install> <pipeline> <nom>declarer_tables_principales</nom> <inclure>base/register_tables.php</inclure> </pipeline> <pipeline> <nom>declarer_tables_interfaces</nom> <inclure>base/register_tables.php</inclure> </pipeline> <bouton id="show_tous" parent="naviguer"> <icone>images/formulaire-24.png</icone> <titre>register:register_button</titre>  </bouton> </plugin>

Et un extrait de mon fichier log :

May 02 11:11:38 ::1 (pid 6648) COMPIL (1.198 ms) [../plugins/inscription/prive/exec/show_tous.html] html_5cd8bdc7977ec2ed52d438503e5d7a20.php May 02 11:11:38 ::1 (pid 6648) calcul (20.695 ms) [../plugins/inscription/prive/exec/show_tous] exec=show_tous, lang=en, date='2012-05-02 11:11:38', date_default=1, date_redac='2012-05-02 11:11:38', date_redac_default=1 (899 octets) May 02 11:11:38 ::1 (pid 6648) COMPIL (10.073 ms) [../plugins/inscription/prive/liste/view.html] html_7028a0d7e7bbbcd434eda0e73b9dd275.php May 02 11:11:38 ::1 (pid 6648) calcul (8.553 ms) [../plugins/spip-bonux/modeles/pagination_prive] lang=en, debut=debut_reponses, url=./?exec=show_tous, total=41, pas=10, nombre_pages=5, page_courante=1, ancre=pagination_reponses, date='2012-05-02 11:11:38', date_default=1, date_redac='2012-05-02 11:11:38', date_redac_default=1 (847 octets) May 02 11:11:38 ::1 (pid 6648) calcul (22.702 ms) [../plugins/inscription/prive/liste/view] titre=Registration, lang=en, date='2012-05-02 11:11:38', date_default=1, date_redac='2012-05-02 11:11:38', date_redac_default=1 (4634 octets) May 02 11:11:39 ::1 (pid 6648) Erreur mysql 1146 May 02 11:11:39 ::1 (pid 6648) Table 'waigf.show_tous' doesn't exist - SHOW CREATE TABLE `show_tous` May 02 11:11:39 ::1 (pid 6648) trouver_table: table inconnue '' 'show_tous'

Répondre à ce message
# Le 9 janvier 2010 à 15:42, par Cédric Couvrat En réponse à : Créer un nouvel objet éditorial

@Bernard
Pour l’insertion d’image j’ai vu passer un truc du genre

[(#PIPELINE{encart,#ID_OBJET})]

J’ai testé ça fonctionne. Inconvénient, il faut enregistrer pour que l’objet soit créé et ensuite on peut modifier l’objet pour joindre les documents (comme jadis avec les articles, ce qui est logique, si l’objet n’a pas d’ID difficile de lui attacher un document)

@tous
Quelqu’un connait le mécanisme qui permet de joindre les documents à l’article lors de la toute 1ère édition de ce dernier ?

@Bernard
Pour l’insertion de la barre typo avec porte plume Matthieu a répondu : il faut mettre le classe "inserer_barre_edition"
- # ^ Le 1er décembre 2011 à 13:03, par Franck En réponse à : Créer un nouvel objet éditorial
  
  Bonjour Cedric,
  
  Je lis ce post et suis confronté au problème de l’upload de document et d’images pour un nouvel objet.
  Peux tu m’en dire plus sur ta solution et si des réponses t’ont été apportées concernant les documents à joindre pour un nouvel objet (sans id ?)
  
  Cordialement
Répondre à ce message
# Le 21 décembre 2009 à 23:02, par Bernard En réponse à : Créer un nouvel objet éditorial

Pour l’upload d’images c’est réglé même si ma méthode n’est pas catholique car je mets du php dans du html et c’est surement pas le mieux.

Je crée un nouveau fichier prive/infos/$type.html avec ceci dedans :

echo afficher_documents_colonne( '#ID_OBJET', 'objet');

Bien entendu pour ceux que cela intéresse si l’objet est le chat on remplace par ID_CHAT et chat dans la ligne précédente.

Matthieu a certainement mieux à proposer et j’espère que de voir ce bout de code ne va pas lui faire dresser les cheveux sur la tête !

Par contre je reste dans l’ignorance en ce qui concerne la barre typo..
- # ^ Le 1er décembre 2011 à 13:01, par Franck En réponse à : Créer un nouvel objet éditorial
  
  Bonjour Bernard,
  
  Je lis ce post et suis confronté au problème de l’upload de document et d’images pour un nouvel objet.
  Peux tu m’en dire plus sur la solution que tu as trouvé, ou m’indiquer des pistes de recherche ?
  
  Cordialement
Répondre à ce message
# Le 26 octobre 2009 à 09:04, par Matthieu Marcillaud En réponse à : Créer un nouvel objet éditorial

Je ne sais pas trop ce que tu entend par « rien afficher ». Pour que le pipeline de boite_infos affiche quelque chose, il faut que le fichier prive/infos/$type.html existe.
- # ^ Le 30 mars 2010 à 15:58, par Samuel En réponse à : Créer un nouvel objet éditorial
  
  Bonjour,
  
  Je confirme, le pipeline boite_infos n’affiche rien, dans le prive_spip.log, on trouve ’Erreur - ’f_boite_infos’ non definie !’.
  
  J’ai beau chercher, je ne trouve pas. Quelqu’un peut-il m’aider ?
- # ^ Le 30 mars 2010 à 20:13, par Matthieu Marcillaud En réponse à : Créer un nouvel objet éditorial
  C’est assez étrange... on dirait qu’il manque l’inclusion ’inc/presentation’.
  
  Tester avant le pipeline un vilain :
  
  [(#VAL{inc/presentation}|include_spip|oui)]
- # ^ Le 1er juillet 2011 à 10:57, par Fred En réponse à : Créer un nouvel objet éditorial
  
  Oui, ça marche en faisant ainsi.
Répondre à ce message
# Le 16 avril 2010 à 10:43, par Cyril En réponse à : Créer un nouvel objet éditorial
Bonjour, et un grand merci pour cet article !

Je rencontre un bug sur le plugin chats lors de la soumission du formulaire d’ajout/modification : la vérification des champs s’effectue bien, cependant les erreurs ne sont pas affichées lors de la première soumission du formulaire !

Procédure pour reproduire le bug :

Je me rend sur le formulaire de création d’un chat.
J’oublie volontairement de renseigner le champs obligatoire "Nom"
Je suis bien redirigé à nouveau sur le formulaire de modification, mais aucun message ne m’indique que j’ai oublié un champs obligatoire.
J’oublie encore une fois de remplir le champs "Nom", et je soumets le formulaire.
A nouveau, je suis redirigé sur le formulaire de modification, mais cette fois j’ai bien un message explicatif (’Cette information est obligatoire’) au dessus du champs "Nom" !

Après avoir farfouillé, il semble que la fonction de vérification soit bien appelée, et les erreurs bien détectées, mais il doit y avoir un soucis de transmission des ces erreurs au formulaire : En affichant le contenu de #ENV sur la page du formulaire, le tableau erreurs est vide : s:7 :"erreurs" ;a:0 :

Je suis sous SPIP 2.1
Je ne parviens pas à comprendre d’où vient le problème. Avez-vous également rencontré ce soucis ?

Merci.
- # ^ Le 14 octobre 2010 à 16:49, par Samuel En réponse à : Créer un nouvel objet éditorial
  
  Bonjour,
  
  Le problème semble venir de la fonction formulaires_editer_objet_charger() dans ecrire/inc/editer.php, ici :
  
  // Gaffe : sans ceci, on ecrase systematiquement l’article d’origine
  // (et donc : pas de lien de traduction)
  
  $id = ($new OR $lier_trad)
  ? ’oui’
  : $row[$id_table_objet] ;
  $row[$id_table_objet] = $id ;
  
  Lors de la création d’un nouvel enregistrement, [(#SETid_machin,[(#VALid_machin|_request|sinonnew)])] fixe id_machin à new. Cependant, la fonction formulaires_editer_objet_charger() la change pour ’oui’. Au premier rechargement, [(#SETid_machin,[(#VALid_machin|_request|sinonnew)])] fixe donc id_machin à oui. Je pense donc qu’un bug (ou une sécurité, ou un bug de sécurité...) empêche le bon déroulement de la fonction formulaires_editer_objet_verifier() ou formulaires_editer_machin_verifier_dist() du fait qu’on ne retrouve pas le même id_machin entre la valeur de la variable d’environnement et celle au chargement du formulaire... Un truc du genre, je suis loin de maîtriser le truc...
  
  Bref, j’ai changé ’oui’ en ’new’, j’ai testé la création d’un article de traduction, ça n’a pas écrasé l’article d’origine, et le formulaire d’édition de "machins" fonctionne correctement....
  
  Si quelqu’un peut compléter ou rectifier mes dires...
- # ^ Le 13 mai 2011 à 18:35, par Z En réponse à : Créer un nouvel objet éditorial
  
  Bonjour Samuel,
  
  J’ai rencontré le même souci que toi, et suivi tes préco, en surchargeant le tableau $valeurs dans la fonction charger, après appel de formulaires_editer_objet_charger().
  
  Sur l’un de mes formulaires, cela a résolu le pb. Sur l’autre non. En fait, je me suis demandé s’il ne fallait surcharger toutes les valeurs mises à oui par la fonction dans ce tableau pour les passer à new, c’est à dire, l’id_machin mais aussi [_pipeline][1][id] et [_action][1]. Mais cela ne change rien. Il ya toujours besoin de soumettre 2 ou 3 fois le formulaire avant d’avoir un retour (et bien sûr, les valeurs saisies sont perdues tant qu’il n’y a pas eu de prise en charge par verifier). Ce qui est curieux, c’est que cela se produit sur tous les plugins, celui de Marcimat, celui que je suis en train de faire, etc... Et à côté de cela, le formulaire natif editer_auteur lui, fonctionne très bien. Et l’utilisation de ces CVT de nos plugins dans l’espace public ne pose aucun pb non plus, la réponse est immédiate. Donc bug/sécurité, je ne sais spas, mais pas top en tout cas....
Répondre à ce message
# Le 21 octobre 2009 à 12:11, par manuciel En réponse à : Créer un nouvel objet éditorial

Chapeau bas encore une fois !
Clair, concis et précis.

Pourquoi ne pas ajouter cet article dans programmer avec spip 2.0 ?

Emmanuel
- # ^ Le 29 avril 2011 à 14:14, par ? En réponse à : Créer un nouvel objet éditorial
  
  honnêtement ! j’ai passé tellement de temps à lire et relire l’article sur plugin de programmer avec spip 2 !
  Merci :)
Répondre à ce message
# Le 6 avril 2011 à 10:38, par P’tit Ben En réponse à : Créer un nouvel objet éditorial

Bonjour et merci pour ce tutoriel.

Je me demandais juste comment insérer dans l’objet "chat" la barre de gestion de date de spip présente dans les articles (pour donner sa date de naissance par exemple). Quelqu’un a une idée ?

Merci d’avance pour la réponse.

Répondre à ce message
# Le 10 février 2011 à 17:24, par Mojo En réponse à : Créer un nouvel objet éditorial

Bonjour, c’est encore le SPIP-Noob de service ^^
Est-il simple d’étendre la création d’un nouvel objet éditorial aux forums ?
Par exemple, pour permettre aux internautes de réagir sur une fiche Séjour après leur voyage.

Répondre à ce message
# Le 2 février 2011 à 16:56, par Mojo En réponse à : Créer un nouvel objet éditorial

Bonjour !
J’ai suivi cet excellent tuto pour développer sous SPIP 2.1 un plugin permettant d’ajouter un objet éditorial "séjours" (site de résas d’hébergements). Mais je me heurte à un problème lors de l’installation du plugin : aucune table n’est insérée dans la base. En fait, selon quelques spip_log() judicicieusement insérés, il semblerait que l’installation ne passe jamais dans le fichier précisé entre les balises du plugin.xml... Difficile dans ces conditions de faire quoi que ce soit ^^
Peut-être manque-t-il une précision importante à apporter sur ce tuto ?
Est-ce que le code d’install/upgrade de la base présenté ici est encore compatible SPIP 2.1 ?
Cordialement,
Mojo
- # ^ Le 2 février 2011 à 17:19, par marcimat En réponse à : Créer un nouvel objet éditorial
  
  A tout hasard, vous avez bien mis <version_base>1.0</version_base> dans plugin.xml ?
- # ^ Le 2 février 2011 à 17:27, par Mojo En réponse à : Créer un nouvel objet éditorial
  
  Oui oui.
  Mais ce qui me chagrine c’est qu’aucun de mes spip_log() insérés dans base/mon_plugin_upgrade.php ne remonte une seule ligne !
  Cela signifie qu’on n’appelle jamais ce fichier, mais aucune piste habituelle n’a donné de résultat (droits d’accès, mauvaise saisie des noms de fichiers...).
  Je commence à me demander s’il ne manque pas une inclusion en en-tête, ou si la v2.1 ne demande pas une spécif particulière.
- # ^ Le 2 février 2011 à 17:30, par marcimat En réponse à : Créer un nouvel objet éditorial
  
  SPIP ne passe sur les pages d’upgrade QUE sur la page ?exec=admin_plugin.
- # ^ Le 2 février 2011 à 17:39, par Mojo En réponse à : Créer un nouvel objet éditorial
  
  Nous sommes bien d’accord ^^
  Justement, je passe mon temps à installer/désinstaller mon plugin depuis la page d’admin des plugins. SPIP me remonte tout guilleret un message d’installation réussie, mais la base n’est pas affectée. Et comme je le disais, rien de neuf dans spip.log pour m’aiguiller...
- # ^ Le 3 février 2011 à 10:26, par Mojo En réponse à : Créer un nouvel objet éditorial
  
  Une fois de plus, merci les logs !
  Il y avait une erreur infinitésimale dans mon fichier de définition de la table à créer (une mauvaise valeur par défaut sur un boolean), ce qui faisait planter la requête. Je peux enfin avancer ^^ Il me reste à régler un souci avec Champs Extra qui va s’avérer indispensable.
  Au temps pour moi ^^" J’aurai au moins appris comment fonctionne l’installation des plugins, huhuhu...
  Merci encore pour le travail remarquable que vous abattez et pour le temps passé à me répondre.
Répondre à ce message

0
10
20
30

Répondre à cet article

modération a priori

Attention, votre message n’apparaîtra qu’après avoir été relu et approuvé.

Qui êtes-vous ?

Nom
Veuillez laisser ce champ vide :
Courriel (non publié)

Pour afficher votre trombine avec votre message, enregistrez-la d'abord sur gravatar.com (gratuit et indolore) et n'oubliez pas d'indiquer votre adresse e-mail ici.

Ajoutez votre commentaire ici

Texte de votre message
Ce formulaire accepte les raccourcis SPIP [->url] {{gras}} {italique} <quote> <code> et le code HTML <q> <del> <ins>. Pour créer des paragraphes, laissez simplement des lignes vides.
Prévenez-moi de tous les nouveaux commentaires de cette discussion par email

Suivre les commentaires : |

Dans la même rubrique

Coup de pouce

Pour me maintenir en éveil et en pleine forme physique et mentale, vous pouvez me faire le cadeau d'un jus de fruit pressé.

En plus de m'hydrater, de m'offrir une alimentation saine crudivore et frugivore, cela peut aussi participer aux frais de gestion du serveur que je gère et qui héberge quelques sites relatifs à SPIP. Cela peut aussi me motiver à produire d'autres documentations ou peut-être à prendre des vacances ! :)

Vous pouvez également me « Flattrer » si vous utilisez le service en ligne très malin Flattr de microdonations qui permet d'allouer un budget mensuel à des créateurs de contenu. Votre budget est partagé chaque mois entre toutes les personnes que vous avez flattées ce mois là.