From 892fdb202e33bf74dafdc74363258dbce00d1699 Mon Sep 17 00:00:00 2001
From: mistic100 <mistic@piwigo.org>
Date: Wed, 13 Nov 2013 11:08:22 +0000
Subject: feature 2976: improve lisiblity of pwg.users.getList options on APi
 explore + optimizations (remove in_array())

git-svn-id: http://piwigo.org/svn/trunk@25472 68402e56-0260-453c-a942-63ccdbb3a9ee
---
 include/ws_functions/pwg.users.php | 46 ++++++++++++++++----------------------
 ws.php                             | 14 ++++++++----
 2 files changed, 29 insertions(+), 31 deletions(-)

diff --git a/include/ws_functions/pwg.users.php b/include/ws_functions/pwg.users.php
index 0a8b2d6a2..42a362ec2 100644
--- a/include/ws_functions/pwg.users.php
+++ b/include/ws_functions/pwg.users.php
@@ -33,6 +33,7 @@
  *    @option int per_page
  *    @option int page
  *    @option string order
+ *    @option string display
  */
 function ws_users_getList($params, &$service)
 {
@@ -77,17 +78,17 @@ function ws_users_getList($params, &$service)
 
   if ($params['display'] != 'none')
   {
-    $params['display'] = explode(',', $params['display']);
+    $params['display'] = array_map('trim', explode(',', $params['display']));
 
     if (in_array('all', $params['display']))
     {
-      $params['display'] = array_merge($params['display'], array(
+      $params['display'] = array(
         'username','email','status','level','groups','language','theme',
         'nb_image_page','recent_period','expand','show_nb_comments','show_nb_hits',
         'enabled_high','registration_date','registration_date_string',
         'registration_date_since', 'last_visit', 'last_visit_string',
         'last_visit_since'
-        ));
+        );
     }
     else if (in_array('basics', $params['display']))
     {
@@ -95,36 +96,27 @@ function ws_users_getList($params, &$service)
         'username','email','status','level','groups',
         ));
     }
+    $params['display'] = array_flip($params['display']);
 
     // if registration_date_string or registration_date_since is requested,
     // then registration_date is automatically added
-    if (in_array('registration_date_string', $params['display']) and !in_array('registration_date', $params['display']))
+    if (isset($params['display']['registration_date_string']) or isset($params['display']['registration_date_since']))
     {
-      $params['display'][] = 'registration_date';
-    }
-
-    if (in_array('registration_date_since', $params['display']) and !in_array('registration_date', $params['display']))
-    {
-      $params['display'][] = 'registration_date';
+      $params['display']['registration_date'] = true;
     }
 
     // if last_visit_string or last_visit_since is requested, then
     // last_visit is automatically added
-    if (in_array('last_visit_string', $params['display']) and !in_array('last_visit', $params['display']))
-    {
-      $params['display'][] = 'last_visit';
-    }
-
-    if (in_array('last_visit_since', $params['display']) and !in_array('last_visit', $params['display']))
+    if (isset($params['display']['last_visit_string']) or isset($params['display']['last_visit_since']))
     {
-      $params['display'][] = 'last_visit';
+      $params['display']['last_visit'] = true;
     }
 
-    if (in_array('username', $params['display']))
+    if (isset($params['display']['username']))
     {
       $display['u.'.$conf['user_fields']['username']] = 'username';
     }
-    if (in_array('email', $params['display']))
+    if (isset($params['display']['email']))
     {
       $display['u.'.$conf['user_fields']['email']] = 'email';
     }
@@ -135,7 +127,7 @@ function ws_users_getList($params, &$service)
       );
     foreach ($ui_fields as $field)
     {
-      if (in_array($field, $params['display']))
+      if (isset($params['display'][$field]))
       {
         $display['ui.'.$field] = $field;
       }
@@ -156,7 +148,7 @@ SELECT DISTINCT ';
     else $first = false;
     $query.= $field .' AS '. $name;
   }
-  if (in_array('groups', $params['display']))
+  if (isset($params['display']['groups']))
   {
     if (!$first) $query.= ', ';
     $query.= '"" AS groups';
@@ -179,7 +171,7 @@ SELECT DISTINCT ';
 
   if (count($users) > 0)
   {
-    if (in_array('groups', $params['display']))
+    if (isset($params['display']['groups']))
     {
       $query = '
 SELECT user_id, group_id
@@ -194,7 +186,7 @@ SELECT user_id, group_id
       }
     }
     
-    if (in_array('registration_date_string', $params['display']))
+    if (isset($params['display']['registration_date_string']))
     {
       foreach ($users as $cur_user)
       {
@@ -202,7 +194,7 @@ SELECT user_id, group_id
       }
     }
 
-    if (in_array('registration_date_since', $params['display']))
+    if (isset($params['display']['registration_date_since']))
     {
       foreach ($users as $cur_user)
       {
@@ -210,7 +202,7 @@ SELECT user_id, group_id
       }
     }
 
-    if (in_array('last_visit', $params['display']))
+    if (isset($params['display']['last_visit']))
     {
       $query = '
 SELECT
@@ -240,12 +232,12 @@ SELECT
         $last_visit = $row['date'].' '.$row['time'];
         $users[ $row['user_id'] ]['last_visit'] = $last_visit;
         
-        if (in_array('last_visit_string', $params['display']))
+        if (isset($params['display']['last_visit_string']))
         {
           $users[ $row['user_id'] ]['last_visit_string'] = format_date($last_visit, false, false);
         }
         
-        if (in_array('last_visit_since', $params['display']))
+        if (isset($params['display']['last_visit_since']))
         {
           $users[ $row['user_id'] ]['last_visit_since'] = time_since($last_visit, 'day');
         }
diff --git a/ws.php b/ws.php
index 6d4a35caf..b3f7c0076 100644
--- a/ws.php
+++ b/ws.php
@@ -826,10 +826,16 @@ function ws_addDefaultMethods( $arr )
         'order' =>      array('default'=>'id',
                               'info'=>'id, username, level, email'),
         'display' =>    array('default'=>'basics',
-                              'info'=>'all,basics,none,username,email,status,level,groups,language,theme,nb_image_page,recent_period,expand,show_nb_comments,show_nb_hits,enabled_high'),
-        ),
-      'Retrieves a list of all the users.
-<br>"display" controls which data are returned, "basics" stands for "username,email,status,level,groups"',
+                              'info'=>'Comma saparated list (see method description)'),
+        ),
+      'Retrieves a list of all the users.<br>
+<br>
+<b>display</b> controls which data are returned, possible values are:<br>
+all, basics, none,<br>
+username, email, status, level, groups,<br>
+language, theme, nb_image_page, recent_period, expand, show_nb_comments, show_nb_hits,<br>
+enabled_high, registration_date, registration_date_string, registration_date_since, last_visit, last_visit_string, last_visit_since<br>
+<b>basics</b> stands for "username,email,status,level,groups"',
       $ws_functions_root . 'pwg.users.php',
       array('admin_only'=>true)
     );
-- 
cgit v1.2.3