ilArrayUtil Class Reference

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Collaboration diagram for ilArrayUtil:

Static Public Member Functions
static	quoteArray (array $a_array)
	Quotes all members of an array for usage in DB query statement. More...
static	stripSlashesRecursive ($a_data, bool $a_strip_html=true, string $a_allow="")
static	stripSlashesArray (array $a_arr, bool $a_strip_html=true, string $a_allow="")
static	sortArray (array $array, string $a_array_sortby_key, string $a_array_sortorder="asc", bool $a_numeric=false, bool $a_keep_keys=false)
static	stableSortArray (array $array, string $a_array_sortby, string $a_array_sortorder="asc", bool $a_numeric=false)
	Sort an aray using a stable sort algorithm, which preveserves the sequence of array elements which have the same sort value. More...

Static Private Member Functions
static	sort_func (array $left, array $right)
static	sort_func_numeric (array $left, array $right)
static	mergesort (array &$array, ?callable $cmp_function=null)

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning ilArrayUtil class various functions, usage as namespace

Author

Sascha Hofmann sasch.nosp@m.ahof.nosp@m.mann@.nosp@m.gmx..nosp@m.de

Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e

Deprecated:

The 2021 Technical Board has decided to mark the ilUtil class as deprecated. The ilUtil is a historically grown helper class with many different UseCases and functions. The class is not under direct maintainership and the responsibilities are unclear. In this context, the class should no longer be used in the code and existing uses should be converted to their own service in the medium term. If you need ilUtil for the implementation of a new function in ILIAS > 7, please contact the Technical Board.

Definition at line 32 of file class.ilArrayUtil.php.

Member Function Documentation

mergesort()

static ilArrayUtil::mergesort ( array &  $array, ?callable  $cmp_function = null  )

staticprivate

Parameters

array	$array
callable	$cmp_function

Returns

void

Definition at line 179 of file class.ilArrayUtil.php.

References null.

Referenced by stableSortArray().

                                                                                    : void
    {
        if ($cmp_function === null) {
            $cmp_function = 'strcmp';
        }
        // Arrays of size < 2 require no action.
        if (count($array) < 2) {
            return;
        }

        // Split the array in half
        $halfway = intval(count($array) / 2);
        $array1 = array_slice($array, 0, $halfway);
        $array2 = array_slice($array, $halfway);

        // Recurse to sort the two halves
        ilArrayUtil::mergesort($array1, $cmp_function);
        ilArrayUtil::mergesort($array2, $cmp_function);

        // If all of $array1 is <= all of $array2, just append them.
        if (call_user_func($cmp_function, end($array1), $array2[0]) < 1) {
            $array = array_merge($array1, $array2);
            return;
        }

        // Merge the two sorted arrays into a single sorted array
        $array = [];
        $ptr1 = $ptr2 = 0;
        while ($ptr1 < count($array1) && $ptr2 < count($array2)) {
            if (call_user_func($cmp_function, $array1[$ptr1], $array2[$ptr2]) < 1) {
                $array[] = $array1[$ptr1++];
            } else {
                $array[] = $array2[$ptr2++];
            }
        }

        // Merge the remainder
        while ($ptr1 < count($array1)) {
            $array[] = $array1[$ptr1++];
        }
        while ($ptr2 < count($array2)) {
            $array[] = $array2[$ptr2++];
        }
    }

Here is the caller graph for this function:

quoteArray()

static ilArrayUtil::quoteArray ( array  $a_array )

static

Quotes all members of an array for usage in DB query statement.

Deprecated:

Definition at line 39 of file class.ilArrayUtil.php.

References $DIC, and $ilDB.

Referenced by ilObjGroup\_isMember(), ilUtil\_sortIds(), ilTree\getChildsByTypeFilter(), and ilObjGroup\getGroupMemberData().

                                                     : array
    {
        global $DIC;

        $ilDB = $DIC->database();


        if (!is_array($a_array) or !count($a_array)) {
            return ["''"];
        }

        foreach ($a_array as $k => $item) {
            $a_array[$k] = $ilDB->quote($item);
        }

        return $a_array;
    }

Here is the caller graph for this function:

sort_func()

static ilArrayUtil::sort_func ( array  $left, array  $right  )

staticprivate

Deprecated:

Definition at line 132 of file class.ilArrayUtil.php.

References ilStr\strCmp().

                                                                : int
    {
        global $array_sortby, $array_sortorder;

        if (!isset($array_sortby)) {
            // occurred in: setup -> new client -> install languages -> sorting of languages
            $array_sortby = 0;
        }

        $leftValue = (string) ($left[$array_sortby] ?? '');
        $rightValue = (string) ($right[$array_sortby] ?? '');

        // this comparison should give optimal results if
        // locale is provided and mb string functions are supported
        if ($array_sortorder === "asc") {
            return ilStr::strCmp($leftValue, $rightValue);
        } elseif ($array_sortorder === "desc") {
            return ilStr::strCmp($rightValue, $leftValue);
        }

        return 0;
    }

Here is the call graph for this function:

sort_func_numeric()

static ilArrayUtil::sort_func_numeric ( array  $left, array  $right  )

staticprivate

Deprecated:

Definition at line 158 of file class.ilArrayUtil.php.

                                                                        : int
    {
        global $array_sortby, $array_sortorder;

        $leftValue = (string) ($left[$array_sortby] ?? '');
        $rightValue = (string) ($right[$array_sortby] ?? '');

        if ($array_sortorder === "asc") {
            return $leftValue <=> $rightValue;
        } elseif ($array_sortorder === "desc") {
            return $rightValue <=> $leftValue;
        }

        return 0;
    }

sortArray()

static ilArrayUtil::sortArray ( array  $array, string  $a_array_sortby_key, string  $a_array_sortorder = "asc", bool  $a_numeric = false, bool  $a_keep_keys = false  )

static

Deprecated:

Definition at line 93 of file class.ilArrayUtil.php.

Referenced by ilDerivedTaskCollector\__construct(), ilBenchmarkTableGUI\__construct(), ilTaxonomyTableGUI\__construct(), ilSkillCatTableGUI\__construct(), ilUserDefinedFields\__read(), ilCourseObjectiveMaterials\_getAssignableMaterials(), ilExport\_getLastExportFileDate(), ilExport\_getLastExportFileInformation(), ilNewsItem\_getNewsItemsOfUser(), ilObjRole\_removeObjectId(), ilInfoScreenGUI\addPreconditions(), ilCalendarSchedule\calculate(), ilColumnGUI\determineBlocks(), ilLMTracker\determineProgressStatus(), ilObjTypeDefinitionGUI\editObject(), ilTable2GUI\exportData(), ilObjExercise\exportGradesExcel(), ilClassificationBlockGUI\filterContainer(), ilTaxonomyNode\fixOrderNumbers(), ilTaxonomyClassificationProvider\getActiveTaxonomiesForParentRefId(), ilExAssignmentTeam\getAdoptableTeamAssignments(), ilNewsItem\getAggregatedChildNewsData(), ilNewsItem\getAggregatedNewsData(), ilObjSurvey\getAllRelations(), ilItemGroupItems\getAssignableItems(), ilCalendarSelectionBlockGUI\getCalendars(), ilSkillTree\getChildsByTypeFilter(), ilPersonalSkillExplorerGUI\getChildsOfNode(), ilModulesTableGUI\getComponents(), ilBenchmarkTableGUI\getDataByFirstTable(), ilLearningHistoryEntryCollector\getEntries(), ilLikeData\getExpressionEntries(), ilLikeData\getExpressionEntriesForObject(), ilContainerFilterFieldData\getFilterSetForRefId(), ilObjectDefinition\getGroupedRepositoryObjectTypes(), ilExAssignmentTeam\getGroupMembersMap(), ilNewItemGroupTableGUI\getGroups(), ilDclEditViewTableGUI\getHTML(), ilDclCreateViewTableGUI\getHTML(), ilDclTableViewEditFieldsTableGUI\getHTML(), ilDclFieldListTableGUI\getHTML(), ilCalendarAgendaListGUI\getHTML(), ilTable2GUI\getHTML(), ilPCImageMapTableGUI\getItems(), ilUserRoleStartingPointTableGUI\getItems(), ilObjBlogGUI\getKeywords(), ilBookingInfoScreenAdapter\getList(), ILIAS\Awareness\WidgetManager\getListData(), ilItemGroupItemsTableGUI\getMaterials(), ilCourseMembershipGUI\getPrintMemberData(), ilPageObject\getRecentChanges(), ILIAS\COPage\Editor\Server\UI\ServerTable\getRecords(), ilObjMediaCast\getSortedItemsArray(), ilObjectDefinition\getSubObjects(), ilObjectDefinition\getSubObjectsRecursively(), ilTagging\getTagsForUser(), ilObjectActivation\getTimingsAdministrationItems(), ILIAS\Skill\Usage\UsageDBRepository\getUsageOfObject(), ilObjUserTrackingGUI\initLPDefaultsForm(), ilContainerSessionsContentGUI\initSessionPresentationLimitation(), ilLTIConsumerGradeSynchronizationGUI\initTableData(), ilPCQuestionGUI\insert(), ilObjectListGUI\insertPreconditions(), ilPCParagraph\linkTermsInDom(), ilSCORMTrackingUsersTableGUI\parse(), ilTimingsPersonalTableGUI\parse(), ilGroupParticipantsTableGUI\parse(), ilLearningSequenceParticipantsTableGUI\parse(), ilCourseParticipantsTableGUI\parse(), ILIAS\BookingManager\Reservations\ReservationDBRepository\preloadByContextIds(), ilTreeExplorerGUI\preloadChilds(), ilContentStyleSettings\read(), ilPortfolioPageGUI\renderMyCourses(), ilContainerContentGUI\renderPageEmbeddedBlocks(), ILIAS\Skill\Node\SkillTreeNodeManager\saveChildsOrder(), ilObjStyleSheet\saveMediaQueryOrder(), ILIAS\Wiki\Navigation\ImportantPageDBRepository\saveOrderingAndIndentation(), ilWikiPageGUI\searchWikiLinkAC(), ilExerciseManagementGUI\showParticipantObject(), ilLMPresentationGUI\showPrintView(), ilWebLinkItemsContainer\sortArray(), ilRepositoryExplorerGUI\sortChilds(), ilTableGUI\sortData(), ilContainerSorting\sortItems(), ilWorkspaceFolderSorting\sortNodes(), ilExplorer\sortNodes(), ilContainerSorting\sortOrderDefault(), ilCourseObjectiveQuestionAssignmentTableGUI\sortQuestions(), ILIAS\UI\Component\Legacy\Content\ItemSetManager\sortSessions(), ilContainerSorting\sortSubItems(), ilAdvancedMDSettingsGUI\updateSubstitutions(), and ilObjTypeDefinitionGUI\viewObject().

     : array {
        if (!$a_keep_keys) {
            return self::stableSortArray($array, $a_array_sortby_key, $a_array_sortorder, $a_numeric);
        }

        global $array_sortby, $array_sortorder;
        $array_sortby = $a_array_sortby_key;

        if ($a_array_sortorder == "desc") {
            $array_sortorder = "desc";
        } else {
            $array_sortorder = "asc";
        }
        if ($a_numeric) {
            if ($a_keep_keys) {
                uasort($array, [ilArrayUtil::class, "sort_func_numeric"]);
            } else {
                usort($array, [ilArrayUtil::class, "sort_func_numeric"]);
            }
        } else {
            if ($a_keep_keys) {
                uasort($array, [ilArrayUtil::class, "sort_func"]);
            } else {
                usort($array, [ilArrayUtil::class, "sort_func"]);
            }
        }

        return $array;
    }

Here is the caller graph for this function:

stableSortArray()

static ilArrayUtil::stableSortArray ( array  $array, string  $a_array_sortby, string  $a_array_sortorder = "asc", bool  $a_numeric = false  )

static

Sort an aray using a stable sort algorithm, which preveserves the sequence of array elements which have the same sort value.

To sort an array by multiple sort keys, invoke this function for each sort key.

Deprecated:

Definition at line 231 of file class.ilArrayUtil.php.

References mergesort().

Referenced by ilSessionMaterialsTableGUI\getDataFromDb(), ilSCORMTrackingItemsTableGUI\getItems(), ilSCORM2004TrackingItemsTableGUI\getItems(), ilBookingInfoScreenAdapter\getList(), ilTrQuery\getUserDataForObject(), ILIAS\BookingManager\Reservations\ReservationDBRepository\preloadByContextIds(), ILIAS\Contact\MailingLists\MailingListsMembersTable\sortedRecords(), ILIAS\Contact\MemberSearch\MailMemberSearchTable\sortedRecords(), ILIAS\Forum\Moderation\ForumModeratorsTable\sortedRecords(), ILIAS\Chatroom\Bans\BannedUsersTable\sortedRecords(), ILIAS\components\Authentication\Pages\AuthPageLanguagesOverviewTable\sortedRecords(), and ILIAS\Contact\MailingLists\MailingListsTable\sortedRecords().

     : array {
        global $array_sortby, $array_sortorder;

        $array_sortby = $a_array_sortby;

        if ($a_array_sortorder == "desc") {
            $array_sortorder = "desc";
        } else {
            $array_sortorder = "asc";
        }

        // Create a copy of the array values for sorting
        $sort_array = array_values($array);

        if ($a_numeric) {
            ilArrayUtil::mergesort($sort_array, [ilArrayUtil::class, "sort_func_numeric"]);
        } else {
            ilArrayUtil::mergesort($sort_array, [ilArrayUtil::class, "sort_func"]);
        }

        return $sort_array;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

stripSlashesArray()

static ilArrayUtil::stripSlashesArray ( array  $a_arr, bool  $a_strip_html = true, string  $a_allow = ""  )

static

Deprecated:

Definition at line 81 of file class.ilArrayUtil.php.

References ilUtil\stripSlashes().

Referenced by ilSkillProfileGUI\saveLevelOrder(), ilBasicSkillGUI\updateLevelOrder(), ilMobMultiSrtUploadGUI\uploadMultipleSubtitleFile(), and ilObjMediaObjectGUI\uploadMultipleSubtitleFileObject().

                                                                                                           : array
    {
        foreach ($a_arr as $k => $v) {
            $a_arr[$k] = ilUtil::stripSlashes($v, $a_strip_html, $a_allow);
        }

        return $a_arr;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

stripSlashesRecursive()

static ilArrayUtil::stripSlashesRecursive (   $a_data, bool  $a_strip_html = true, string  $a_allow = ""  )

static

Parameters

$data

string|array

Deprecated:

Definition at line 61 of file class.ilArrayUtil.php.

References ilUtil\stripSlashes().

Referenced by ilKprimChoiceWizardInputGUI\cleanupAnswerText(), assQuestionGUI\cleanupAnswerText(), ILIAS\SurveyQuestionPool\Editing\EditingGUIRequest\getAnswers(), ILIAS\SurveyQuestionPool\Editing\EditingGUIRequest\getColumns(), ilGloAdvColSortInputGUI\getInput(), ilMatrixRowWizardInputGUI\getInput(), ilCategoryWizardInputGUI\getInput(), ilImagemapFileInputGUI\getPostBody(), ILIAS\SurveyQuestionPool\Editing\EditingGUIRequest\getRows(), ilMultiFilesSubmitRecursiveSlashesStripper\manipulateFileSubmitValues(), ilStartUpGUI\saniziteArrayElementsTrafo(), ilPasswordAssistanceGUI\saniziteArrayElementsTrafo(), ilOpenIdConnectSettingsGUI\saniziteArrayElementsTrafo(), and assLongMenuGUI\writeQuestionSpecificPostData().

                                                                                                          : array
    {
        if (is_array($a_data)) {
            foreach ($a_data as $k => $v) {
                if (is_array($v)) {
                    $a_data[$k] = ilArrayUtil::stripSlashesRecursive($v, $a_strip_html, $a_allow);
                } else {
                    $a_data[$k] = ilUtil::stripSlashes($v, $a_strip_html, $a_allow);
                }
            }
        } else {
            $a_data = ilUtil::stripSlashes($a_data, $a_strip_html, $a_allow);
        }

        return $a_data;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

---

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

• components/ILIAS/Utilities/classes/class.ilArrayUtil.php