summaryrefslogtreecommitdiff
path: root/plugins/help/help.php
diff options
context:
space:
mode:
authorthomascube <thomas@roundcube.net>2012-03-03 14:23:04 +0000
committerthomascube <thomas@roundcube.net>2012-03-03 14:23:04 +0000
commit884add1419729cb8eb5ed8fb47ea68e5f6ce6682 (patch)
tree183fdf813b3d84475e01d08abbe6d3511b2dd389 /plugins/help/help.php
parent10ac35625a04074467f002c283d65db24a0508de (diff)
Tagging plugins for 0.8-betav0.8-beta
Diffstat (limited to 'plugins/help/help.php')
-rw-r--r--plugins/help/help.php98
1 files changed, 98 insertions, 0 deletions
diff --git a/plugins/help/help.php b/plugins/help/help.php
new file mode 100644
index 000000000..ad7dbf0ba
--- /dev/null
+++ b/plugins/help/help.php
@@ -0,0 +1,98 @@
+<?php
+
+/**
+ * Help Plugin
+ *
+ * @author Aleksander 'A.L.E.C' Machniak
+ * @license GNU GPLv3+
+ *
+ * Configuration (see config.inc.php.dist)
+ *
+ **/
+
+class help extends rcube_plugin
+{
+ // all task excluding 'login' and 'logout'
+ public $task = '?(?!login|logout).*';
+ // we've got no ajax handlers
+ public $noajax = true;
+ // skip frames
+ public $noframe = true;
+
+ function init()
+ {
+ $rcmail = rcmail::get_instance();
+
+ $this->add_texts('localization/', false);
+
+ // register task
+ $this->register_task('help');
+
+ // register actions
+ $this->register_action('index', array($this, 'action'));
+ $this->register_action('about', array($this, 'action'));
+ $this->register_action('license', array($this, 'action'));
+
+ // add taskbar button
+ $this->add_button(array(
+ 'command' => 'help',
+ 'class' => 'button-help',
+ 'classsel' => 'button-help button-selected',
+ 'innerclass' => 'button-inner',
+ 'label' => 'help.help',
+ ), 'taskbar');
+
+ $skin = $rcmail->config->get('skin');
+ if (!file_exists($this->home."/skins/$skin/help.css"))
+ $skin = 'default';
+
+ // add style for taskbar button (must be here) and Help UI
+ $this->include_stylesheet("skins/$skin/help.css");
+ }
+
+ function action()
+ {
+ $rcmail = rcmail::get_instance();
+
+ $this->load_config();
+
+ // register UI objects
+ $rcmail->output->add_handlers(array(
+ 'helpcontent' => array($this, 'content'),
+ ));
+
+ if ($rcmail->action == 'about')
+ $rcmail->output->set_pagetitle($this->gettext('about'));
+ else if ($rcmail->action == 'license')
+ $rcmail->output->set_pagetitle($this->gettext('license'));
+ else
+ $rcmail->output->set_pagetitle($this->gettext('help'));
+
+ $rcmail->output->send('help.help');
+ }
+
+ function content($attrib)
+ {
+ $rcmail = rcmail::get_instance();
+
+ if ($rcmail->action == 'about') {
+ return @file_get_contents($this->home.'/content/about.html');
+ }
+ else if ($rcmail->action == 'license') {
+ return @file_get_contents($this->home.'/content/license.html');
+ }
+
+ // default content: iframe
+ if ($src = $rcmail->config->get('help_source'))
+ $attrib['src'] = $src;
+
+ if (empty($attrib['id']))
+ $attrib['id'] = 'rcmailhelpcontent';
+
+ $attrib['name'] = $attrib['id'];
+
+ return html::tag('iframe', $attrib, '', array(
+ 'id', 'class', 'style', 'src', 'width', 'height', 'frameborder'));
+ }
+
+}