< návrat zpět

Konfigurační pluginy

Tyto pluginy slouží jako prostředek pro výpis a konfiguraci nainstalovaných rozšíření a sestávají z následujících položek:

Soubor info.php

Tento soubor obsahuje informace o pluginu a jeho struktura je následující:

<?php

return array(
    'name' => 'Název pluginu',
    'descr' => 'Popis pluginu, může obsahovat <em>HTML kód</em>.',
    'version' => '1.0',
    'author' => 'Jméno autora',
    'url' => 'http://example.com/',
    'actions' => array('config', 'uninstall'),
);

Klíč actions

Tento klíč musí obsahovat pole sestávající s identifikátorů akcí podporovaným tímto pluginem. Názvy můžou být jakékoliv, ale je doporučeno používát následující standartní identifikátory:

  • config - konfigurace
  • install - instalace
  • uninstall - deinstalace
  • info - informace
  • docs - dokumentace
  • check - kontrola
  • manage - správa

Soubor actions.php

Skript pro konfigurační akce definované v info.php.
Doporučená struktura je následující:

<?php

/* ----- kontrola jadra ----- */

if(!defined('_core')) die;

/* ----- akce ----- */

switch($action) {

    case 'config':
        $output .= 'Akce konfigurace';
        break;

    case 'docs':
        $output .= 'Akce dokumentace';
        break;

    // a tak dale..

}

Ve skriptu jsou dostupné následující proměnné:

  • $action - název akce
  • $plugin - název pluginu

Pro načítání a změnu konfiguračního souboru je možné použít tyto funkce:

  • $cfg = _pluginLoadConfig($plugin); - načíst konfiguraci (viz. dokumentace)
  • _pluginSaveConfig($plugin, $new_cfg); - uložit konfiguraci (viz. dokumentace)

Soubor config.php

Nepovinný konfigurační soubor (může se jmenovat jinak a může jich být více). Obsahuje php kód vracející například pole obsahující konfigurační hodnoty:

<?php

return array(
    'volba1' => 'Hodnota 1',
    'volba2' => 'Hodnota 2',
    // a tak dale...
);