confmanager : gérer divers fichiers .conf

• Plugin pour gérer divers fichiers .conf
• Fournit Admin, Action, Remote
• Repository :

  • Source
  • Téléchargement

Recherchez et installez le plugin confmanager à l'aide du gestionnaire d'extensions.

Vous pouvez utiliser ConfManager avec votre propre plugin.

Le plugin ConfManager prend en charge différents types de fichiers de configuration décrits ci-dessous.

Pour ajouter la configuration, vous devez ajouter un composant d'action qui s'accroche à l'événement CONFMANAGER_CONFIGFILES_REGISTER.

Vous pouvez ajouter votre fichier de configuration au tableau $event→data.

L'exemple suivant montre l'utilisation du type de configuration ConfigManagerTwoLine.

<?php
 
class action_plugin_docsearch_confmanager extends DokuWiki_Action_Plugin {
 
    public function register(Doku_Event_Handler $controller) {
        $controller->register_hook('CONFMANAGER_CONFIGFILES_REGISTER', 'BEFORE',  $this, 'addConfigFile', array());
    }
 
    public function addConfigFile(Doku_Event $event, $params) {
        if (class_exists('ConfigManagerTwoLine')) {
            $config = new ConfigManagerTwoLine('My Config', 'Description of my plugin', DOKU_INC . 'path to my config');
            $event->data[] = $config;
        }
    }
}

Le ConfManager prend en charge certains formats de configuration utilisés par DokuWiki.

DokuWiki utilise le tableau global $config_cascade pour obtenir le chemin d'accès au fichier de configuration.

Les types de configuration suivants sont disponibles :

Le code suivant montre comment créer une instance de chaque type de configuration à partir du tableau ci-dessus.

Notations utilisées :

<name>

Nom de la configuration dans le tableau $config_cascade.

<image path>

Chemin à partir de DOKU_INC vers le dossier d'images.

<image extension>

Extension des images à utiliser. Les icônes utilisent png.

$scheme = new ConfigManagerSingleLineCoreConfig('<name>');
$acronyms = new ConfigManagerTwoLineCascadeConfig('<name>');
$mime = new ConfigManagerTwoLineLeftImageConfigCascade('<name>', '<image path>', '<image extension>');

Ces trois types de configuration ont tous les méthodes suivantes pour fournir des informations supplémentaires:

setName (string)

Le nom du fichier de configuration. Ceci est indiqué dans la liste déroulante et en titre.

setDescription (string)

Un texte de description pour expliquer le fichier de configuration. Le balisage DokuWiki est autorisé.

Le type de configuration ConfigManagerTwoLine stocke un tableau associatif comme la configuration des abréviations.

Le code suivant montre comment créer une instance du type de configuration ConfigManagerTwoLine.

Codes utilisés :

<Title> (string)

nom du fichier de configuration qui s'affiche dans la liste déroulante et en titre.

<Description> (string)

texte de description du fichier de configuration. Le balisage DokuWiki est autorisé.

<Config path> (string)

Chemin absolu vers le fichier de configuration. Si le fichier n'est pas présent, il sera créé.

$config = new ConfigManagerTwoLine('<Title>', '<Description>', '<Config path>');

Vous pouvez utiliser ce plugin pour éditer plusieurs fichiers *.conf depuis le répertoire conf via le menu d'administration de DokuWiki.

• (en) https://www.dokuwiki.org/plugin:confmanager

Basé sur « confmanager Plugin » par Dominik Eckelmann, Julian Heise, Michael Große.