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          * Called when a registered hook is triggered.
  38          *
  39          * Hooks:
  40          * header - before closing the head tag
  41          * page_start - after body is opened
  42          * footer - before closing the body tag
  43          * pagenav - output() can be used to insert content into pagenav.
  44          */
  45         function hook($type) {}
  46
  47         /**
  48          * Can be used to output xhtml.
  49          */
  50         function output($xhtml) {
  51                 echo($xhtml);
  52         }
  53
  54         /**
  55          * Registers the given action for this plugin.
  56          */
  57         function register_action($action) {
  58                 self::$plugin_actions[$action] = $this;
  59         }
  60
  61         function register_hook($type) {
  62                 self::$plugin_hooks[$type][] = $this;
  63         }
  64
  65         // Static members + methods
  66
  67         public static $plugin_actions = array();
  68         public static $plugin_hooks = array();
  69
  70         /**
  71          * Call plugin hooks of given type.
  72          * @see VGPlugin::register_hook()
  73          */
  74         static function call_hooks($type) {
  75                 if (in_array($type, array_keys(self::$plugin_hooks))) {
  76                         foreach (self::$plugin_hooks[$type] as $class) {
  77                                 $class->hook($type);
  78                         }
  79                 }
  80         }
  81 }
  82