Both the subject and the direction need to be specified when expressing an order. More...

Collaboration diagram for ILIAS\Data\Order:

Public Member Functions
	__construct (string $subject, string $direction)

	append (string $subject, string $direction)

	get ()

	join ($init, callable $fn)

Data Fields
const	ASC = 'ASC'

const	DESC = 'DESC'

Protected Member Functions
	checkSubject (string $subject)

	checkDirection (string $direction)

Protected Attributes
array	$order = []

Detailed Description

Both the subject and the direction need to be specified when expressing an order.

Author: Nils Haagen nils..nosp@m.haag.nosp@m.en@co.nosp@m.ncep.nosp@m.ts-an.nosp@m.d-tr.nosp@m.ainin.nosp@m.g.de

Definition at line 28 of file Order.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\Data\Order::__construct	(	string	$subject,
		string	$direction
	)

Definition at line 38 of file Order.php.

    {
        $this->checkDirection($direction);
        $this->order[$subject] = $direction;
    }

References ILIAS\Data\Order\checkDirection().

Here is the call graph for this function:

Member Function Documentation

◆ append()

ILIAS\Data\Order::append	(	string	$subject,
		string	$direction
	)

Definition at line 58 of file Order.php.

                                                              : Order
    {
        $this->checkSubject($subject);
        $this->checkDirection($direction);
        $clone = clone $this;
        $clone->order[$subject] = $direction;
        return $clone;
    }

References ILIAS\Data\Order\checkDirection(), and ILIAS\Data\Order\checkSubject().

Referenced by orderTest\testAppend(), orderTest\testInvalidDirection(), and orderTest\testInvalidSubject().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ checkDirection()

ILIAS\Data\Order::checkDirection ( string $direction )

protected

Definition at line 51 of file Order.php.

                                                        : void
    {
        if ($direction !== self::ASC && $direction !== self::DESC) {
            throw new \InvalidArgumentException("Direction bust be Order::ASC or Order::DESC.", 1);
        }
    }

Referenced by ILIAS\Data\Order\__construct(), and ILIAS\Data\Order\append().

Here is the caller graph for this function:

◆ checkSubject()

ILIAS\Data\Order::checkSubject ( string $subject )

protected

Definition at line 44 of file Order.php.

                                                    : void
    {
        if (array_key_exists($subject, $this->order)) {
            throw new \InvalidArgumentException("already sorted by subject '$subject'", 1);
        }
    }

Referenced by ILIAS\Data\Order\append().

Here is the caller graph for this function:

◆ get()

ILIAS\Data\Order::get ( )

Returns: array<string, string>

Definition at line 70 of file Order.php.

                         : array
    {
        return $this->order;
    }

References ILIAS\Data\Order\$order.

Referenced by ILIAS\Test\Participants\ParticipantRepository\applyOrder(), ILIAS\components\ResourceStorage\Collections\View\RequestToDataTable\initSortingAndOrdering(), ILIAS\components\ResourceStorage\Container\View\RequestToDataTable\initSortingAndOrdering(), ILIAS\Test\Participants\ParticipantTable\orderRecords(), ILIAS\User\Profile\Fields\ConfigurationGUI\orderRows(), ILIAS\Course\Grouping\Table\AssignmentRetrieval\sortRecords(), ILIAS\Course\Grouping\Table\GroupingRetrieval\sortRecords(), ILIAS\User\Settings\ConfigurationGUI\sortRows(), orderTest\testAppend(), and orderTest\testValues().

Here is the caller graph for this function:

◆ join()

ILIAS\Data\Order::join	(		$init,
		callable	$fn
	)

Definition at line 75 of file Order.php.

    {
        $ret = $init;
        foreach ($this->order as $key => $value) {
            $ret = $fn($ret, $key, $value);
        }
        return $ret;
    }

Referenced by ILIAS\UI\examples\Table\Data\base(), ilAssQuestionList\buildOrderQueryExpression(), ILIAS\UI\examples\Table\Data\DataTableDemoRepo\doSelect(), ilBiblLibraryTableGUI\getRecords(), ILIAS\AdministrativeNotification\DataRetrieval\getRecords(), ILIAS\Bibliographic\Field\DataRetrieval\getRecords(), ILIAS\Bibliographic\FieldFilter\DataRetrieval\getRecords(), ilDidacticTemplateSettingsTableDataRetrieval\getRecords(), ILIAS\Registration\RegistrationCodesTable\getRecords(), ILIAS\Badge\ilBadgeImageTemplateTableGUI\getRows(), ilBadgePersonalTableGUI\getRows(), ILIAS\Badge\ilBadgeTableGUI\getRows(), ILIAS\Badge\ilBadgeTypesTableGUI\getRows(), ILIAS\Badge\ilBadgeUserTableGUI\getRows(), ILIAS\Badge\ilObjectBadgeTableGUI\getRows(), ilOrgUnitTypeGUI\getTableDataRetrieval(), ILIAS\Forum\Notification\ForumNotificationTable\orderRecords(), LDAPRoleAssignmentTable\orderRecords(), LDAPRoleMappingTable\orderRecords(), ilMailTemplateTable\orderRecords(), ILIAS\Calendar\ConsultationHours\BookingDataProvider\sortData(), ILIAS\Conditions\Configuration\ConditionTriggerProvider\sortData(), ILIAS\Forum\Statistics\ForumStatisticsTable\sortedRecords(), orderTest\testJoinMore(), and orderTest\testJoinOne().

Here is the caller graph for this function:

Field Documentation

◆ $order

array ILIAS\Data\Order::$order = []

protected

Definition at line 36 of file Order.php.

Referenced by ILIAS\Data\Order\get().

◆ ASC

const ILIAS\Data\Order::ASC = 'ASC'

Definition at line 30 of file Order.php.

Referenced by ILIAS\UI\examples\Input\ViewControl\Group\base(), ILIAS\Mail\Attachments\MailAttachmentTableGUI\get(), ILIAS\components\Authentication\Pages\AuthPageLanguagesOverviewTable\getComponent(), ILIAS\Contact\MailingLists\MailingListsMembersTable\getComponent(), ILIAS\Contact\MailingLists\MailingListsTable\getComponent(), ILIAS\Contact\MemberSearch\MailMemberSearchTable\getComponent(), ILIAS\Cron\Job\Manager\UI\JobTable\getComponent(), ILIAS\Forum\Moderation\ForumModeratorsTable\getComponent(), ILIAS\LDAP\Server\UI\ServerTable\getComponent(), ILIAS\UI\Implementation\Component\Table\getOrder(), ILIAS\UI\Implementation\Component\Table\getViewControlOrdering(), ILIAS\components\ResourceStorage\Collections\View\RequestToDataTable\initSortingAndOrdering(), ILIAS\components\ResourceStorage\Container\View\RequestToDataTable\initSortingAndOrdering(), ILIAS\Course\Grouping\Table\AssignmentRetrieval\sortRecords(), ILIAS\Course\Grouping\Table\GroupingRetrieval\sortRecords(), and ILIAS\Mail\Message\MailBoxQuery\withOrderDirection().

◆ DESC

const ILIAS\Data\Order::DESC = 'DESC'

Definition at line 31 of file Order.php.

Referenced by ILIAS\UI\examples\Input\ViewControl\Group\base(), ILIAS\UI\examples\Table\Data\base(), ILIAS\Certificate\Overview\CertificateOverviewTable\buildTable(), ILIAS\Chatroom\Bans\BannedUsersTable\getComponent(), ILIAS\Mail\Folder\MailFolderTableUI\getComponent(), ILIAS\Cron\Job\Manager\UI\JobTable\getRecords(), ILIAS\Badge\ilBadgeImageTemplateTableGUI\getRows(), ILIAS\Badge\ilBadgeTableGUI\getRows(), ILIAS\Badge\ilBadgeTypesTableGUI\getRows(), ILIAS\Badge\ilObjectBadgeTableGUI\getRows(), ILIAS\UI\Implementation\Component\Table\getViewControlOrdering(), ILIAS\components\ResourceStorage\Collections\View\RequestToDataTable\initSortingAndOrdering(), ILIAS\components\ResourceStorage\Container\View\RequestToDataTable\initSortingAndOrdering(), and ILIAS\Mail\Message\MailBoxQuery\withOrderDirection().

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

components/ILIAS/Data/src/Order.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ append()

◆ checkDirection()

◆ checkSubject()

◆ get()

◆ join()

Field Documentation

◆ $order

◆ ASC

◆ DESC