<?php
/***************************************************************************
- * Copyright (C) 2003-2007 Polytechnique.org *
+ * Copyright (C) 2003-2010 Polytechnique.org *
* http://opensource.polytechnique.org/ *
* *
* This program is free software; you can redistribute it and/or modify *
* 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA *
***************************************************************************/
-class PLModule
+abstract class PLModule
{
- function handlers() { die("implement me"); }
+ /** Path of the includes of the module
+ * Internal use only.
+ */
+ private $modIncludePath;
- function make_hook($fun, $auth, $perms = '', $type = DO_AUTH)
+ /** Return an array associating pathes to the corresponding hook.
+ * array( '/my/path' => make_hook(...),
+ * ...);
+ * @ref make_hook
+ */
+ abstract public function handlers();
+
+ /** Register a hook
+ * @param fun name of the handler (the exact name will be handler_$fun)
+ * @param auth authentification level of needed to run this handler
+ * @param perms permission required to run this handler
+ * @param type additionnal flags
+ *
+ * Perms syntax is the following:
+ * perms = rights(,rights)*
+ * rights = right(:right)*
+ * right is an atomic right permission (like 'admin', 'user', 'groupadmin', 'groupmember'...)
+ *
+ * If type is set to NO_AUTH, the system will return 403 instead of asking auth data
+ * this is useful for Ajax handler
+ * If type is not set to NO_SKIN, the system will consider redirecting the user to https
+ */
+ public function make_hook($fun, $auth, $perms = 'user', $type = DO_AUTH)
{
return array('hook' => array($this, 'handler_'.$fun),
'auth' => $auth,
'type' => $type);
}
+ /** Include a 'module-specific' file.
+ * Module specific includes must be in the in the path modules/{modulename}.
+ */
+ public function load($file)
+ {
+ require_once $this->modIncludePath . $file;
+ }
+
/* static functions */
+ public static function path($modname)
+ {
+ global $globals;
+ if ($modname == 'core') {
+ $mod_path = $globals->spoolroot . '/core/modules/' . $modname;
+ } else {
+ $mod_path = $globals->spoolroot . '/modules/' . $modname;
+ }
+ return $mod_path;
+ }
+
public static function factory($modname)
{
- $mod_path = dirname(__FILE__).'/../modules/'.strtolower($modname).'.php';
- $class = ucfirst($modname).'Module';
+ $mod_path = self::path($modname);
+ $class = ucfirst($modname) . 'Module';
- require_once $mod_path;
- return new $class();
+ require_once $mod_path . '.php';
+ $module = new $class();
+ $module->modIncludePath = $mod_path . '/';
+ return $module;
}
}