Changeset 1c932d5 in github for program/include/rcube_plugin.php

Timestamp:

Apr 26, 2009 12:33:22 PM (4 years ago)

Author:

thomascube <thomas@…>

Branches:

master, HEAD, courier-fix, dev-browser-capabilities, pdo, release-0.6, release-0.7, release-0.8

Children:

99d8660

Parents:

d4d1a25

Message:

Allow plugins to define their own tasks + add 'domain' parameter for rcube_template::button()

File:

• program/include/rcube_plugin.php (modified) (1 diff)

program/include/rcube_plugin.php

@@ -102 +102 @@
    * @see rcmail::gettext()
    */
-  function gettext($p)
+  public function gettext($p)
   {
     return rcmail::get_instance()->gettext($p, $this->ID);
   }
-  
+
+  /**
+   * Register this plugin to be responsible for a specific task
+   *
+   * @param string Task name (only characters [a-z0-9_.-] are allowed)
+   */
+  public function register_task($task)
+  {
+    if ($task != asciiwords($task)) {
+      raise_error(array('code' => 526, 'type' => 'php', 'message' => "Invalid task name: $task. Only characters [a-z0-9_.-] are allowed"), true, false);
+    }
+    else if (in_array(rcmail::$main_tasks, $task)) {
+      raise_error(array('code' => 526, 'type' => 'php', 'message' => "Cannot register taks $task; already taken by another plugin or the application itself"), true, false);
+    }
+    else {
+      rcmail::$main_tasks[] = $task;
+    }
+  }
+
   /**
     * Register a handler for a specific client-request action