Changeset 5975 in subversion

Timestamp:

Mar 7, 2012 5:07:57 AM (16 months ago)

Author:

alec

Message:

• Hook unregister methods (#1488184)

Location:

trunk/roundcubemail/program/include

Files:

• rcube_plugin.php (modified) (9 diffs)
• rcube_plugin_api.php (modified) (1 diff)

trunk/roundcubemail/program/include/rcube_plugin.php

@@ -82 +82 @@
     $this->urlbase = $api->url . $this->ID . '/';
   }
-  
+
   /**
    * Initialization method, needs to be implemented by the plugin itself
@@ -118 +118 @@
       return false;
     }
-    
+
     return true;
   }
@@ -132 +132 @@
     $this->api->register_hook($hook, $callback);
   }
-  
+
+  /**
+   * Unregister a callback function for a specific (server-side) hook.
+   *
+   * @param string $hook Hook name
+   * @param mixed  $callback Callback function as string or array with object reference and method name
+   */
+  public function remove_hook($hook, $callback)
+  {
+    $this->api->unregister_hook($hook, $callback);
+  }
+
   /**
    * Load localized texts from the plugins dir
@@ -142 +153 @@
   {
     $domain = $this->ID;
-    
+
     $lang = $_SESSION['language'];
     $locdir = slashify(realpath(slashify($this->home) . $dir));
@@ -168 +179 @@
       $rcmail = rcmail::get_instance();
       $rcmail->load_language($lang, $add);
-      
+
       // add labels to client
       if ($add2client) {
@@ -176 +187 @@
     }
   }
-  
+
   /**
    * Wrapper for rcmail::gettext() adding the plugin ID as domain
@@ -246 +257 @@
     $this->api->include_stylesheet($this->resource_url($fn));
   }
-  
+
   /**
    * Append a button to a certain container
@@ -261 +272 @@
         if ($p[$key])
           $p[$key] = $this->api->url . $this->resource_url($p[$key]);
-      
+
       $this->api->add_content($this->api->output->button($p), $container);
     }
   }
-  
+
   /**
    * Generate an absolute URL to the given resource within the current
@@ -316 +327 @@
   }
 
-
 }
-

trunk/roundcubemail/program/include/rcube_plugin_api.php

@@ -231 +231 @@
   }
 
+  /**
+   * Allow a plugin object to unregister a callback.
+   *
+   * @param string $hook Hook name
+   * @param mixed  $callback String with global function name or array($obj, 'methodname')
+   */
+  public function unregister_hook($hook, $callback)
+  {
+    $callback_id = array_search($callback, $this->handlers[$hook]);
+    if ($callback_id !== false) {
+      unset($this->handlers[$hook][$callback_id]);
+    }
+  }
+
 
   /**