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

git-svn-id: https://svn.roundcube.net/trunk@2401 208e9e7b-5314-0410-a742-e7e81cd9613c

1 files changed, 72 insertions, 0 deletions

diff --git a/roundcubemail/plugins/example_addressbook/example_addressbook_backend.php b/roundcubemail/plugins/example_addressbook/example_addressbook_backend.php
new file mode 100644
index 000000000..ad6b89d67
--- /dev/null
+++ b/roundcubemail/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;
+  }
+  
+}