| Author: Thomas Bruederli <roundcube@gmail.com> |
+-----------------------------------------------------------------------+
- $Id: rcube_addressbook.php 4965 2011-07-25 11:48:50Z alec $
+ $Id: rcube_addressbook.php 5873 2012-02-11 13:50:04Z thomasb $
*/
/** constants for error reporting **/
const ERROR_READ_ONLY = 1;
const ERROR_NO_CONNECTION = 2;
- const ERROR_INCOMPLETE = 3;
+ const ERROR_VALIDATE = 3;
const ERROR_SAVING = 4;
const ERROR_SEARCH = 5;
public $primary_key;
public $groups = false;
public $readonly = true;
+ public $searchonly = false;
public $undelete = false;
public $ready = false;
public $group_id = null;
public $list_page = 1;
public $page_size = 10;
+ public $sort_col = 'name';
+ public $sort_order = 'ASC';
public $coltypes = array('name' => array('limit'=>1), 'firstname' => array('limit'=>1), 'surname' => array('limit'=>1), 'email' => array('limit'=>1));
protected $error;
*
* @param array List of fields to search in
* @param string Search value
+ * @param int Matching mode:
+ * 0 - partial (*abc*),
+ * 1 - strict (=),
+ * 2 - prefix (abc*)
* @param boolean True if results are requested, False if count only
* @param boolean True to skip the count query (select only)
* @param array List of fields that cannot be empty
* @return object rcube_result_set List of contact records and 'count' value
*/
- abstract function search($fields, $value, $strict=false, $select=true, $nocount=false, $required=array());
+ abstract function search($fields, $value, $mode=0, $select=true, $nocount=false, $required=array());
/**
* Count number of available contacts in database
$this->page_size = (int)$size;
}
+ /**
+ * Set internal sort settings
+ *
+ * @param string $sort_col Sort column
+ * @param string $sort_order Sort order
+ */
+ function set_sort_order($sort_col, $sort_order = null)
+ {
+ if ($sort_col != null && ($this->coltypes[$sort_col] || in_array($sort_col, $this->coltypes))) {
+ $this->sort_col = $sort_col;
+ }
+ if ($sort_order != null) {
+ $this->sort_order = strtoupper($sort_order) == 'DESC' ? 'DESC' : 'ASC';
+ }
+ }
/**
* Check the given data before saving.
* If input isn't valid, the message to display can be fetched using get_error()
*
* @param array Assoziative array with data to save
+ * @param boolean Attempt to fix/complete record automatically
* @return boolean True if input is valid, False if not.
*/
- public function validate($save_data)
+ public function validate(&$save_data, $autofix = false)
{
// check validity of email addresses
foreach ($this->get_col_values('email', $save_data, true) as $email) {
if (strlen($email)) {
if (!check_email(rcube_idn_to_ascii($email))) {
- $this->set_error('warning', rcube_label(array('name' => 'emailformaterror', 'vars' => array('email' => $email))));
+ $this->set_error(self::ERROR_VALIDATE, rcube_label(array('name' => 'emailformaterror', 'vars' => array('email' => $email))));
return false;
}
}
return array();
}
+ /**
+ * Get group properties such as name and email address(es)
+ *
+ * @param string Group identifier
+ * @return array Group properties as hash array
+ */
+ function get_group($group_id)
+ {
+ /* empty for address books don't supporting groups */
+ return null;
+ }
+
/**
* Create a contact group with the given name
*
{
$out = array();
foreach ($data as $c => $values) {
- if (strpos($c, $col) === 0) {
+ if ($c === $col || strpos($c, $col.':') === 0) {
if ($flat) {
$out = array_merge($out, (array)$values);
}
* Compose a valid display name from the given structured contact data
*
* @param array Hash array with contact data as key-value pairs
- * @param bool The name will be used on the list
+ * @param bool Don't attempt to extract components from the email address
*
* @return string Display name
*/
- public static function compose_display_name($contact, $list_mode = false)
+ public static function compose_display_name($contact, $full_email = false)
{
$contact = rcmail::get_instance()->plugins->exec_hook('contact_displayname', $contact);
$fn = $contact['name'];
- if (!$fn)
+ if (!$fn) // default display name composition according to vcard standard
$fn = join(' ', array_filter(array($contact['prefix'], $contact['firstname'], $contact['middlename'], $contact['surname'], $contact['suffix'])));
// use email address part for name
$email = is_array($contact['email']) ? $contact['email'][0] : $contact['email'];
if ($email && (empty($fn) || $fn == $email)) {
- // Use full email address on contacts list
- if ($list_mode)
+ // return full email
+ if ($full_email)
return $email;
list($emailname) = explode('@', $email);
return $fn;
}
+
+ /**
+ * Compose the name to display in the contacts list for the given contact record.
+ * This respects the settings parameter how to list conacts.
+ *
+ * @param array Hash array with contact data as key-value pairs
+ * @return string List name
+ */
+ public static function compose_list_name($contact)
+ {
+ static $compose_mode;
+
+ if (!isset($compose_mode)) // cache this
+ $compose_mode = rcmail::get_instance()->config->get('addressbook_name_listing', 0);
+
+ if ($compose_mode == 3)
+ $fn = join(' ', array($contact['surname'] . ',', $contact['firstname'], $contact['middlename']));
+ else if ($compose_mode == 2)
+ $fn = join(' ', array($contact['surname'], $contact['firstname'], $contact['middlename']));
+ else if ($compose_mode == 1)
+ $fn = join(' ', array($contact['firstname'], $contact['middlename'], $contact['surname']));
+ else
+ $fn = !empty($contact['name']) ? $contact['name'] : join(' ', array($contact['prefix'], $contact['firstname'], $contact['middlename'], $contact['surname'], $contact['suffix']));
+
+ $fn = trim($fn, ', ');
+
+ // fallback to display name
+ if (empty($fn) && $contact['name'])
+ $fn = $contact['name'];
+
+ // fallback to email address
+ $email = is_array($contact['email']) ? $contact['email'][0] : $contact['email'];
+ if (empty($fn) && $email)
+ return $email;
+
+ return $fn;
+ }
+
}