Zend Framework

New options in search function: sortDir and resultChangeCase

Details

  • Type: Improvement Improvement
  • Status: Resolved Resolved
  • Priority: Minor Minor
  • Resolution: Fixed
  • Affects Version/s: 1.9.5
  • Fix Version/s: 1.10.0
  • Component/s: Zend_Ldap
  • Labels:
    None

Description

I made two functions inside Zend_Ldap->search.

public function search($filter, $basedn = null, $scope = self::SEARCH_SCOPE_SUB,
        array $attributes = array(), $sort = null, $sortDir = null, $resultChangeCase = null, $collectionClass = null)

sortDir would be:

if (strtolower($sortDir) == 'desc') {
    array_reverse($result, true);
}

resultChangeCase would be:

$result = Zend_Ldap->search(...);

if ($resultChangeCase != null) {
    if (!in_array($resultChangeCase, array('strtolower' ,'strtoupper', 'ucfirst', 'ucwords'))) {
        throw new Exception('...');
    }
    array_walk_recursive($result, function(&$value, $key, $func) {
        $value = $func($value);
    }, $resultChangeCase);
}

I hope you guys enjoy it!

Issue Links

This issue is related to:
ZF-8263 Zend_Ldap converts attribute names of ldap objects to lowercase Trivial Resolved

Activity

Ascending order - Click to sort in descending order
Hide
Permalink
Rodrigo Novelo Primolan added a comment -

Forgot to describe $result.

Show
Rodrigo Novelo Primolan added a comment - Forgot to describe $result.
Hide
Permalink
Stefan Gehrig added a comment -

Changing the sort direction is a PHP-one-liner - I doubt it'll make sense to add another parameter to the already very long method signature of Zend_Ldap::search(). This functionality can easily be provided by user-land code.

Generall I like the idea of modifying the LDAP options properties' names but it won't be sufficient to provide this functionality in Zend_Ldap::search() - there are a lot more methods where a change would be necessary. I doubt that the work will be worth the effort as you won't gain anything new (LDAP attributes are case-insensitiv per se).

Show
Stefan Gehrig added a comment - Changing the sort direction is a PHP-one-liner - I doubt it'll make sense to add another parameter to the already very long method signature of Zend_Ldap::search(). This functionality can easily be provided by user-land code. Generall I like the idea of modifying the LDAP options properties' names but it won't be sufficient to provide this functionality in Zend_Ldap::search() - there are a lot more methods where a change would be necessary. I doubt that the work will be worth the effort as you won't gain anything new (LDAP attributes are case-insensitiv per se).
Hide
Permalink
Rodrigo Novelo Primolan added a comment -

As you said, it's a trivial case.

Still on the subject, i'd suggest that options should be in array. The reason is simple: if I need just some attributes, I'll need to fill every parameter till I get on attributes's parameter.

Considering that I'm not using any filters, default baseDn, default scope, I'll have to fill in three parameters till I get where I want.

public function search($filter, $basedn = null, $scope = self::SEARCH_SCOPE_SUB,
        array $attributes = array(), $sort = null, $sortDir = null, $resultChangeCase = null, $collectionClass = null)

And options being an array, you could consider my suggestions above.

Show
Rodrigo Novelo Primolan added a comment - As you said, it's a trivial case. Still on the subject, i'd suggest that options should be in array. The reason is simple: if I need just some attributes, I'll need to fill every parameter till I get on attributes's parameter. Considering that I'm not using any filters, default baseDn, default scope, I'll have to fill in three parameters till I get where I want. 
public function search($filter, $basedn = null, $scope = self::SEARCH_SCOPE_SUB,
        array $attributes = array(), $sort = null, $sortDir = null, $resultChangeCase = null, $collectionClass = null)
And options being an array, you could consider my suggestions above.
Hide
Permalink
Rodrigo Novelo Primolan added a comment -

The new way would look like:

public function search(array(
    'attributes' => array('displayname', 'cn', 'dn', 'departament', 'description')
))

Much easier

Show
Rodrigo Novelo Primolan added a comment - The new way would look like: 
public function search(array(
    'attributes' => array('displayname', 'cn', 'dn', 'departament', 'description')
))
Much easier
Hide
Permalink
Stefan Gehrig added a comment -

Issue is reopened, but:

  • the option to change the attributes' names will not be added as the component favors lowercase attribute names in general
  • the option to reverse the sort direction cannot be added to Zend_Ldap::search() because the component relies solely on the LDAP server's capability to sort a result set. Results are retrieved sequentially from the server instead of instantiating the complete result set all at once. The option will be added to Zend_Ldap::searchEntries() as the whole result set is available here.

Both to Zend_Ldap::searchEntries() and Zend_Ldap::search() will be changed to accept an array parameter to remove the need to work through all the methods' parameters.

Show
Stefan Gehrig added a comment - Issue is reopened, but:
  • the option to change the attributes' names will not be added as the component favors lowercase attribute names in general
  • the option to reverse the sort direction cannot be added to Zend_Ldap::search() because the component relies solely on the LDAP server's capability to sort a result set. Results are retrieved sequentially from the server instead of instantiating the complete result set all at once. The option will be added to Zend_Ldap::searchEntries() as the whole result set is available here.
Both to Zend_Ldap::searchEntries() and Zend_Ldap::search() will be changed to accept an array parameter to remove the need to work through all the methods' parameters.
Hide
Permalink
Stefan Gehrig added a comment -

fixed in trunk (r18883):
added $reverseSort argument to Zend_Ldap::searchEntries()
added possibility to pass parameters to Zend_Ldap::searchEntries() and Zend_Ldap::search() in a single array argument

Show
Stefan Gehrig added a comment - fixed in trunk (r18883): added $reverseSort argument to Zend_Ldap::searchEntries() added possibility to pass parameters to Zend_Ldap::searchEntries() and Zend_Ldap::search() in a single array argument
Hide
Permalink
Rodrigo Novelo Primolan added a comment -

Couldn't you add the 'resultChangeCase' function on Zend_Ldap::searchEntries() ?

Treating results' case in the source (Zend_Ldap::searchEntries()) would be better than treat one by one later. Considering that most of AD servers' entries aren't standardized, I think that it's better all come in one single case format (lower or upper for me) and then work upon results.

What do you think about it ?

Show
Rodrigo Novelo Primolan added a comment - Couldn't you add the 'resultChangeCase' function on Zend_Ldap::searchEntries() ? Treating results' case in the source (Zend_Ldap::searchEntries()) would be better than treat one by one later. Considering that most of AD servers' entries aren't standardized, I think that it's better all come in one single case format (lower or upper for me) and then work upon results. What do you think about it ?
Hide
Permalink
Stefan Gehrig added a comment -

Attribute names are already normalized to lower-case. I think there is no need to add this option just for the sake of cosmetics.

Show
Stefan Gehrig added a comment - Attribute names are already normalized to lower-case. I think there is no need to add this option just for the sake of cosmetics.

People

Vote (0)
Watch (1)

Dates

  • Created:
    Updated:
    Resolved:
Atlassian JIRA (v4.4.3#663-r165197) | Report a problem
Powered by a free Atlassian JIRA open source license for Zend Framework. Try JIRA - bug tracking software for your team.