ILIAS\Badge\Sorting Class Reference

Collaboration diagram for ILIAS\Badge\Sorting:

Public Member Functions
	__construct (string $sort_by='')
	compare (array $badge_and_assignment, array $other)
	key ()
	label ()
	options ()

Private Member Functions
	reverse ()
	minus ()

Private Attributes
readonly string	$method
readonly Closure	$compare
readonly string	$direction
readonly string	$key
readonly string	$badgeOrAssignment

Detailed Description

Definition at line 27 of file Sorting.php.

Constructor & Destructor Documentation

__construct()

ILIAS\Badge\Sorting::__construct

(

string

$sort_by = ''

)

Definition at line 36 of file Sorting.php.

References ILIAS\Badge\Sorting\$direction, ILIAS\Badge\Sorting\$key, $parts, ILIAS\Badge\Sorting\compare(), ILIAS\Badge\Sorting\key(), and ILIAS\Badge\Sorting\minus().

    {
        $parts = explode('_', $sort_by);
        $what = $parts[0] ?? '';
        $direction = $parts[1] ?? '';

        $map = [
            'title' => ['badge', 'getTitle', 'strcasecmp'],
            'date' => ['assignment', 'getTimestamp', $this->minus()],
        ];
        $directions = ['asc' => 'asc', 'desc' => 'desc'];

        $key = isset($map[$what]) ? $what : key($map);
        $direction = $directions[$direction] ?? 'asc';

        $this->badgeOrAssignment = $map[$key][0];
        $this->method = $map[$key][1];
        $this->compare = Closure::fromCallable($map[$key][2]);
        $this->direction = $direction;
        $this->key = $key . '_' . $direction;
    }

Here is the call graph for this function:

Member Function Documentation

compare()

ILIAS\Badge\Sorting::compare	(	array	$badge_and_assignment,
		array	$other
	)

Parameters

array{badge	ilBadge, assignment: ilBadgeAssignment} $badge_and_assignment
array{badge	ilBadge, assignment: ilBadgeAssignment} $other

Returns

int

Definition at line 63 of file Sorting.php.

References ILIAS\Badge\Sorting\$badgeOrAssignment, ILIAS\Badge\Sorting\$compare, ILIAS\Badge\Sorting\$method, and ILIAS\Badge\Sorting\reverse().

Referenced by ILIAS\Badge\Sorting\__construct().

                                                                      : int
    {
        $method = $this->method;
        $value = $badge_and_assignment[$this->badgeOrAssignment]->$method();
        $other = $other[$this->badgeOrAssignment]->$method();

        return $this->reverse() * ($this->compare)($value, $other);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

key()

ILIAS\Badge\Sorting::key

(

)

Definition at line 72 of file Sorting.php.

References ILIAS\Badge\Sorting\$key.

Referenced by ILIAS\Badge\Sorting\__construct(), and ILIAS\Badge\TileView\sortComponent().

                         : string
    {
        return $this->key;
    }

Here is the caller graph for this function:

label()

ILIAS\Badge\Sorting::label

(

)

Definition at line 77 of file Sorting.php.

References ILIAS\Badge\Sorting\$key, and ILIAS\Badge\Sorting\options().

                           : string
    {
        return $this->options()[$this->key];
    }

Here is the call graph for this function:

minus()

ILIAS\Badge\Sorting::minus ( )

private

Definition at line 100 of file Sorting.php.

Referenced by ILIAS\Badge\Sorting\__construct().

                            : Closure
    {
        return static fn(int $x, int $y): int => $x - $y;
    }

Here is the caller graph for this function:

options()

ILIAS\Badge\Sorting::options

(

)

Returns

array<string, string>

Definition at line 85 of file Sorting.php.

Referenced by ILIAS\Badge\Sorting\label(), and ILIAS\Badge\TileView\sortComponent().

                             : array
    {
        return [
            'title_asc' => 'sort_by_title_asc',
            'title_desc' => 'sort_by_title_desc',
            'date_asc' => 'sort_by_date_asc',
            'date_desc' => 'sort_by_date_desc',
        ];
    }

Here is the caller graph for this function:

reverse()

ILIAS\Badge\Sorting::reverse ( )

private

Definition at line 95 of file Sorting.php.

Referenced by ILIAS\Badge\Sorting\compare().

                              : int
    {
        return $this->direction === 'asc' ? 1 : -1;
    }

Here is the caller graph for this function:

Field Documentation

$badgeOrAssignment

readonly string ILIAS\Badge\Sorting::$badgeOrAssignment

private

Definition at line 34 of file Sorting.php.

Referenced by ILIAS\Badge\Sorting\compare().

$compare

readonly Closure ILIAS\Badge\Sorting::$compare

private

Definition at line 31 of file Sorting.php.

Referenced by ILIAS\Badge\Sorting\compare().

$direction

readonly string ILIAS\Badge\Sorting::$direction

private

Definition at line 32 of file Sorting.php.

Referenced by ILIAS\Badge\Sorting\__construct().

$key

readonly string ILIAS\Badge\Sorting::$key

private

Definition at line 33 of file Sorting.php.

Referenced by ILIAS\Badge\Sorting\__construct(), ILIAS\Badge\Sorting\key(), and ILIAS\Badge\Sorting\label().

$method

readonly string ILIAS\Badge\Sorting::$method

private

Definition at line 29 of file Sorting.php.

Referenced by ILIAS\Badge\Sorting\compare().

---

The documentation for this class was generated from the following file:

• components/ILIAS/Badge/classes/Sorting.php