Add clarifying docs
authorpdontthink <pdontthink@7612ce4b-ef26-0410-bec9-ea0150e637f0>
Fri, 20 Jun 2008 07:57:38 +0000 (07:57 +0000)
committerpdontthink <pdontthink@7612ce4b-ef26-0410-bec9-ea0150e637f0>
Fri, 20 Jun 2008 07:57:38 +0000 (07:57 +0000)
git-svn-id: https://svn.code.sf.net/p/squirrelmail/code/trunk/squirrelmail@13187 7612ce4b-ef26-0410-bec9-ea0150e637f0

functions/abook_database.php
functions/abook_ldap_server.php
functions/abook_local_file.php
functions/addressbook.php

index 8294cf3..ceeba5e 100644 (file)
@@ -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
index d4b472a..252c417 100644 (file)
@@ -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
index f72796b..22a7932 100644 (file)
@@ -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
index 3b2fe54..0c68958 100644 (file)
@@ -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