API CFG : #CONFIG, lire_config(), ecrire_config(), effacer_config()

CFG fournit pour les scripts php 3 fonctions pour manipuler les données comme le ferait un formulaire CFG.

CFG fournit pour les scripts php 3 fonctions pour manipuler les données comme le ferait un formulaire CFG, en plus de la balise #CONFIG.

Ces fonctions sont lire_config(), ecrire_config() et effacer_config().

#CONFIG

Cette balise SPIP est étendue par CFG pour lire aussi les informations stockées depuis celui-ci. Elle permet d’extraire des informations d’un dépot (meta, metapack, tablepack, table ou php).

Cette balise admet 2 arguments, le lieu/adresse de la chaine à lire, et la valeur par défaut si cette dernière est vide.

Dépot meta

  • #CONFIG{meta::descriptif_site} : affiche le descriptif du site
  • #CONFIG{meta::entree_serialisee} : affiche la chaine sérialisée (la sérialisation, généralement faite par CFG, permet de stocker plusieurs informations dans une seule méta de SPIP)

Dépot metapack
CFG, par défaut, stocke les informations avec le dépot ’metapack’ qui sérialise les champs du formulaire CFG dans une seule méta de SPIP. Les informations lue avec ce dépot sont déserialisée et peuvent donc retourner dans certains cas des tableaux php.

  • #CONFIG{metapack::descriptif_site} : sera vide car ’descriptif_site’ est une chaine non serialisée
  • #CONFIG{metapack::entree_serialisee} : retournera la valeur désérialisée. Si c’est un tableau, celui-ci sera donc retourné.
  • #CONFIG{metapack::nom/champ} : retournera la valeur du champ stocké dans la meta ’nom’.
  • #CONFIG{metapack::nom/casier/champ} : retournera la valeur du champ stocké dans la meta ’nom’ rangée dans le dossier ’casier’.

Dépot tablepack
permet de récupérer des informations sérialisées dans une colonne d’une table SPIP, telle que la colonne ’extra’ :

  • #CONFIG{tablepack::auteur:3/nom/champ} : récupère la valeur de ’nom/champ’ dans la colonne ’cfg’ de la table spip_auteurs (id_auteur=3) (/ !\ cette colonne par défaut est encore en discussion)
  • #CONFIG{tablepack::rubrique@extra:5/nom/champ} : récupère la valeur de ’nom/champ’ dans la colonne ’extra’ de la table spip_rubriques (id_rubrique = 5)
  • #CONFIG{tablepack::~13/nom/champ} : pour histoire, cela sélectionne la table ’spip_auteurs’ avec id_auteur=13.

Dépot php
récupère des informations stockés par CFG dans un fichier php :

  • #CONFIG{php::nom} : récupère le tableau ’nom’ (stocké dans /local/cfg/nom.php)(A voir s’il ne serait pas mieux dans /tmp, non accessible)
  • #CONFIG{php::nom/champ} : récupère la valeur de ’nom/champ’
  • #CONFIG{php::adresse/fichier.php:nom/champ} : récupère la valeur de ’nom/champ’ d’un fichier dont l’adresse est indiquée.

Raccourcis
Si le nom du dépot n’est pas passé à la balise #CONFIG, voilà ce qui se passe :

  • #CONFIG{nom} : lecture avec le depot ’meta’
  • #CONFIG{nom/} : (présence d’un /) lecture avec le depot ’metapack’ (sera donc déserialisé et pourra retourner un tableau). Une syntaxe utile peut être [(#ID_RUBRIQUE|in_array{#CONFIG{nom/,#ARRAY}})]
  • #CONFIG{nom,'',''} : pour histoire, déserialise ’nom’, comme l’écriture ci-dessus
  • #CONFIG{table:id/} : lecture avec ’tablepack’
  • #CONFIG{~id_auteur/} : lecture avec ’tablepack’

lire_config()

Cette fonction est identique à la balise #CONFIG étendue par CFG. Elle lit la donnée demandée. Si le nom du dépot n’est pas donné (depot: :), ce sont les mêmes raccourcis que la balise #CONFIG qui s’appliquent... à une exception historique près : si lire_config('nom') peut être déserialisée, elle le sera.

  • lire_config($chemin='', $defaut=null);
  • $chemin : le chemin comme celui de #CONFIG,
  • $defaut : une valeur par défaut éventuelle

Lire le descriptif du site :

$c = lire_config('descriptif_site');

Lire une donnée sérialisée dans spip_meta :

$c = lire_config('nom/casier/mon_champ');

Cette commande lira la valeur de ’nom_champ’ (on peut l’imaginer comme un tableau $meta['nom']['casier']['mon_champ'])

Pour que la valeur demandée existe, il faut soit l’avoir créé avec ecrire_config('nom/casier/mon_champ', $valeur) ou avec
un formulaire CFG en utilisant les paramètres :

<!-- nom=nom -->
<!-- casier=casier -->

Lire la colonne extra d’un auteur :

$c = lire_config('~id_auteur/dossier/champ');
$c = lire_config('auteur:8/dossier/champ');

C’est la colonne extra qui est lue par défaut.
Ce comportement est susceptible d’évoluer (utilisation d’une colonne ’cfg’ ?)

Lire une colonne quelconque (ici, ’prefs’) d’une table :

$c = lire_config('auteur@prefs:8/champ');
$c = lire_config('spip_auteurs@prefs:8/champ'); // equivalent

ecrire_config()

Introduit en version 1.2 de CFG, cette fonction permet d’écrire une configuration.

  • ecrire_config($chemin, $valeur);
  • $chemin : le chemin comme celui de la fonction lire_config(),
  • $valeur : la valeur à écrire. Peut être un tableau de valeurs.

change le descriptif du site !

ecrire_config('meta::descriptif_site', 'mon descriptif');

stocker une meta de spip_meta !

ecrire_config('prefixe/champ', 'valeur');
ecrire_config('prefixe/dossier/champ', 'valeur');
ecrire_config('prefixe/dossier', array(...) ); // pleins de valeurs d'un coup

stocker un extra d’auteur :

ecrire_config('~id_auteur/champ', 'valeur');

stocker une colonne ’extra’ de rubrique :

ecrire_config('rubrique@extra:4/dossier/champ', 'valeur');

effacer_config()

Introduit en version 1.2 de CFG, cette fonction permet d’effacer une configuration.

  • effacer_config($chemin);
  • $chemin : le chemin comme celui de la fonction lire_config() ou ecrire_config().

Exemples :

effacer_config('prefixe/dossier');
effacer_config('~id_auteur/champ');

Discussion

5 discussions

  • 2

    bonjour,
    d’abord j’ai pas su où vraiment poster ma question, il y a je crois plusieurs fonctions en jeu

    je voudrais insérer un lire_config dans mon fichier cfg, et si « oui » insérer un javascript dans head
    alors pour mon premier test j’ai mis ça dans mon fichier cfg :
    <input type="radio" name="redirection" value="oui" [ checked="(#ENV{redirection}|=={oui}|?{checked})"]/>

    et dans un pipeline j’ai mis ça mais évidemment ça va pas :
    Parse error : syntax error, unexpected T_STRING in /mnt/165/sdb/3/9/scozzi/spip_2.1.10/plugins/itwx_mobile_3_00_christ/itwx_pipeline.php on line 10

    <?php
    function itwx_mobile_redirection($flux)
    {
    		$redirection = lire_config('itwx/redirection') ;
    		switch ($redirection) 
    		{
    			case 'oui':
    				$flux .= '<script language=javascript>
    var redirectagent = navigator.userAgent.toLowerCase();
    var redirect_devices = ['vnd.wap.xhtml+xml', 'wap1', 'wap2'];
    for (var i in redirect_devices) {
    if (redirectagent.indexOf(redirect_devices[i]) != -1) {
     
    		var question = confirm("Souhaitez-vous naviguer sur le site optimisé pour Mobile?")
    		if (question)
    		{window.location = "#URL_PAGE{mob_sommaire}";	}
     
    }
    };
    var redirectagent = navigator.userAgent.toLowerCase();
    var redirect_devices = ['sony', 'symbian', 'nokia', 'samsung', 'mobile', 'windows ce', 'epoc', 'opera mini', 'nitro', 'j2me', 'midp-', 'cldc-', 'netfront', 'mot', 'up.browser', 'up.link', 'audiovox', 'blackberry', 'ericsson', 'panasonic', 'philips', 'sanyo', 'sharp', 'sie-', 'portalmmm', 'blazer', 'avantgo', 'danger', 'palm', 'series60', 'palmsource', 'pocketpc', 'smartphone', 'rover', 'ipaq', 'au-mic', 'alcatel', 'ericy', 'vodafone', 'teleca', 'playstation', 'lge', 'lg-', 'iphone', 'android', 'htc', 'dream', 'webos', 'bolt', 'nintendo'];
    for (var i in redirect_devices) {
    if (redirectagent.indexOf(redirect_devices[i]) != -1) {
    location.replace("#URL_PAGE{smart_sommaire}");
    }
    }
     
    </script>';
    				break ;
    		}
    	return $flux;	
    }
    ?>

    je reconnais que je ne sais pas encore trop ce que je fais en prog :/

    y a-t-il d’autres solutions ou celle-ci est-elle bonne mais où comment corriger ?

    • pfff j’avais oublié de charger les modifs du cfg, maintenant je n’ai plus l’erreur.

      mais bon, activée, la redir ne fonctionne pas.

      une idée ?

    • Un mauvais mélange de ’ dans le source javascript.

    Répondre à ce message

  • Merci pour ta réponse ultra rapide. Le répertoire IMG me parait bien dans la mesure notamment ou le répertoire n’est jamais purgé. Une fois la modif effectué peux tu me signaler sur le forum comme ca je récupérer la dernière version de CFG sur la zone ?

    Merci bien en tout les cas pour ta réponse.

    Répondre à ce message

  • 1

    Bonjour , et merci bien pour cet excellent article et pour le plugin. Je viens de terminer un plugin qui utilise CFG avec un dépot php . Tout fonctionne correctement, et dans le répertoire local se créer un répertoire cfg (local/cfg) à l’intérieur duquel sont stockes mais variables sous forme de tableau PHP. Jusque là tout est impeccable , par contre quand je vais dans l’admin et que je vide le cache ’ ?exec=admin_vider’ cela supprime mes fichiers !!!!

    Y a t il un moyen pour éviter cela ?

    Merci d’avance !!!!

    • Matthieu Marcillaud

      Ah la blague… j’ai pas pensé à ça…
      pom pom pom…

      Faut réfléchir alors pour le sauver ailleurs, mais « tmp » n’a pas un nom qui incite à stocker dedans non plus… grml de grml…

      Il faut certainement stocker dans IMG alors ? ça irait ?

    Répondre à ce message

  • S’lt

    Il pourrait être bon de rappeller qu’il ne faut pas oublier de faire :
            include_spip('inc/cfg_config'); pour accéder à l’api.

    Répondre à ce message

  • 3

    Salut Marcimat,

    Je suis en train de jouer avec #CONFIG & ecrire_config() et je n’arrive pas à écrire "non" dans la méta « activer_breves ».

    Tous mes tests se soldent par des échecs.

    #CONFIG{meta::activer_breves}
    #CONFIG{meta::descriptif_site}
    <?php
    ecrire_config('meta::activer_breves', 'non');
    ecrire_config('meta::descriptif_site', 'mon descriptif');
    ?>
    #CONFIG{meta::descriptif_site}
    #CONFIG{meta::activer_breves}

    Je n’arrive pas à écraser les métas il me semble, même l’écriture de la méta descriptif_site ne semble pas fonctionner.

    Ceci marche :

    ecrire_config('activer_breves', 'non');

    Mais malheureusement le NON est stocké sous forme sérialisé :

    s:3 :"oui" ;

    ce qui rend cette config inopérante pour spip.

    Tests réalisés sur un SPIP 1.9.3 SVN [11346] en prod, avec cfg 1.3.8 [19338], le code étant contenu dans une page de cfg « ?exec=cfg&cfg=blip3_autoconf »

    Intérêt de la manipulation que je veux faire ?

    Pouvoir proposer une page qui modifie la configuration d’un site sous SPIP et l’adapte au squelette par exemple (désactiver les brèves, activer ceci, modifier cela ... etc).

    Le tout étant bien entendu fairplay, on explique avant les modifications qui vont être réalisées ...

    • met la version 1.7.1 (the last one) et on en rediscute après s’il te plait...

    • Pan sur le bec ... ;-D

      Bon ben je vais me cacher au fond de mon trou, je croyais sincèrement avoir une version très récente de cfg ...

      ça marche nickel maintenant.

      Merci.

    • Cependant, tu as d’origine dans SPIP plus simple pour faire ce que tu veux, si ça ne concerne que les métas de spip :

      <?php
      include_spip('inc/meta');
      ecrire_meta('activer_breves','non');
      lire_metas();
      ?>

      MM.

    Répondre à ce message

Ajouter un commentaire

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

Dernière modification de cette page le 24 août 2008