Bug api entities order

[escopecz]

Q	A
Bug fix?	Y
New feature?	N
Automated tests included?	Y
Related user documentation PR URL	N
Related developer documentation PR URL	N
Issues addressed (#s or URLs)	N
BC breaks?	N
Deprecations?	N

Description:

Mautic API Library has a QueryBuilder which generates order queries as array like this:

[
    [
        'col' => 'someCol',
        'dir' => 'DESC',
    ]
]

This array will be URL encoded and sen as a GET query param. The problem is that Mautic didn't have handling of such ordering definition implemented for getEntities methods.

This PR also fix a small issue where the validateOrderByClause removed dots from the column names. So e.dateModified would be changed to edateModified and then the buildOrderByClauseFromArray would add it again because it's missing the dot and so the column name would become e.edateModified instead of e.dateModified. I don't know if this caused some real world bug, but it was causing new unit tests to fail.

Steps to reproduce the bug:

1. Try to get a list of entities via API. For example segments.
2. Order them with GET query params order[0][col]=dateModified&order[0][dir]=DESC

You should get a list of segments with random order.

Steps to test this PR:

1. Checkout this PR.
2. Test again. You should get list of your segments ordered by dateModified in descendent direction.

[Hadamcik]

SQL validated for adding ORDER but API returns entities not ordered by specified key. Not sure why

[javjim]

Having same issue as @dreiser the order is not being applied

[escopecz]

I don't know guys, it works for me whatever column or direction I use. @dreiser can you help me debug this since I cannot replicate the problem?

We tried a little debug in a private chat. So you tried to get the SQL query with echo $q->getQuery()->getSql(); in CommonRepository.php:1338 and it generated query with ORDER BY l0_.date_modified DESC. Can you try to find out what's going on since that point?

[alanhartless]

Works for me as well. @dreiser @javjim-mautic Are you guys able to get the CURL request out of postman or whatever app you're using to test so we can see what the request looks like?

[javjim]

It was a really lame postman error on my side. viewing on Pretty option it ordered by the ID, after some help from @alanhartless we figured it out when looking it as raw data....

Working properly @escopecz thanks!!!