Changeset 4243 in subversion

Timestamp:

Nov 21, 2010 11:47:21 AM (3 years ago)

Author:

thomasb

Message:

Allow address sources to limit/extend the contact coltypes

Location:

branches/devel-addressbook/program

Files:

• include/rcube_addressbook.php (modified) (2 diffs)
• include/rcube_contacts.php (modified) (1 diff)
• js/app.js (modified) (1 diff)
• steps/addressbook/func.inc (modified) (10 diffs)

branches/devel-addressbook/program/include/rcube_addressbook.php

@@ -6 +6 @@
  |                                                                       |
  | This file is part of the Roundcube Webmail client                     |
- | Copyright (C) 2006-2009, Roundcube Dev. - Switzerland                 |
+ | Copyright (C) 2006-2010, Roundcube Dev. - Switzerland                 |
  | Licensed under the GNU GPL                                            |
  |                                                                       |
@@ -28 +28 @@
 abstract class rcube_addressbook
 {
-    /** public properties */
-    var $primary_key;
-    var $groups = false;
-    var $readonly = true;
-    var $ready = false;
-    var $list_page = 1;
-    var $page_size = 10;
+    /** public properties (mandatory) */
+    public $primary_key;
+    public $groups = false;
+    public $readonly = true;
+    public $ready = false;
+    public $list_page = 1;
+    public $page_size = 10;
+    public $coltypes = array('name' => array('limit'=>1), 'firstname' => array('limit'=>1), 'surname' => array('limit'=>1), 'email' => array('limit'=>1));
 
     /**

branches/devel-addressbook/program/include/rcube_contacts.php

@@ -48 +48 @@
 
     // public properties
-    var $primary_key = 'contact_id';
-    var $readonly = false;
-    var $groups = true;
-    var $list_page = 1;
-    var $page_size = 10;
-    var $group_id = 0;
-    var $ready = false;
+    public $primary_key = 'contact_id';
+    public $readonly = false;
+    public $groups = true;
+    public $list_page = 1;
+    public $page_size = 10;
+    public $group_id = 0;
+    public $ready = false;
+    public $coltypes = array('name', 'firstname', 'surname', 'middlename', 'prefix', 'suffix', 'nickname',
+      'jobtitle', 'organization', 'department', 'gender', 'maidenname', 'email', 'phone', 'address',
+      'birthday', 'website', 'im', 'notes');
 
 

branches/devel-addressbook/program/js/app.js

@@ -4029 +4029 @@
         }
         else if (colprop.type == 'composite') {
-          var childcol, cp;
-          for (var j=0; j < colprop.childs.length; j++) {
-              childcol = colprop.childs[j];
-              cp = this.env.coltypes[childcol];
-              input = $('<input>')
-                .addClass('ff_'+childcol)
-                .attr('type', 'text')
-                .attr('name', '_'+childcol+'[]')
-                .attr('size', cp.size)
-                .appendTo(cell);
-              cell.append(" ");
-              this.init_edit_field(childcol, input);
-            }
+          var childcol, cp, first;
+          for (var childcol in colprop.childs) {
+            cp = colprop.childs[childcol];
+            input = $('<input>')
+              .addClass('ff_'+childcol)
+              .attr('type', 'text')
+              .attr('name', '_'+childcol+'[]')
+              .attr('size', cp.size)
+              .appendTo(cell);
+            cell.append(" ");
+            this.init_edit_field(childcol, input);
+            if (!first) first = input;
+          }
+          input = first;  // set focus to the first of this composite fields
         }
         else if (colprop.type == 'select') {

branches/devel-addressbook/program/steps/addressbook/func.inc

@@ -57 +57 @@
 
 
-// TODO: let the $CONTACT object define the list of possible coltypes
+// general definition of contact coltypes
 $CONTACT_COLTYPES = array(
   'name'         => array('type' => 'text', 'size' => 40, 'limit' => 1, 'label' => rcube_label('name')),
@@ -73 +73 @@
   'email'        => array('type' => 'text', 'size' => 40, 'label' => rcube_label('email'), 'subtypes' => array('home','work','other')),
   'phone'        => array('type' => 'text', 'size' => 40, 'label' => rcube_label('phone'), 'subtypes' => array('home','home2','work','work2','mobile','main','homefax','workfax','car','pager','video','assistant','other')),
-  'address'      => array('type' => 'composite', 'label' => rcube_label('address'), 'subtypes' => array('home','work','other'), 'childs' => array('street','locality','zipcode','region','country')),
-    'street'     => array('type' => 'text', 'size' => 40, 'label' => rcube_label('street'), 'composite' => true),
-    'locality'   => array('type' => 'text', 'size' => 28, 'label' => rcube_label('locality'), 'composite' => true),
-    'zipcode'    => array('type' => 'text', 'size' => 8, 'label' => rcube_label('zipcode'), 'composite' => true),
-    'region'     => array('type' => 'text', 'size' => 12, 'label' => rcube_label('region'), 'composite' => true),
-    'country'    => array('type' => 'text', 'size' => 40, 'label' => rcube_label('country'), 'composite' => true),
+  'address'      => array('type' => 'composite', 'label' => rcube_label('address'), 'subtypes' => array('home','work','other'), 'childs' => array(
+    'street'     => array('type' => 'text', 'size' => 40, 'label' => rcube_label('street')),
+    'locality'   => array('type' => 'text', 'size' => 28, 'label' => rcube_label('locality')),
+    'zipcode'    => array('type' => 'text', 'size' => 8, 'label' => rcube_label('zipcode')),
+    'region'     => array('type' => 'text', 'size' => 12, 'label' => rcube_label('region')),
+    'country'    => array('type' => 'text', 'size' => 40, 'label' => rcube_label('country')),
+  )),
   'birthday'     => array('type' => 'date', 'size' => 12, 'label' => rcube_label('birthday'), 'limit' => 1, 'render_func' => 'rcmail_format_date_col'),
   'website'      => array('type' => 'text', 'size' => 40, 'label' => rcube_label('website'), 'subtypes' => array('home','work','blog','other')),
@@ -86 +87 @@
 );
 
+// reduce/extend $CONTACT_COLTYPES with specification from the current $CONTACT object
+if (is_array($CONTACTS->coltypes)) {
+    // remove cols not listed by the backend class
+    $contact_cols = $CONTACTS->coltypes[0] ? array_flip($CONTACTS->coltypes) : $CONTACTS->coltypes;
+    $CONTACT_COLTYPES = array_intersect_key($CONTACT_COLTYPES, $contact_cols);
+    // add associative coltypes definition
+    if (!$CONTACTS->coltypes[0]) {
+        foreach ($CONTACTS->coltypes as $col => $colprop)
+            $CONTACT_COLTYPES[$col] = $CONTACT_COLTYPES[$col] ? array_merge($CONTACT_COLTYPES[$col], $colprop) : $colprop;
+    }
+}
 
 
@@ -282 +294 @@
     // get default coltypes
     $coltypes = $GLOBALS['CONTACT_COLTYPES'];
+    $coltype_lables = array();
     
     foreach ($coltypes as $col => $prop) {
@@ -288 +301 @@
             $select_subtype->add($prop['subtypes']);
             $coltypes[$col]['subtypes_select'] = $select_subtype->show();
+        }
+        if ($prop['childs']) {
+            foreach ($prop['childs'] as $childcol => $cp)
+                $coltype_lables[$childcol] = array('label' => $cp['label']);
         }
     }
@@ -316 +333 @@
                 $fields = '';
                 foreach ($colnames as $col) {
+                    // skip cols unknown to the backend
+                    if (!$coltypes[$col])
+                        continue;
+
                     if ($RCMAIL->action == 'show') {
                         if (!empty($record[$col]))
@@ -343 +364 @@
         if (is_array($fieldset['content'])) {
             foreach ($fieldset['content'] as $col => $colprop) {
+                // skip cols unknown to the backend
+                if (!$coltypes[$col])
+                    continue;
+                
                 // remove subtype part of col name
                 list($field, $subtype) = explode(':', $col);
@@ -405 +430 @@
                     // render composite field
                     if ($colprop['type'] == 'composite') {
-                        $composite = '';
-                        foreach ($colprop['childs'] as $j => $childcol) {
+                        $composite = ''; $j = 0;
+                        foreach ($colprop['childs'] as $childcol => $cp) {
                             $childvalue = $val[$childcol] ? $val[$childcol] : $val[$j];
 
                             if ($edit_mode) {
-                                $cp = $coltypes[$childcol];
                                 if ($colprop['subtypes']) $cp['array'] = true;
                                 $composite .= rcmail_get_edit_field($childcol, $childvalue, $cp, $cp['type']) . " ";
@@ -418 +442 @@
                                 $composite .= html::span('data ' . $childcol, $childval) . " ";
                             }
+                            $j++;
                         }
 
@@ -488 +513 @@
     if ($edit_mode) {
       $RCMAIL->output->set_env('contactdata', $formdata);
-      $RCMAIL->output->set_env('coltypes', $coltypes);
+      $RCMAIL->output->set_env('coltypes', $coltypes + $coltype_lables);
       $RCMAIL->output->set_env('delbutton', $del_button);
       $RCMAIL->output->add_label('delete');