inc/plugins.php

   1 <?php
   2
   3 /**
   4  * Base class plugins should extend. This defines the public, hopefully
   5  * somewhat static API plugins should be able to rely on.
   6  *
   7  * Plugins go to plugins/name/main.php and must contain a NamePlugin class.
   8  */
   9 class VGPlugin
  10 {
  11         /**
  12          * Actions, hooks and other things must be initialized/registered here.
  13          */
  14         function __construct() {
  15
  16         }
  17
  18         /**
  19          * Called when a registered action is triggered.
  20          */
  21         function action($action) {}
  22
  23         /**
  24          * Display the given template.
  25          */
  26         function display_template($template, $with_headers = true) {
  27                 if ($with_headers) {
  28                         require 'templates/header.php';
  29                 }
  30                 require "$template";
  31                 if ($with_headers) {
  32                         require 'templates/footer.php';
  33                 }
  34         }
  35
  36         /**
  37          * Display the given template.
  38          */
  39         function display_plugin_template($template, $with_headers = true) {
  40                 $name = 'plugins/'. $this->get_name() .'/templates/'. $template .'.php';
  41                 $this->display_template($name, $with_headers);
  42         }
  43
  44         /**
  45          * Return the name of this plugin, for example: "hello".
  46          */
  47         function get_name() {
  48                 $name = get_class($this);
  49                 return strtolower(str_replace('Plugin', '', $name));
  50         }
  51
  52         /**
  53          * Called when a registered hook is triggered.
  54          *
  55          * Hooks:
  56          * header - before closing the head tag
  57          * summary - add to summary page
  58          * page_start - after body is opened
  59          * footer - before closing the body tag
  60          * pagenav - $page['links'] can be modified to add more pagenav links, see templates/header.php
  61          */
  62         function hook($type) {}
  63
  64         /**
  65          * Can be used to output xhtml.
  66          */
  67         function output($xhtml) {
  68                 echo($xhtml);
  69         }
  70
  71         /**
  72          * Registers the given action for this plugin.
  73          */
  74         function register_action($action) {
  75                 self::$plugin_actions[$action] = $this;
  76         }
  77
  78         function register_hook($type) {
  79                 self::$plugin_hooks[$type][] = $this;
  80         }
  81
  82         // Static members + methods
  83
  84         public static $plugin_actions = array();
  85         public static $plugin_hooks = array();
  86
  87         /**
  88          * Call plugin hooks of given type.
  89          * @see VGPlugin::register_hook()
  90          */
  91         static function call_hooks($type) {
  92                 if (in_array($type, array_keys(self::$plugin_hooks))) {
  93                         foreach (self::$plugin_hooks[$type] as $class) {
  94                                 $class->hook($type);
  95                         }
  96                 }
  97         }
  98 }
  99