Skip to content

75 add sorting functions #76

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
davidcoutadeur merged 2 commits into from
Aug 29, 2025
Merged

75 add sorting functions #76

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
92499dc
add more sorting function (#75)
Aug 29, 2025
076d928
add unit tests for sorting function (#75)
Aug 29, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
99 changes: 99 additions & 0 deletions src/Ltb/Ldap.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -266,6 +266,105 @@ function ldapSort(array &$entries, $key)

}


function compare_text($value1, $value2)
{
return $value1 <=> $value2;
}

function compare_bytes($value1, $value2)
{
if( is_numeric($value1) && is_numeric($value2) )
{
return ($value1 - $value2);
}
else
{
return 1;
}
}

function compareValue($value1, $value2, $type)
{
# Check if comparison method exists
if(method_exists($this, 'compare_'.$type)){
# Run appropriate comparison method
return $this->{'compare_'.$type}($value1, $value2);
}
else
{
# By default, use a simple text comparison method
return $this->compare_text($value1, $value2);
}
}


function compareEntries($sort_key, $direction, $type)
{
return function ($a, $b) use ($sort_key, $direction, $type) {

$res = null;

if( is_array($a) and is_array($b) )
{
if( array_key_exists($sort_key,$a) )
{
if( array_key_exists($sort_key,$b) )
{
# Ascending order "asc" by default (from lesser to greater values)
$res = $this->compareValue($a[$sort_key][0], $b[$sort_key][0], $type);
}
else
{
$res = 1;
}
}
else
{
if( array_key_exists($sort_key,$b) )
{
$res = -1;
}
else
{
$res = 0;
}
}
}
else
{
$res = 0;
}

# invert result if this is descending order (from greater to lesser values)
if( $direction == "desc" )
{
$res = $res * -1;
}
return $res;
};
}

# sorting function with direction (ascending / descending)
function sortEntries(array &$entries, $key, $direction, $type)
{
# 'count' is an additionnal attribute of ldap entries that will be preserved
# remove it since lost by usort ( changed to integer index )
$count = isset($entries['count']) ? $entries['count'] : null;
unset($entries['count']);

usort($entries, $this->compareEntries($key, $direction, $type));


# preserve count since sorting should not change number of elements.
if( $count ) {
$entries['count']=$count;
}

return true;

}

# ldap_search + ldap_sort combined done at server side if possible
# if not supported fallback on client sorting.
function sorted_search($ldap_base, $ldap_filter, $attributes, $sortby, $ldap_size_limit) {
Expand Down
128 changes: 128 additions & 0 deletions tests/Ltb/LdapTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -673,6 +673,134 @@ public function test_ldapSort(): void
$this->assertEquals('testcn1', $entries[1]['cn'][0], "testcn1 has not been ordered correctly in entries array");
}

public function test_compare_text(): void
{

$ldapInstance = new \Ltb\Ldap( null, null, null, null, null, null, null, null );
$ldapInstance->ldap = "ldap_connection";
$returnAsc = $ldapInstance->compare_text("test1", "test2");
$returnEq = $ldapInstance->compare_text("test", "test");
$returnDesc = $ldapInstance->compare_text("test4", "test3");

$this->assertTrue($returnAsc < 0, "compare_text: test1 should be < to test2");
$this->assertTrue($returnEq == 0, "compare_text: test should be = to test");
$this->assertTrue($returnDesc > 0, "compare_text: test1 should be > to test2");
}

public function test_compare_bytes(): void
{

$ldapInstance = new \Ltb\Ldap( null, null, null, null, null, null, null, null );
$ldapInstance->ldap = "ldap_connection";
$returnAsc = $ldapInstance->compare_bytes("4096", "2097152");
$returnEq = $ldapInstance->compare_bytes("1024", "1024");
$returnDesc = $ldapInstance->compare_bytes("1073741824", "2048");

$this->assertTrue($returnAsc < 0, "compare_bytes: 4096 should be < to 2097152");
$this->assertTrue($returnEq == 0, "compare_bytes: 1024 should be = to 1024");
$this->assertTrue($returnDesc > 0, "compare_bytes: 1073741824 should be > to 2048");
}

public function test_compareValue(): void
{

$ldapInstance = new \Ltb\Ldap( null, null, null, null, null, null, null, null );
$ldapInstance->ldap = "ldap_connection";
$returnBytes = $ldapInstance->compareValue("256", "1024", "bytes");
$returnText = $ldapInstance->compareValue("test1", "test2", "this-is-a-dummy-type");

$this->assertTrue($returnBytes < 0, "compareValue: 256 should be < to 1024 for bytes type");
$this->assertTrue($returnText < 0, "compareValue: test1 should be < to test2 for default text type");
}
public function test_compareEntries(): void
{

$entries = [
'count' => 2,
0 => [
'count' => 2,
0 => 'cn',
1 => 'sn',
'cn' => [
'count' => 1,
0 => 'testcn1'
],
'sn' => [
'count' => 1,
0 => 'zzzz'
]
],
1 => [
'count' => 2,
0 => 'cn',
1 => 'sn',
'cn' => [
'count' => 1,
0 => 'testcn2'
],
'sn' => [
'count' => 1,
0 => 'aaaa'
]
]
];

$ldapInstance = new \Ltb\Ldap( null, null, null, null, null, null, null, null );
$ldapInstance->ldap = "ldap_connection";
$compareSnAscText = $ldapInstance->compareEntries("sn", "asc", "text")($entries[0], $entries[1]);
$compareSnDescText = $ldapInstance->compareEntries("sn", "desc", "text")($entries[0], $entries[1]);
$compareCnAscText = $ldapInstance->compareEntries("cn", "asc", "text")($entries[0], $entries[1]);
$compareCnDescText = $ldapInstance->compareEntries("cn", "desc", "text")($entries[0], $entries[1]);

$this->assertTrue($compareSnAscText > 0, "compareEntries: testcn1 has not been compared correctly to testcn2 for ascending text comparison of sn");
$this->assertTrue($compareSnDescText < 0, "compareEntries: testcn1 has not been compared correctly to testcn2 for descending text comparison of sn");
$this->assertTrue($compareCnAscText < 0, "compareEntries: testcn1 has not been compared correctly to testcn2 for ascending text comparison of cn");
$this->assertTrue($compareCnDescText > 0, "compareEntries: testcn1 has not been compared correctly to testcn2 for descending text comparison of cn");
}

public function test_sortEntries(): void
{

$entries = [
'count' => 2,
0 => [
'count' => 2,
0 => 'cn',
1 => 'sn',
'cn' => [
'count' => 1,
0 => 'testcn1'
],
'sn' => [
'count' => 1,
0 => 'zzzz'
]
],
1 => [
'count' => 2,
0 => 'cn',
1 => 'sn',
'cn' => [
'count' => 1,
0 => 'testcn2'
],
'sn' => [
'count' => 1,
0 => 'aaaa'
]
]
];

$ldapInstance = new \Ltb\Ldap( null, null, null, null, null, null, null, null );
$ldapInstance->ldap = "ldap_connection";
$return = $ldapInstance->sortEntries($entries, "sn", "asc", "text");

$this->assertTrue($return, "Weird value returned by sortEntries function");
$this->assertEquals('testcn2', $entries[0]['cn'][0], "sortEntries: testcn2 has not been ordered correctly in entries array");
$this->assertEquals('testcn1', $entries[1]['cn'][0], "sortEntries: testcn1 has not been ordered correctly in entries array");
}


public function test_sorted_search_with_sort_control(): void
{

Expand Down