[Phpgroupware-cvs] phpgwapi/inc/class.contacts_shared.inc.php, 1.9.2.1.2.7

[nomail]

Update of /phpgwapi/inc
Modified Files:
        Branch: Version-0_9_16-branch
          class.contacts_shared.inc.php

date: 2004/06/21 07:49:45;  author: powerstat;  state: Exp;  lines: +26 -13

Log Message:
partly phpdoc update for contacts backend - still not finished.
=====================================================================
Index: phpgwapi/inc/class.contacts_shared.inc.php
diff -u phpgwapi/inc/class.contacts_shared.inc.php:1.9.2.1.2.6 
phpgwapi/inc/class.contacts_shared.inc.php:1.9.2.1.2.7
--- phpgwapi/inc/class.contacts_shared.inc.php:1.9.2.1.2.6      Tue Feb 10 
13:51:17 2004
+++ phpgwapi/inc/class.contacts_shared.inc.php  Mon Jun 21 07:49:45 2004
@@ -88,11 +88,14 @@
                        return ($a[1]<$b[1])?1:-1;
                }
 
-               /*
-               comesafter ($s1, $s2)
-               Returns 1 if $s1 comes after $s2 alphabetically, 0 if not.
+               /**
+               * Compare two strings by alphabetical order
+               *
+               * @param string $s1
+               * @param string $s2
+               * @return integer 1 if $s1 comes after $s2 alphabetically, 0 if 
not.
                */
-               function comesafter ($s1, $s2)
+               function comesafter($s1, $s2)
                {
                        /*
                        We don't want to overstep the bounds of one of the 
strings and segfault,
@@ -131,13 +134,15 @@
                        return ($order);
                }
 
-               /*
-               * asortbyindex ($sortarray, $index)
+               /**
+               * Sort a multi-dimensional array by a second-degree index.
                *
-               * Sort a multi-dimensional array by a second-degree index. For 
instance, the 0th index
-               * of the Ith member of both the group and user arrays is a 
string identifier. In the
-               * case of a user array this is the username; with the group 
array it is the group name.
-               * asortby
+               * For instance, the 0th index of the Ith member of both the 
group and user arrays
+               * is a string identifier. In the case of a user array this is 
the username;
+               * with the group array it is the group name.
+               * @param array $sortarray
+               * @param integer|string $index
+               * @return array
                */
                function asortbyindex ($sortarray, $index)
                {
@@ -179,7 +184,15 @@
                        return ($sortarray);
                }
 
-               /* This function is deprecated, fortunately. */
+               /**
+               *
+               *
+               * @param $ldap_fields,
+               * @param $filterfields
+               * @param $DEBUG
+               * @return
+               * @deprecated
+               */
                function filter_ldap($ldap_fields,$filterfields,$DEBUG=0)
                {
                        $match = 0;
@@ -224,7 +237,7 @@
                                                                        
if($DEBUG) { echo ', but number '.$ldap_fields[$i]['uidnumber'][0].' did not 
match.'.'&nbsp;&nbsp;'; }
                                                                        $yes &= 
False;
                                                                        
$match--;
-                                                               }               
                                        
+                                                               }
                                                        }
                                                }
                                                else