xref: /dokuwiki/inc/pluginutils.php (revision a46d0d658b98649869f6c9660e168af3940d7c30)

<?php
/**
 * Utilities for handling plugins
 *
 * @license    GPL 2 (http://www.gnu.org/licenses/gpl.html)
 * @author     Andreas Gohr <andi@splitbrain.org>
 */

/**
 * Returns a list of available plugins of given type
 *
 * @author Andreas Gohr <andi@splitbrain.org>
 */
function plugin_list($type){
  $plugins = array();
  if ($dh = opendir(DOKU_PLUGIN)) {
    while (false !== ($file = readdir($dh))) {
      if ($file == '.' || $file == '..') continue;
      if (is_file(DOKU_PLUGIN.$file)) continue;

      if (@file_exists(DOKU_PLUGIN.$file.'/'.$type.'.php')){
        $plugins[] = $file;
      }
    }
    closedir($dh);
  }
  return $plugins;
}

/**
 * Loads the given plugin and creates an object of it
 *
 * @author Andreas Gohr <andi@splitbrain.org>
 *
 * @param  $type string 	type of plugin to load
 * @param  $name string 	name of the plugin to load
 * @return object         the plugin object or null on failure
 */
function &plugin_load($type,$name){
  //we keep all loaded plugins available in global scope for reuse
  global $DOKU_PLUGINS;

	//plugin already loaded?
	if($DOKU_PLUGINS[$type][$name] != null){
		return $DOKU_PLUGINS[$type][$name];
	}

  //try to load the wanted plugin file
  if(!include_once(DOKU_PLUGIN.$name.'/'.$type.'.php')){
    return null;
  }

  //construct class and instanciate
  $class = $type.'_plugin_'.$name;
  $DOKU_PLUGINS[$type][$name] = new $class;
  return $DOKU_PLUGINS[$type][$name];
}