Merged branch devel-api (from r2208 to r2387) back into trunk (omitting some sample plugins)

2 files changed, 114 insertions, 0 deletions

diff --git a/plugins/example_addressbook/example_addressbook.php b/plugins/example_addressbook/example_addressbook.php
new file mode 100644
index 000000000..081efcb13
--- /dev/null
+++ b/plugins/example_addressbook/example_addressbook.php
@@ -0,0 +1,42 @@
+<?php
+
+/**
+ * Sample plugin to add a new address book
+ * with just a static list of contacts
+ */
+class example_addressbook extends rcube_plugin
+{
+  private $abook_id = 'static';
+  
+  public function init()
+  {
+    $this->add_hook('address_sources', array($this, 'address_sources'));
+    $this->add_hook('get_address_book', array($this, 'get_address_book'));
+    
+    // use this address book for autocompletion queries
+    // (maybe this should be configurable by the user?)
+    $config = rcmail::get_instance()->config;
+    $sources = $config->get('autocomplete_addressbooks', array('sql'));
+    if (!in_array($this->abook_id, $sources)) {
+      $sources[] = $this->abook_id;
+      $config->set('autocomplete_addressbooks', $sources);
+    }
+  }
+  
+  public function address_sources($p)
+  {
+    $p['sources'][$this->abook_id] = array('id' => $this->abook_id, 'name' => 'Static List', 'readonly' => true);
+    return $p;
+  }
+  
+  public function get_address_book($p)
+  {
+    if ($p['id'] == $this->abook_id) {
+      require_once(dirname(__FILE__) . '/example_addressbook_backend.php');
+      $p['instance'] = new example_addressbook_backend;
+    }
+    
+    return $p;
+  }
+  
+}
diff --git a/plugins/example_addressbook/example_addressbook_backend.php b/plugins/example_addressbook/example_addressbook_backend.php
new file mode 100644
index 000000000..ad6b89d67
--- /dev/null
+++ b/plugins/example_addressbook/example_addressbook_backend.php
@@ -0,0 +1,72 @@
+<?php
+
+/**
+ * Example backend class for a custom address book
+ *
+ * This one just holds a static list of address records
+ *
+ * @author Thomas Bruederli
+ */
+class example_addressbook_backend extends rcube_addressbook
+{
+  public $primary_key = 'ID';
+  public $readonly = true;
+  
+  private $filter;
+  private $result;
+  
+  public function __construct()
+  {
+    $this->ready = true;
+  }
+  
+  public function set_search_set($filter)
+  {
+    $this->filter = $filter;
+  }
+  
+  public function get_search_set()
+  {
+    return $this->filter;
+  }
+
+  public function reset()
+  {
+    $this->result = null;
+    $this->filter = null;
+  }
+
+  public function list_records($cols=null, $subset=0)
+  {
+    $this->result = $this->count();
+    $this->result->add(array('ID' => '111', 'name' => "Example Contact", 'firstname' => "Example", 'surname' => "Contact", 'email' => "example@roundcube.net"));
+    
+    return $this->result;
+  }
+
+  public function search($fields, $value, $strict=false, $select=true)
+  {
+    // no search implemented, just list all records
+    return $this->list_records();
+  }
+
+  public function count()
+  {
+    return new rcube_result_set(1, ($this->list_page-1) * $this->page_size);
+  }
+
+  public function get_result()
+  {
+    return $this->result;
+  }
+
+  public function get_record($id, $assoc=false)
+  {
+    $this->list_records();
+    $first = $this->result->first();
+    $sql_arr = $first['ID'] == $id ? $first : null;
+    
+    return $assoc && $sql_arr ? $sql_arr : $this->result;
+  }
+  
+}