[4.0][api][com_users] - Add filter options

[alikon]

Summary of Changes

added the option to filter users by:

• active
• state
• search
• groupid
• registration date
• last visit date

Testing Instructions

call JROOT_URL/api/index.php/v1/users?filter[groupid]=8
call JROOT_URL/api/index.php/v1/users?filter[lastVisitDateStart]=2020-01-29T20:36:01Z
call JROOT_URL/api/index.php/v1/users?filter[search]=myName
call JROOT_URL/api/index.php/v1/users?filter[state]=0
call JROOT_URL/api/index.php/v1/users?filter[active]=1
call JROOT_URL/api/index.php/v1/users?filter[registrationDateStart]=2018-01-29T20:36:01Z
call JROOT_URL/api/index.php/v1/users?filter[registrationDateEnd]=2020-01-29T20:36:01Z
or any combination like :
JROOT_URL/api/index.php/v1/users?filter[groupid]=8&filter[state]=0
etc

Expected values for registrationDateStart , registrationDateEnd and lastVisitDateStart,lastVisitDateEnd are:

2020-03-29T20:36:01Z
2020-03-29T20:36:01+00:00

Expected result

the api response is filtered

Actual result

N/A

Documentation Changes Required

yes

[Quy]

I have tested this item ✅ successfully on 893d051

---

_{This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/28451.}

[Razzo1987]

I have tested this item 🔴 unsuccessfully on 893d051

{{base_path}}/api/index.php/v1/users?filter[status]=1
{{base_path}}/api/index.php/v1/users?filter[status]=0

return the same list of users

{{base_path}}/api/index.php/v1/users?users?filter[registrationdate]=never

returns a list of users who have the registration date

Same list of 3 users is given from
{{base_path}}/api/index.php/v1/users?users?filter[lastvisitdate]=never

---

_{This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/28451.}

[Quy]

The example is incorrect. [status] should be [state].

[Quy]

See comment in testing instructions:

never (make sense only for lastvisitdate)

[alikon]

thanks @Quy updated the Testing Instructions

[Quy]

JROOT_URL/api/index.php/v1/users?filter[groupid]=system&filter[status]=0

This too please.

[Quy]

filter[groupid]=system

Should be integer.

[Razzo1987]

I have tested this item ✅ successfully on 893d051

re tested. it works!

---

_{This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/28451.}

[alikon]

RTC

---

_{This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/28451.}

[alikon]

this needs to be retested
cause we have now differnt and better filter for: registrationDate/lastVisitDate

• registrationDateStart
• registrationDateEnd
• lastVisitDateStart
• lastVisitDateEnd

[Razzo1987]

I have tested this item 🔴 unsuccessfully on c11fd11

Start & End inverted ;)

This example output the users:
{{base_path}}/api/index.php/v1/users?filter[lastVisitDateEnd]=2010-04-18T14:52:20Z&filter[lastVisitDateStart]=2050-04-18T14:52:20Z
If we have Start < End doesn't :(

---

_{This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/28451.}

[faustonenci]

I have tested this item 🔴 unsuccessfully on c11fd11

not work

JROOT_URL/api/index.php/v1/users?filter[lastVisitDateStart]=2020-01-29T20:36:01Z

work if
inverted Date with Start

JROOT_URL/api/index.php/v1/users?filter[lastVisitStartDate]=2020-01-29T20:36:01Z

idem for
JROOT_URL/api/index.php/v1/users?filter[registrationDateStart]=2018-01-29T20:36:01Z
JROOT_URL/api/index.php/v1/users?filter[registrationDateEnd]=2020-01-29T20:36:01Z

---

_{This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/28451.}

[alikon]

we have had a live debug sesion with the help of @Razzo1987
now should be fixed
please retest @Razzo1987

[faustonenci]

I have tested this item ✅ successfully on 8e1c0e5

good !

---

_{This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/28451.}

[Razzo1987]

I have tested this item ✅ successfully on 8e1c0e5

Now Start & End works correctly.

---

_{This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/28451.}

[richard67]

RTC

---

_{This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/28451.}

[wilsonge]

Thanks!