-
Notifications
You must be signed in to change notification settings - Fork 61
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
PLUGINS, ACTIONS & FILTERS: This code allows you to add a 'plugin' in…
… the /plugins folder which will augment functionality provided by XOT. It allows you to create single file or folder style plugins (similar to Wordpress) which add functionality to various 'hook' points within the page. These hooks are by no means definitive and hopefully we can add lots more, however for filters to work in a better way some code will need re-written in order to pass 'content' through the filter before being used or echo-ed.. The current files should do nothing to an install. The example plugins are commented out - remove the 'REMOVE_THIS' text from the filenames in order to activate. The 'GCU Plugin' demonstrates some potentially useful functionality: It adds a banner at the top of the page (login and editor) It changes the <title> text It changes the "My Projects" text to "John's Projects" It adds text to Pod 1 It adds a title slide to data.xml on save The plugin_one plugin simply inserts HTML comments at action hook points throughout the page. Enable this by taking out REMOVE_THIS and then refresh the page and view the source to reveal it's result... git-svn-id: https://xerteonlinetoolkits.googlecode.com/svn/trunk@709 912cdd6b-5c7d-d5a7-a2ba-d0f0cdb91641
- Loading branch information
1 parent
ab92163
commit 8cfccee
Showing
6 changed files
with
1,080 additions
and
14 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,116 @@ | ||
| <?php | ||
|
|
||
| /** | ||
| * Action and Filter Plugins for Xerte by John Smith @ Glasgow Caledonian University | ||
| * | ||
| * First define some constants that we need | ||
| */ | ||
| define('D_S', DIRECTORY_SEPARATOR); | ||
| define('PLUGINS_PATH', dirname(__FILE__) . D_S . 'plugins'); | ||
|
|
||
|
|
||
| /** | ||
| * We will be absorbing the Wordpress plugins.php code | ||
| * Wordpress 'plugins.php' has been renamed 'wp_plugins.php' to identify Wordpress codebase | ||
| */ | ||
| require_once(dirname(__FILE__) . D_S . 'website_code' . D_S . 'php' . D_S . 'wp_plugins.php'); | ||
|
|
||
|
|
||
| /** | ||
| * Traverse the /plugins folder, if available and include any plugins that are found | ||
| * Handles both single file plugins and also folder style plugins containing js/css/images etc | ||
| */ | ||
| if ($dir = opendir(PLUGINS_PATH)) { | ||
|
|
||
| while (false !== ($filename = readdir($dir)) && $dir) { | ||
|
|
||
| if ($filename != "." && $filename != "..") { | ||
|
|
||
| if (is_dir(PLUGINS_PATH . D_S . $filename)) { | ||
|
|
||
| $plugin_file = PLUGINS_PATH . D_S . $filename . D_S . $filename . ".php"; | ||
|
|
||
| if (file_exists($plugin_file)) { | ||
|
|
||
| require_once($plugin_file); | ||
| } | ||
| } | ||
| else { | ||
|
|
||
| $plugin_file = PLUGINS_PATH . D_S . $filename; | ||
|
|
||
| if (file_exists($plugin_file) && pathinfo($plugin_file, PATHINFO_EXTENSION) == 'php') { | ||
|
|
||
| require_once($plugin_file); | ||
|
|
||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| closedir($dir); | ||
| } | ||
|
|
||
|
|
||
| /** | ||
| * After the plugins are all loaded, let's trigger an action, just in case we can use it later | ||
| */ | ||
| do_action("plugins_loaded"); | ||
|
|
||
|
|
||
| /** | ||
| * This function returns the name of the main script minus the .php extension in | ||
| * order to help identify the current page | ||
| * | ||
| * @return array Filename of current script without .php and logged in status | ||
| */ | ||
| function plugins_get_context() { | ||
|
|
||
| global $authmech; | ||
| if (!$authmech) $authmech = Xerte_Authentication_Factory::create($xerte_toolkits_site->authentication_method); | ||
| $basename = basename($_SERVER['SCRIPT_NAME'], '.php'); | ||
| $logged_in = !$authmech->needsLogin(); | ||
| return array($basename, $logged_in); | ||
|
|
||
| } | ||
|
|
||
|
|
||
| /** | ||
| * This function returns true if we're on initial login page | ||
| */ | ||
| function is_login_page() { | ||
|
|
||
| $context = plugins_get_context(); | ||
| //print_r($context); | ||
| return ($context[0] == "index" && !$context[1]); | ||
|
|
||
| } | ||
|
|
||
|
|
||
| /** | ||
| * This function returns true if we're on editor page | ||
| */ | ||
| function is_editor_page() { | ||
|
|
||
| $context = plugins_get_context(); | ||
| return ($context[0] == "index" && $context[1]); | ||
|
|
||
| } | ||
|
|
||
|
|
||
| /** | ||
| * Helper functions to trigger the appropriate action | ||
| * | ||
| * @return void | ||
| */ | ||
| function head_start() { do_action("head_start"); } | ||
|
|
||
| function head_end() { do_action("head_end"); } | ||
|
|
||
| function body_start() { do_action("body_start"); } | ||
|
|
||
| function body_end() { do_action("body_end"); } | ||
|
|
||
| function startup() { do_action("startup"); } | ||
|
|
||
| function shutdown() { do_action("shutdown"); } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,73 @@ | ||
| <?php | ||
|
|
||
| if(!class_exists('GCU_Plugin')) { | ||
|
|
||
| class GCU_Plugin { | ||
|
|
||
| public static function insert_banner() { | ||
| echo('<div style="width: 910px; margin-left: auto; margin-right: auto; background: #00529c url(http://www.gcu.ac.uk/media/gcalwebv2/gcal-site/img/site/header/header-bg.gif) repeat-x left top;">'); | ||
| echo('<a href="http://www.gcal.ac.uk/">'); | ||
| echo('<img src="http://www.gcu.ac.uk/media/gcalwebv2/gcal-site/img/site/generic/gcal-logo.gif" alt="Visit Glasgow Caledonian University website" border="0" /></a>'); | ||
| echo('</div>'); | ||
| } | ||
|
|
||
| public static function change_head_title($title) { | ||
| $title = "Xerte @ Glasgow Caledonian University"; | ||
| return $title; | ||
| } | ||
|
|
||
| public static function change_page_title($title) { | ||
| $firstname = ""; | ||
| if (isset($_SESSION['toolkits_firstname'])) { | ||
| $firstname = $_SESSION['toolkits_firstname']; | ||
| } | ||
| else { | ||
| global $authmech; | ||
| if ($authmech) { | ||
| $firstname = $authmech->getFirstname(); // BUG?? Returns wrong name... | ||
| } | ||
| } | ||
|
|
||
| if ($firstname) { | ||
| $title = str_replace("My", "$firstname's", $title); | ||
| } | ||
|
|
||
| return $title; | ||
| } | ||
|
|
||
| public static function insert_title_slide($haystack) { | ||
| $needle = '>'; | ||
| $endpoint = strpos($haystack, $needle); | ||
|
|
||
| if ($endpoint > 0) { | ||
| $new_slide = "\n\t\t".'<title name="GCU Learning Objects present" size="30"><![CDATA[A John Smith Production]]></title>'; | ||
| $haystack = substr($haystack, 0, $endpoint+1) . $new_slide . substr($haystack, $endpoint+1); | ||
| } | ||
| return $haystack; | ||
| } | ||
|
|
||
| public static function rewrite_pod_one($pod) { | ||
| return "<b>This added by GCU Plugin</b>" . $pod; | ||
| } | ||
| } | ||
|
|
||
|
|
||
| /** | ||
| * Wire up the actions | ||
| */ | ||
| add_action('body_start', array('GCU_Plugin', 'insert_banner')); | ||
|
|
||
|
|
||
| /** | ||
| * Wire up the filters | ||
| */ | ||
| add_filter('head_title', array('GCU_Plugin', 'change_head_title')); | ||
| add_filter('page_title', array('GCU_Plugin', 'change_page_title')); | ||
| add_filter('editor_save_data', array('GCU_Plugin', 'insert_title_slide')); | ||
| add_filter('login_pod_one', array('GCU_Plugin', 'rewrite_pod_one')); | ||
| add_filter('editor_pod_one', array('GCU_Plugin', 'rewrite_pod_one')); | ||
|
|
||
| } | ||
| else { | ||
| // TODO : log an error that there's been a collision | ||
| } |
Oops, something went wrong.