Champs Extras — API et créations

Publié le : 22 mars 2012 – Dernière modification le 13 janvier 2022 – par Matthieu Marcillaud – 88 commentaires

1
2
3
4
5
28 votes

Dans ce document vous trouverez expliquées les API disponibles dans le plugin « Champs Extras » ainsi que les manières de les utiliser pour créer un plugin ajoutant des champs extras (via ces API donc).

Le plugin « Champs Extras Interface », entre autres, s’appuie sur ces API et offre une interface graphique pour gérer ces champs.

La documentation est valable à partir de la version 3.0.0 du plugin.

API d’autorisation / restrictions des champs extras

Comme dans la version précédente, il est possible de restreindre l’usage de champs extras à certains secteurs ou rubriques. La fonction d’API restreindre_extras est identique, cependant, les noms des fonctions d’autorisations sous-jacentes ont, eux, évolué.

La fonction restreindre_extras facilite les restrictions des champs, c’est à dire des restrictions d’affichages définies en fonction de la rubrique à laquelle ces champs appartiennent. Ces fonctions sont à placer dans le fichier squelettes/mes_fonctions.php. Leur rôle est de créer « à la volée » les fonctions d’autorisations adéquates (elles sont décrites plus loin).

Pour leur bon fonctionnement, il est nécessaire de charger la librairie inc/cextras_autoriser.

Les arguments de cette fonction sont :

  1. objet incriminé (article, rubrique, mot, site...)
  2. nom du/des champ(s) extras
  3. identifiants de restriction (par défaut des rubriques)
  4. cible (par défaut ’rubrique’, mais peut aussi être ’secteur’ ou ’groupe’)
  5. recursif (false par défaut) (applique t-on aux éléments enfants ?)

Un exemple de fichier d’autorisation et diverses autorisations :

<?php
include_spip('inc/cextras_autoriser');

// restreindre le champ 'gamma' des articles, sur la rubrique 2
restreindre_extras('article', 'gamma', 2);
// restreindre le champ 'alpha' et 'beta' des articles, sur les rubriques 2 et 3
restreindre_extras('article', array('alpha', 'beta'), array(2, 3));
// restreindre le champ 'iota' des rubriques, sur la rubrique 37
restreindre_extras('rubrique', 'iota', 37);
// restreindre le champ 'iota' des rubriques, sur la rubrique 37 et ses sous rubriques
restreindre_extras('rubrique', 'iota', 37, 'rubrique', true);
// restreindre les champs 'alpha' et 'beta' des articles, sur les rubriques 37 et 38 et leurs enfants
restreindre_extras('article', array('alpha', 'beta'), array(37, 38), 'rubrique', true);
// lorsqu'on veut appliquer sur un secteur, préférer 'secteur' plutôt que rubriques récursives. Pour restreindre au secteur 2 :
 restreindre_extras('article', 'beta', 2, 'secteur');

?>

Un argument supplémentaire permet donc de définir la fonction qui fera la recherche de validité, et vaut par défaut ’rubrique’, ce qui charge la fonction inc_restreindre_extras_objet_sur_{rubrique}_dist. Le plugin supporte aussi secteur et groupemot :

// restreindre les champs 'motin' et 'moteur' des mots, sur le groupe 2
restreindre_extras('mot', array('motin',  'moteur'), 3, 'groupemot');

Depuis la version 3.3.0, il est aussi possible de restreindre les champs extras en fonction de la composition de l’objet, ex :

// restreindre le champ 'loisirs' sur les articles qui portent la composition 'cv'
restreindre_extras('article', 'loisirs', 'cv', 'composition');

Depuis la version 3.7.0, il est aussi possible de restreindre les champs extras en fonction d’un mot clé lié à l’objet, ex :

// restreindre le champ 'loisirs' sur les articles qui portent un des mots clés n°9 ou 10
restreindre_extras('article', 'loisirs', array(9, 10), 'mot');

Notes :

  • Par souci d’optimisation (moins de requêtes SQL), il est préférable de regrouper en un seul appel au lieu de plusieurs lorsque c’est possible,
  • Il n’est pas possible de définir deux restrictions différentes pour un même champ extra. 
    // impossible (seul le 1er est pris en compte) :
restreindre_extras('article', 'c1', 1);
restreindre_extras('article', 'c1', 2);
// Utiliser :
restreindre_extras('article', 'c1', array(1, 2));

// Mais grouper les champs dés que c'est possible (mêmes identifiants d'application). Si :
restreindre_extras('article', 'c1', array(1, 2));
restreindre_extras('article', 'c2', array(1, 2));
// Préférer :
restreindre_extras('article', array('c1', 'c2'), array(1, 2));

Fonctions d’autorisations précises

Certains cas sont bien plus complexes et peuvent nécessiter que vous créiez vous-même les fonctions d’autorisations avec leurs actions qui vont bien. Ces fonctions doivent être nommées (le _dist n’est pas obligatoire) :

  • autoriser_{objet}_voirextra_{champ}_dist
  • autoriser_{objet}_modifierextra_{champ}_dist

Cela peut donner une fonction (table auteurs, champ prenom) :

  • autoriser_auteur_voirextra_prenom_dist
  • autoriser_auteur_modifierextra_prenom_dist

Un exemple de code simple pourrait être :

// seuls les rédacteurs et admins peuvent voir
function autoriser_auteur_voirextra_prenom_dist($faire, $type, $id, $qui, $opt) {
    return in_array($qui['statut'], array('0minirezo', '1comite'));
}
// seuls les admins peuvent modifier
function autoriser_auteur_modifierextra_prenom_dist($faire, $type, $id, $qui, $opt) {
    return in_array($qui['statut'], array('0minirezo'));
}

Voici un autre exemple plus complet qui teste si un article a une certaine composition, la composition « carte », pour afficher ou non des champs extras :

/* AUTORISATIONS */
function grainepc_objet_est_carto($objet, $id) {
	$compo = compositions_determiner($objet, $id);
	return ($compo == 'carte');
}

// autorisations des champs extras de carte ...
foreach (array(
	'declinaison',
	'structure',
	'affichage',
	'date_creation',
	'coordonnees',
	'presentation',
	'infos') as $nom)
{
	$m = "autoriser_article_modifierextra_" . $nom . "_dist";
	$v = "autoriser_article_voirextra_" . $nom . "_dist";

	$code = "
		if (!function_exists('$m')) {
			function $m(\$faire, \$type, \$id, \$qui, \$opt) {
				return grainepc_objet_est_carto(\$type, \$id);
			}
		}
		if (!function_exists('$v')) {
			function $v(\$faire, \$type, \$id, \$qui, \$opt) {
				return grainepc_objet_est_carto(\$type, \$id);
			}
		}
	";

	# var_dump($code);
	eval($code);
}

Créer un plugin en utilisant les API de Champs Extras

Vous le savez, le plugin « Champs Extras Interfaces » s’appuie sur une API de Champs Extras pour proposer une gestion graphique des champs. Cependant, des plugins peuvent aussi s’appuyer sur cette API afin de décharger sur le plugin champs extras la gestion de l’affichage, de la vérification et le traitement de nouveaux champs. Il n’y a rien d’obligatoire à cette utilisation, vous pouvez très bien développer un plugin qui crée des nouveaux champs en base et les gère de lui-même en utilisant les pipelines fournis par SPIP. L’avantage ici, est que toutes les déclarations sont regroupées dans un seul pipeline, et que la procédure d’installation et de désinstallation est simplifiée. Voyons un exemple, l’extension de démonstration nommée « Titre court pour rubriques ».

Tout d’abord, il faut créer un paquet.xml présentant le plugin :

<paquet 
		prefix="titrecourt"
		categorie="outil"
		version="1.1.0"
		etat="stable"
		compatibilite="[3.0.0-beta;["
		logo=""
		schema="0.0.1"
>
	<nom>Titre Court pour Rubriques</nom>

	<auteur>Matthieu Marcillaud [->magraine.net]</auteur>
	<licence>GNU/GPL</licence>

	<necessite nom="cextras" compatibilite="[3.0.5;[" />

	<pipeline nom="declarer_champs_extras" inclure="base/titrecourt.php" />
</paquet>

On remarque l’indication de dépendance à « cextras » qui est, donc, le cœur de Champs Extras, son API (« iextras » étant le plugin d’interface graphique), ainsi que l’appel d’un pipeline declarer_champs_extras.

Nous allons remplir le pipeline de notre nouveau champ « titrecourt » sur la table des rubriques. Pour cela, on crée le fichier base/titrecourt.php avec comme contenu :

<?php
if (!defined("_ECRIRE_INC_VERSION")) return;

function titrecourt_declarer_champs_extras($champs = array()) {
  $champs['spip_rubriques']['titre_court'] = array(
      'saisie' => 'input',//Type du champ (voir plugin Saisies)
      'options' => array(
            'nom' => 'titre_court', 
            'label' => _T('titrecourt:titre_court'), 
            'sql' => "varchar(30) NOT NULL DEFAULT ''",
            'defaut' => '',// Valeur par défaut
            'restrictions'=>array('voir' => array('auteur' => ''),//Tout le monde peut voir
                        'modifier' => array('auteur' => 'webmestre')),//Seuls les webmestres peuvent modifier
      ),
  );
  return $champs;	
}
?>

Observons. Le code remplit un tableau de description dans $champs['spip_rubriques']['titre_court']. Le principe est donc de remplir le tableau $champs avec une clé indiquant la table SQL, puis une clé indiquant la colonne SQL $champs[table][champ].

Le tableau de description est ensuite au format du plugin « Saisies » (puisque Champs Extras s’appuie dessus). On trouve cependant 6 options supplémentaires :

  • « nom » indique le nom le la colonne SQL désirée,
  • « sql » indique la ligne SQL correspondante,
  • « rechercher » (optionnel) permet d’indiquer si le champ doit être pris en compte dans les recherches. Vous pouvez renseigner la valeur true (la pondération appliquée par défaut est 2), ou toute valeur entière de pondération de recherche désirée, par exemple 5 ;
  • « versionner » (optionnel) permet d’indiquer si le champ peut être versionné lorsque les révisions sont activées (plugin révisions) sur l’objet éditorial sur lequel est ajouté le champs extras. true pour activer le versionnage ;
  • « restrictions » (optionnel) permet d’indiquer les restrictions appliquées automatiquement dans l’espace privé. On peut trouver dedans les options :
    • ’voir’ => array(’auteur’=>’’) // tout le monde peut voir (c’est l’action par défaut !)
    • ’voir’ => false // personne peut voir
    • ’modifier => array(’auteur’ => ’admin’) // seuls les admins.
    • ’modifier => array(’auteur’ => ’admin_complet’) // seuls les admins non restreints
    • ’modifier => array(’auteur’ => ’webmestre’) // seuls les webmestres.
    • ’secteur’ => ’3’ (restreint au secteur 3).
    • ’secteur’ => ’3:5:8’ (restreint au secteurs 3, 5 et 8).
    • ’branche’ => ’2’ (restreint à la branche 2...).
    • ’rubrique’ => ’1’.
    • ’groupe’ => ’4’.
  • « traitements », traitements typographiques à appliquer, soit une constante prédéfinie, soit un chaîne décrivant les fonctions à appliquer. Lire la documentation sur Programmer avec SPIP.

Notez que si ces restrictions ne sont pas suffisantes, vous pouvez créer comme on l’a vu plus haut les fonctions d’autorisations spécifiques à vos champs extras.

Le dernier fichier à créer gère l’installation et la désinstallation des champs. C’est dans notre exemple le fichier titrecourt_administrations.php et il contient le minimum syndical :

<?php
if (!defined("_ECRIRE_INC_VERSION")) return;

include_spip('inc/cextras');
include_spip('base/titrecourt');
	
function titrecourt_upgrade($nom_meta_base_version,$version_cible) {

  $maj = array();
  cextras_api_upgrade(titrecourt_declarer_champs_extras(), $maj['create']);	

  include_spip('base/upgrade');
  maj_plugin($nom_meta_base_version, $version_cible, $maj);

}

function titrecourt_vider_tables($nom_meta_base_version) {
  cextras_api_vider_tables(titrecourt_declarer_champs_extras());
  effacer_meta($nom_meta_base_version);
}
?>

On trouve les fonctions upgrade() et vider_tables() des plugins, qui appellent des fonctions cextras_api_upgrade() et cextras_api_vider_tables() avec le contenu de la fonction qui liste les champs que l’on crée, ici titrecourt_declarer_champs_extras().

Pour la fonction d’upgrade, on indique aussi où l’on souhaite créer les mises à jour, ici dans $maj['create'] qui est « à la création du plugin », mais cela aurait pu être appelé aussi lors d’une mise à jour (par exemple si vous avez ajouté un champ de plus).

$maj = array();
cextras_api_upgrade(titrecourt_declarer_champs_extras(), $maj['create']);
// mise à jour de la version 1.2 (nouveaux champs a créer)
cextras_api_upgrade(titrecourt_declarer_champs_extras(), $maj['1.2']);

Un autre exemple...

Voici un autre exemple plus complexe. C’était pour cet exemple que les autorisations par compositions avaient aussi été créées. Ici, plusieurs champs sont présents sur des tables différentes et plusieurs mises à jour sont faites.

Déclaration des champs

<?php

if (!defined("_ECRIRE_INC_VERSION")) return;

function grainepc_declarer_champs_extras($champs = array()){
    $champs['spip_auteurs']['telephone'] = array(
        'saisie' => 'input', // Type du champs (voir plugin Saisies)
        'options' => array(
            'nom' => 'telephone', 
            'label' => _T('grainepc:info_telephone'), 
            'sql' => "varchar(30) NOT NULL DEFAULT ''",
            'defaut' => '',// Valeur par défaut
        ));

    $champs['spip_articles']['declinaison'] = array(
        'saisie' => 'input', // Type du champs (voir plugin Saisies)
        'options' => array(
            'nom' => 'declinaison', 
            'label' => _T('grainepc:info_declinaison'), 
            'sql' => "text DEFAULT '' NOT NULL",
            'defaut' => '',// Valeur par défaut
            'traitements' => '_TRAITEMENT_TYPO',
        ));

    $champs['spip_articles']['structure'] = array(
        'saisie' => 'radio', // Type du champs (voir plugin Saisies)
        'options' => array(
            'nom' => 'structure', 
            'label' => _T('grainepc:info_type_structure'), 
            'sql' => "varchar(30) NOT NULL DEFAULT ''",
            'defaut' => '',// Valeur par défaut
            'datas' => array(
                '' =>  _T('grainepc:info_rien'), 
                'structure' =>  _T('grainepc:info_structure'), 
                'structure_adherente' =>  _T('grainepc:info_structure_adherente'), 
            ),
        ));


    $champs['spip_articles']['affichage'] = array(
        'saisie' => 'radio', // Type du champs (voir plugin Saisies)
        'options' => array(
            'nom' => 'affichage', 
            'label' => _T('grainepc:info_affichage'), 
            'sql' => "varchar(30) NOT NULL DEFAULT 'complet'",
            'defaut' => 'complet',// Valeur par défaut
            'datas' => array(
                'complet' =>  _T('grainepc:info_complet'), 
                'reduit' =>  _T('grainepc:info_reduit'), 
            ),
        ));
        
    $champs['spip_articles']['date_creation'] = array(
        'saisie' => 'date', // Type du champs (voir plugin Saisies)
        'options' => array(
            'nom' => 'date_creation', 
            'label' => _T('grainepc:info_date_creation'), 
            'sql' => "datetime DEFAULT '0000-00-00 00:00:00' NOT NULL",
            'defaut' => '0000-00-00 00:00:00',// Valeur par défaut
        ),
        'verifier' => array(
            'type' => 'date',
            'options' => array(
                'normaliser' => 'datetime',
            )
        ));

    $champs['spip_articles']['coordonnees'] = array(
        'saisie' => 'textarea', // Type du champs (voir plugin Saisies)
        'options' => array(
            'nom' => 'coordonnees', 
            'label' => _T('grainepc:info_coordonnees'), 
            'sql' => "text DEFAULT '' NOT NULL",
            'defaut' => '',// Valeur par défaut
            'rows' => 4,
            'traitements' => '_TRAITEMENT_RACCOURCIS',
        ));

    $champs['spip_articles']['presentation'] = array(
        'saisie' => 'textarea', // Type du champs (voir plugin Saisies)
        'options' => array(
            'nom' => 'presentation', 
            'label' => _T('grainepc:info_presentation'), 
            'sql' => "text DEFAULT '' NOT NULL",
            'defaut' => '',// Valeur par défaut
            'rows' => 6,
            'traitements' => '_TRAITEMENT_RACCOURCIS',
        ));

    $champs['spip_articles']['infos'] = array(
        'saisie' => 'textarea', // Type du champs (voir plugin Saisies)
        'options' => array(
            'nom' => 'infos', 
            'label' => _T('grainepc:info_infos'), 
            'sql' => "text DEFAULT '' NOT NULL",
            'defaut' => '',// Valeur par défaut
            'rows' => 5,
            'traitements' => '_TRAITEMENT_RACCOURCIS',
        ));
        
    return $champs;    
}

?>

Installation

<?php

include_spip('inc/cextras');
include_spip('base/grainepc');

function grainepc_upgrade($nom_meta_base_version,$version_cible){
	$maj = array();

	cextras_api_upgrade(grainepc_declarer_champs_extras(), $maj['create']);
	cextras_api_upgrade(grainepc_declarer_champs_extras(), $maj['1.1.0']);
	cextras_api_upgrade(grainepc_declarer_champs_extras(), $maj['1.2.0']);
	$maj['1.2.0'][] = array('sql_alter',"TABLE spip_auteurs DROP type");
	cextras_api_upgrade(grainepc_declarer_champs_extras(), $maj['1.3.0']);
	
	include_spip('base/upgrade');
	maj_plugin($nom_meta_base_version, $version_cible, $maj);
}

function grainepc_vider_tables($nom_meta_base_version) {
	cextras_api_vider_tables(grainepc_declarer_champs_extras());
	effacer_meta($nom_meta_base_version);
}

?>

Un autre exemple... en utilisant un ou plusieurs fieldset pour séparer les nouveau champs ajoutés

Voici un autre exemple où les champs sont regroupés par fieldsets (suite à une question posée dans les forums de cet article).

Ici, l’ensemble des champs sont sur la même table, et sont regroupés en deux fieldsets différents numeros et adresse.

Déclaration des champs

<?php

if (!defined("_ECRIRE_INC_VERSION")) return;

function numadresse_declarer_champs_extras($champs = array()){

    $champs['spip_auteurs']['numeros'] = array(
        'saisie' => 'fieldset',//Type du champ (voir plugin Saisies)
        'options' => array(
            'nom' => "numeros",
            'label' => _T('numadresse:legend_numeros')
        ),
        'saisies' => array(
            'telephone' => array(
                'saisie' => 'input', // Type du champs (voir plugin Saisies)
                'options' => array(
                    'nom' => 'telephone', 
                    'label' => _T('numadresse:info_telephone'), 
                    'sql' => "varchar(30) NOT NULL DEFAULT ''",
                    'defaut' => '',// Valeur par défaut
                )),
            'fax' => array(
                'saisie' => 'input', // Type du champs (voir plugin Saisies)
                'options' => array(
                    'nom' => 'fax', 
                    'label' => _T('numadresse:info_fax'), 
                    'sql' => "varchar(30) NOT NULL DEFAULT ''",
                    'defaut' => '',// Valeur par défaut
                ))
        )
    );
    $champs['spip_auteurs']['adresse'] = array(
        'saisie' => 'fieldset',//Type du champ (voir plugin Saisies)
        'options' => array(
            'nom' => "adresse",
            'label' => _T('numadresse:legend_adresse')        
        ),
        'saisies' => array(
            'adresse' => array(
                'saisie' => 'input', // Type du champs (voir plugin Saisies)
                'options' => array(
                    'nom' => 'adresse', 
                    'label' => _T('numadresse:info_adresse'), 
                    'sql' => "text NOT NULL DEFAULT ''",
                    'defaut' => '',// Valeur par défaut
                )),
            'code_postal' => array(
                'saisie' => 'input', // Type du champs (voir plugin Saisies)
                'options' => array(
                    'nom' => 'code_postal', 
                    'label' => _T('numadresse:info_code_postal'), 
                    'sql' => "varchar(30) NOT NULL DEFAULT ''",
                    'defaut' => '',// Valeur par défaut
                ))
        )
    );

    return $champs;
}

?>

Pour l’installation de ces champs, faire comme l’exemple situé plus haut.

Les quatres nouveaux champs sont ainsi répartis dans deux fieldsets différents en bas du profil de l’auteur.

Discussion

5 ans 1 an 3 mois Sans limite
par date
Filtrer

35 discussions

  • ecreatures

    Bonjour

    J’ai un problème avec un bouton radio…il reprend sa valeur par défaut à chaque fois que j’ouvre un article pour l’editer…et je dois recliquer pour mettre ma valeur a chaque fois.
    — est ce que j’ai loupé quelque chose dans la config ou est ce que ce serait un bug avec la 3.2 ?

    Répondre à ce message

  • 1
    rostichep

    Bonjour

    J’ajoute un champ « Sélecteur d’article » et après dans mon squelettes je met quoi pour récupérer les titres, logo, url de mes articles sélectionnés. ?
    J’ai trouvé ce bout de code a force de chercher sur le web, mais ça m’affiche qu’un seul résultat.

    Merci de votre aide.

    <BOUCLE_a(ARTICLES){id_article=#SELECTEUR_ARTICLE_1|picker_selected{article}|table_valeur{0}}>
#LOGO_ARTICLE #TITRE
</BOUCLE_a>

    Répondre à ce message

  • placido

    Je poste ici 2 observations qui feront peut-être gagner du temps à certains.
    -  un champ de type date gère la définition SQL datetime 0000-00-00 00:00:00, mais pas date 0000-00-00. (Pas très grave, mais mieux vaut le savoir)
    -  un champ de type date doit obligatoirement comprendre la partie normalisation (tableau : vérifier), sinon enregistrement impossible.

    Champs extras 3.11.4

    Et toujours merci à Marcimat !

    Répondre à ce message

  • Ramina

    Bonjour,

    J’ai un Champs Extras constitué d’un bloc de texte supplémentaire dans Articles. Ma boucle (ARTICLES) fait paraitre ce bloc de texte dans les articles de toutes les rubriques. Or, je voudrais limiter la parution à certaines rubriques (ou le supprimer dans les autres, ce qui revient au même). Les techniques traditionnelles utilisées dans les boucles pour sélectionner des rubriques ou en exclure sont inopérantes.

    Je me tourne donc vers les solutions proposées ici et je mets un fichier mes_fonctions dans le squelette… et ça ne marche pas non plus !

    Voici le code :

    <?php
include_spip('inc/cextras_autoriser');
// restreindre le champ 'bloc_extra_site' des articles, sur la rubrique 5
restreindre_extras('article', 'bloc_extra_site', 5);
?>

    Merci de me donner une piste
    Ramina

    Répondre à ce message

  • Ruminez

    Bonjour,
    J’utilise cextra, l’interface graphique et inscriptions3.
    Lorsqu’un utilisateur s’inscrit, les champs sont bien récupérés sauf les « extras ». Cependant, en modification de fiche (utilisateur ou admin), tout se passe bien.
    Bien entendu, rien dans les logs d’erreur
    Y a-t-il quelque chose que j’ai loupé ?
    Merci pour votre aide

    Répondre à ce message

  • 4
    PRX

    bonjour,
    une remarque / erreur à l’upgrade de 3.0.19 à 3.1.1 : j’ai un message :

    « Fatal error : Call to undefined function cextras_declarer_tables_objets_sql() in /home/yanfoom/www/plugins/auto/cextras/v3.8.0/cextras_options.php on line 39 »

    j’ai fait recharger la page et ai une page de spip normale en 3.1.1.
    Je n’ai pas testé les fonctionnalités pour valider son fonctionnement.
    Peut-être une correction ?

    • Pierre KUHN

      Bonjour,

      les plugins était à jour avant l’upgrade de spip ?

    • PRX

      Bonjour, merci de votre réponse.
      ce plugin oui, MAIS un autre ne l’était PAS (un thème non disponible en 3.1) et a disparu du coup : est-ce cela ?

    • Pierre KUHN

      Bonjour,

      Logiquement non.
      Cache vider de spip pour corriger le problème ?

    • PRX

      bonjour - merci : votre plugin était mis à jour depuis fort longtemps avant la bascule - je n’avais pas vidé le cache avant la bascule en 3.1.1.
      J’ai rechargé la page (bouton du navigateur) et ai obtenu une page de spip normale en 3.1.1. Il n’y a à priori pas de conséquence ni de blocage bien que je n’aie pas utilisé les champs extra depuis.

    Répondre à ce message

  • 2
    Peetdu

    J’ai un petit soucis avec la restriction par rubrique. En elle même elle marche bien. Mais il y a un effet indésirable avec les boutons du menu de raccourcis (Créer un nouvel article, etc.).

    Lorsque le rédacteur est en page d’accueil du Back office et qu’il clique sur le raccourci rapide « Écrire un nouvel article », ne sachant pas alors dans quelle rubrique il va le créer, aucun des champs extras n’apparait dans formulaire d’édition article.

    Une solution serait de faire apparaître ces champs extra ad-hoc au moment ou le rédacteur à choisi sa rubrique. Est-ce possible ?

    P
    ps : cette solution m’a été suggérée par deux rédacteurs

    • Matthieu Marcillaud

      En l’état : non.
      Il faudrait recharger le formulaire à chaque changement de rubrique dans le sélecteur, et on risquerait de perdre des données déjà saisies.

      C’est un « problème » connu cependant.

      Pour info, les boutons d’actions rapide ont la rubrique indiquée si on se trouve, justement dans une rubrique. Le problème est donc plus visible lorsqu’on clique dessus depuis le sommaire par exemple.

    • Peetdu

      Ok. Merci pour ces éclaircissements.

    Répondre à ce message

  • 2
    cdg_spy

    Bonjour,

    J’ai suivi la partie « Créer un plugin en utilisant les API de champs extras ». Effectivement les champs sont bien créer en base sur les bonnes tables, mais ils ne sont pas d’offices gérés depuis le plugin Champs Extras (interface), et quand on clique sur le bouton « gérer ce champ » ils sont transformés en champs de type textarea => bloc de texte, même si on a par exemple spécifié 'saisie' => 'input' et également les options concernant la saisie/restriction ... passées dans le tableau $champs de ma fonction xx_declarer_champs_extras ne sont pas prise en comptes.

    Pour essayer de comprendre le fonctionnement de la création des champs : je suis allé voir le code de la fonction champs_extras_creer appelée par cextras_api_upgrade et d’après ce que j’ai compris du code, seule les données $saisie['options']['nom'] et $saisie['options']['sql'] sont utilisées.

    D’ou mes questions :

    1. Les informations passées dans le tableau $champs (options : saisie, restriction, verifier) sont-elles réellement prises en compte ? À quel moment ? Et sont-elles stockées quelques parts dans SPIP, puisqu’on ne peut pas le vérifier leurs configuration via le plugin Champs Extras (interface) ?
    2. La création de groupe de champs fieldset fonctionne-t-elle vraiment ? De mon côté et sauf erreur/incompréhension de ma part, j’ai l’impression que cela ne fonctionne pas.
    3. Y a-t-il un moyen de programmer la prise en compte des champs extras créé sur un plugin tiers par le plugin Champs Extras (interface).

    Merci pour votre aide

    • Matthieu Marcillaud

      Je crois qu’il y a en manque de clarté.

      L’API crée et gère les champs extras. C’est à dire que si l’on passe par l’API PHP, on ne passe pas par l’interface (ça n’a pas de sens).

      L’interface en fait gère une liste de champs qu’elle présente justement à l’API. Les 2 ne sont pas compatibles.

      Dit autrement : si un champ est déclaré à l’API par un plugin (actif) : les champs sont créés s’ils n’existaient pas, et gérés (on les voit dans les formulaires). L’interface n’a rien à faire (le plugin d’interface peut ne pas être actif même.

      Si l’on active le plugin d’interface, les champs gérés par l’API (des plugins actifs) ne sont pas présentés comme champs qui peuvent être « gérés »… vu qu’ils le sont déjà.

      Il y a cependant le cas où un plugin qui gérait des champs (via champs extras ou pas) n’est plus actif (et n’a pas supprimé les champs par une désinstallation). À ce moment là l’interface voit que ces champs sont présents mais qu’aucun plugin ne semble s’en servir (aucune déclaration) : l’interface propose de les gérer. Mais l’interface ne connait pas grand chose du champ à ce moment là ; à peine sa déclaration SQL. C’est pour cela que dans la plupart des cas, gérer ce type de champ crée par défaut une saisie ’textarea’ (sauf quelques exceptions).

      Donc, sur les points présentés :

      • 1. Normalement oui. Et à quel moment ; eh bien ça dépend de l’option en question. Et non elles ne sont pas stockées ailleurs que dans la déclaration d’API. Le plugin interfaces lui par contre stocke ses données dans la table spip_meta, par exemple dans "iextras_spip_articles" ou quelque chose comme ça.
      • 2. Je pense que oui. Et oui, seules des champs ayant une déclaration SQL sont créés. Normalement tous ces champs (même ceux déclarés dans des saisies/fieldsets) doivent se créer.
      • 3. Hum. Il faudrait préciser. En fait tu pourrais faire écrire des données qui conviennent dans une meta du plugin d’interface. Mais cela veut dire que du coup, ces champs pourraient être modifiés / supprimés depuis l’interface. Ce n’est souvent pas ce qui est souhaité pour un plugin, où l’on veut une liste de champs nouveaux, mais non supprimables.

      Note : la déclaration d’un fieldset doit s’apparenter un peu à ce code http://zone.spip.org/trac/spip-zone/browser/_plugins_/champs_extras/interface/trunk/inc/iextras.php#L184 dans la déclaration d’API, avec bien sûr la définition sql en plus et pas la même affectation au début !

      -  $flux[’data’][$nom] = saisies_inserer($flux[’data’][$nom], array(
      + $champs[’spip_articles’][’un_fieldset’] = array(

    • Matthieu Marcillaud

      Ah mais camille & kent1 avaient mis déjà un exemple de fieldset dans l’article. Je n’avais même pas vu.

    Répondre à ce message

  • 2
    Teddy Payet

    Bonjour,

    Comment fait-on pour créer un fieldset et les saisies associées ?
    Malgré mes tests, je n’arrive pas à créer en base mes champs extras pour articles...

    Je tourne en rond actuellement.

    • cam.lafit

      Ciao

      J’ai un début de solution :

          $champs['spip_articles']["fieldset_01"] = array(
        'saisie' => 'fieldset',//Type du champ (voir plugin Saisies)
        'options' => array(
            'nom' => 'fieldset_01',
            'label' => 'fieldset 01',
        ),
        'saisies' => array(
            $champs['spip_articles']['test'] = array(
                'saisie' => 'input',//Type du champ (voir plugin Saisies)
                'options' => array(
                    'nom' => 'test',
                    'label' => 'test',
                    'sql' => "varchar(30) NOT NULL DEFAULT ''",
                    'defaut' => '',// Valeur par défaut
                    'restrictions' => array(
                        'rubrique' => '3'
                    ),
                )
            ),
        );

      Dans ce cas de figure nous avons bien un fieldset contenant un champ test.
      Le truc c’est qu’il doublonne le champ test en raison de l’affectation à $champ

    • kent1

      Je viens de poster un exemple fonctionnel (© chez moi ça marche) avec des fieldset en bas de l’article si besoin

    Répondre à ce message

  • 4
    triton

    Bonsoir,
    je teste...
    Après avoir déclaré un certain nombre de champs extra a travers la fonction : function xx_declarer_champs_extras
    je constate que mes champs sont bien créés en base, qu’en plus le formulaire natif de l objet (ici auteur) permet d administrer ces nouveaux champs sans problème et sans une ligne de code. Du coup je suis content, très même...
    Par contre, je m’attendais, benoîtement sans doute, a ce que mes nouveaux champs extras soient également considérés comme tel par l’interface (champs_extras_edit&objet=auteur)
    et que je pourrais continuer à les modifier, déplacer, changer de type... comme les champs extras créés via l interface ? Mais je me trompe, une fois créés par la fonction declarer_champs_extras ces champs deviennent comme les champs natifs de l’objet, immodifiables par l interface, c’est bien ca ?
    Un grand merci pour ce magnifique plugin de plus...
    amicalement

    • Matthieu Marcillaud

      C’est bien cela.

      Pour changer du coup le type de champ, ou le nom de la colonne sql, il faut à la fois modifier le code de la fonction de déclaration, et éventuellement faire dans la fonction _upgrade du fichier d’administration du plugin une mise à jour du champ (sql_alter), dans le tableau souvent appelé $maj. Par exemple, là il y a $maj['create'] : http://zone.spip.org/trac/spip-zone/browser/_plugins_/champs_extras/extensions/titre_court_rubriques/trunk/titrecourt_administrations.php qui est rempli par la fonction cextras_api_upgrade. Il pourrait y avoir en plus quelque chose comme http://zone.spip.org/trac/spip-zone/browser/_plugins_/contacts_et_organisations/trunk/contacts_administrations.php#L34 , en pensant aussi à modifier le schema du paquet.xml, qui correspond au numéro de dernière mise à jour de la base par le plugin.

    • triton

      hum... du coup, je me demande si dans mon cas il ne vaut pas mieux étendre la table auteur via l api standard et ensuite demander au plugin champs extras de gerer les nouveaux champs de la table, parce que c’est quand même bien pratique de pouvoir modifier l’ordre des champs du formulaire, ajouter des class css, et surtout des fieldsets (via la fonction declarer_champs_extras, j ai l impression que ca doit être coton d insérer des fieldsets, pas fait pour de toute manière...)
      M’en vais réfléchir à tout ça en dormant...
      Merci bien pour la prompte réponse

    • triton

      Et si une fois créer les nouveaux champs avec sql_alter dans la partie installation d un plugin, on fait appel a la fonction : champs_extras_creer pour les transformer automatiquement en champs extra... c est une bonne pratique ou c est tout pourri ?
      Parce que le problème des champs extras a cliquer soi meme depuis l interface, c est que c est pas super portable...
      amicalement

    • kent1

      Je viens de mettre un exemple en bas de l’article avec des fieldsets si toujours besoin

    Répondre à ce message

Ajouter un commentaire

Avant de faire part d’un problème sur un plugin X, merci de lire ce qui suit :

  • Désactiver tous les plugins que vous ne voulez pas tester afin de vous assurer que le bug vient bien du plugin X. Cela vous évitera d’écrire sur le forum d’une contribution qui n’est finalement pas en cause.
  • Cherchez et notez les numéros de version de tout ce qui est en place au moment du test :
    • version de SPIP, en bas de la partie privée
    • version du plugin testé et des éventuels plugins nécessités
    • version de PHP (exec=info en partie privée)
    • version de MySQL / SQLite
  • Si votre problème concerne la partie publique de votre site, donnez une URL où le bug est visible, pour que les gens puissent voir par eux-mêmes.
  • En cas de page blanche, merci d’activer l’affichage des erreurs, et d’indiquer ensuite l’erreur qui apparaît.

Merci d’avance pour les personnes qui vous aideront !

Par ailleurs, n’oubliez pas que les contributeurs et contributrices ont une vie en dehors de SPIP.

Qui êtes-vous ?
[Se connecter]

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

Ce champ accepte les raccourcis SPIP {{gras}} {italique} -*liste [texte->url] <quote> <code> et le code HTML <q> <del> <ins>. Pour créer des paragraphes, laissez simplement des lignes vides.

Ajouter un document

Suivre les commentaires : RSS 2.0 | Atom