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 8294cf3eaa141c18fe1f0adeff578be6c586c5d2..ceeba5e9e4b14c86760e7f5bf5f89f53e041a1a5 100644 (file)
--- 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)
      *                       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
      *
      * @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 d4b472adbc755a6d686da70a8c6f9ba7590c115f..252c417def7678e4e7f887c75a3ada247824e958 100644 (file)
--- 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)
      *                       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
      *
      * @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 f72796b496dfb2edb5ea7e12d9ad0a5eda463152..22a7932b6b275b574c8e933637aa8e9a9b0b4776 100644 (file)
--- 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)
      *                       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
      *
      * @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 3b2fe54f4a51931ec0d7793777b36aa9aa662496..0c68958d225c623c99938a60addbeff64a61f451 100644 (file)
--- 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)
      *                       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
      *
      * @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
      * @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
      *
      * @return mixed Array with lookup results when the value
      *               was found, an empty array if the value was