From: pdontthink <pdontthink@7612ce4b-ef26-0410-bec9-ea0150e637f0>
Date: Fri, 20 Jun 2008 07:57:38 +0000 (+0000)
Subject: Add clarifying docs
X-Git-Url: https://vcs.fsf.org/?p=squirrelmail.git;a=commitdiff_plain;h=bf55ebab05a152f1f21ed28451429365378ad67f;ds=sidebyside

Add clarifying docs

git-svn-id: https://svn.code.sf.net/p/squirrelmail/code/trunk/squirrelmail@13187 7612ce4b-ef26-0410-bec9-ea0150e637f0
---

diff --git a/functions/abook_database.php b/functions/abook_database.php
index 8294cf3e..ceeba5e9 100644
--- a/functions/abook_database.php
+++ b/functions/abook_database.php
@@ -295,6 +295,10 @@ class abook_database extends addressbook_backend {
      *                       of the SM_ABOOK_FIELD_* constants
      *                       defined in include/constants.php
      *                       (OPTIONAL; defaults to nickname field)
+     *                       NOTE: uniqueness is only guaranteed
+     *                       when the nickname field is used here;
+     *                       otherwise, the first matching address
+     *                       is returned.
      *
      * @return array Array with lookup results when the value
      *               was found, an empty array if the value was
diff --git a/functions/abook_ldap_server.php b/functions/abook_ldap_server.php
index d4b472ad..252c417d 100644
--- a/functions/abook_ldap_server.php
+++ b/functions/abook_ldap_server.php
@@ -729,6 +729,10 @@ class abook_ldap_server extends addressbook_backend {
      *                       of the SM_ABOOK_FIELD_* constants
      *                       defined in include/constants.php
      *                       (OPTIONAL; defaults to nickname field)
+     *                       NOTE: uniqueness is only guaranteed
+     *                       when the nickname field is used here;
+     *                       otherwise, the first matching address
+     *                       is returned.
      *
      * @return array Array with lookup results when the value
      *               was found, an empty array if the value was
diff --git a/functions/abook_local_file.php b/functions/abook_local_file.php
index f72796b4..22a7932b 100644
--- a/functions/abook_local_file.php
+++ b/functions/abook_local_file.php
@@ -324,6 +324,10 @@ class abook_local_file extends addressbook_backend {
      *                       of the SM_ABOOK_FIELD_* constants
      *                       defined in include/constants.php
      *                       (OPTIONAL; defaults to nickname field)
+     *                       NOTE: uniqueness is only guaranteed
+     *                       when the nickname field is used here;
+     *                       otherwise, the first matching address
+     *                       is returned.
      *
      * @return array Array with lookup results when the value
      *               was found, an empty array if the value was
diff --git a/functions/addressbook.php b/functions/addressbook.php
index 3b2fe54f..0c68958d 100644
--- a/functions/addressbook.php
+++ b/functions/addressbook.php
@@ -606,6 +606,10 @@ class AddressBook {
      *                       of the SM_ABOOK_FIELD_* constants
      *                       defined in include/constants.php
      *                       (OPTIONAL; defaults to nickname field)
+     *                       NOTE: uniqueness is only guaranteed
+     *                       when the nickname field is used here;
+     *                       otherwise, the first matching address
+     *                       is returned.
      *
      * @return mixed Array with lookup results when the value
      *               was found, an empty array if the value was
@@ -929,6 +933,10 @@ class addressbook_backend {
      * @param integer $field The field to look in, should be one
      *                       of the SM_ABOOK_FIELD_* constants
      *                       defined in include/constants.php
+     *                       NOTE: uniqueness is only guaranteed
+     *                       when the nickname field is used here;
+     *                       otherwise, the first matching address
+     *                       is returned.
      *
      * @return mixed Array with lookup results when the value
      *               was found, an empty array if the value was