Util class various functions, usage as namespace. More...

Collaboration diagram for ilUtil:

Static Public Member Functions
static	getImageTagByType (string $a_type, string $a_path, bool $a_big=false)
	Builds an html image tag. More...

static	getImagePath (string $img, string $module_path="", string $mode="output", bool $offline=false)
	get image path (for images located in a template directory) More...

static	getHtmlPath (string $relative_path)
	get url of path More...

static	getStyleSheetLocation (string $mode="output", string $a_css_name="", string $a_css_location="")
	get full style sheet file name (path inclusive) of current user More...

static	getNewContentStyleSheetLocation (string $mode="output")
	get full style sheet file name (path inclusive) of current user More...

static	switchColor (int $a_num, string $a_css1, string $a_css2)
	switches style sheets for each even $a_num (used for changing colors of different result rows) More...

static	makeClickable (string $a_text, bool $detectGotoLinks=false)

static	is_email (string $a_email, ilMailRfc822AddressParserFactory $mailAddressParserFactory=null)
	This preg-based function checks whether an e-mail address is formally valid. More...

static	isLogin (string $a_login)

static	img (string $a_src, ?string $a_alt=null, $a_width="", $a_height="", $a_border=0, $a_id="", $a_class="")
	Build img tag. More...

static	deliverData (string $a_data, string $a_filename, string $mime="application/octet-stream")

static	appendUrlParameterString (string $a_url, string $a_par, bool $xml_style=false)

static	stripSlashes (string $a_str, bool $a_strip_html=true, string $a_allow="")

static	stripOnlySlashes (string $a_str)

static	secureString (string $a_str, bool $a_strip_html=true, string $a_allow="")

static	getSecureTags ()

static	securePlainString (string $a_str)

static	htmlencodePlainString (string $a_str, bool $a_make_links_clickable, bool $a_detect_goto_links=false)
	Encodes a plain text string into HTML for display in a browser. More...

static	maskTag (string $a_str, string $tag, array $fix_param=[])

static	secureLink (string $a_str)

static	stripScriptHTML (string $a_str, string $a_allow="", bool $a_rm_js=true)

static	secureUrl (string $url)

static	extractParameterString (string $a_parstr)

static	yn2tf (string $a_yn)

static	tf2yn (bool $a_tf)

static	deducibleSize (string $a_mime)
	checks if mime type is provided by getimagesize() More...

static	redirect (string $a_script)

static	insertInstIntoID (string $a_value)
	inserts installation id into ILIAS id More...

static	groupNameExists (string $a_group_name, ?int $a_id=null)
	checks if group name already exists. More...

static	isWindows ()

static	now ()
	Return current timestamp in Y-m-d H:i:s format. More...

static	_getObjectsByOperations ( $a_obj_type, string $a_operation, int $a_usr_id=0, int $limit=0)
	Get all objects of a specific type and check access This function is not recursive, instead it parses the serialized rbac_pa entries. More...

static	isHTML (string $a_text)
	Checks if a given string contains HTML or not. More...

static	__extractRefId (string $role_title)
	extract ref id from role title, e.g. More...

static	__extractId (string $ilias_id, int $inst_id)
	extract ref id from role title, e.g. More...

static	_sortIds (array $a_ids, string $a_table, string $a_field, string $a_id_name)
	Function that sorts ids by a given table field using WHERE IN E.g: __sort(array(6,7),'usr_data','lastname','usr_id') => sorts by lastname. More...

static	getSystemMessageHTML (string $a_txt, string $a_type="info")
	Get HTML for a system message. More...

static	setCookie (string $a_cookie_name, string $a_cookie_value='', bool $a_also_set_super_global=true, bool $a_set_cookie_invalid=false)

static	_getHttpPath ()

static	parseImportId (string $a_import_id)
	Parse an ilias import id Typically of type il_[IL_INST_ID]_[OBJ_TYPE]_[OBJ_ID] returns array( 'orig' => 'il_4800_rolt_123' 'prefix' => 'il' 'inst_id => '4800' 'type' => 'rolt' 'id' => '123'. More...

static	formatSize (int $size, string $a_mode='short', ?ilLanguage $a_lng=null)
	Returns the specified file size value in a human friendly form. More...

Static Protected Member Functions
static	fmtFloat (float $a_float, int $a_decimals=0, string $a_dec_point=null, string $a_thousands_sep=null, bool $a_suppress_dot_zero=false)
	format a float More...

Static Private Member Functions
static	replaceLinkProperties (array $matches)

static	maskSecureTags (string $a_str, array $allow_array)

static	unmaskSecureTags (string $a_str, array $allow_array)

static	maskAttributeTag (string $a_str, string $tag, string $tag_att)

static	unmaskAttributeTag (string $a_str, string $tag, string $tag_att)

static	unmaskTag (string $a_str, string $tag, array $fix_param=[])

Detailed Description

Util 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 36 of file class.ilUtil.php.

Member Function Documentation

◆ __extractId()

static ilUtil::__extractId	(	string	$ilias_id,
		int	$inst_id
	)

static

extract ref id from role title, e.g.

893 from 'il_122_role_893'

Parameters

string	$ilias_id	with format like il_<instid>_<objTyp>_ID
int	$inst_id	Installation ID must match inst id in param ilias_id

Deprecated:

Definition at line 1199 of file class.ilUtil.php.

References ILIAS\Repository\int().

Referenced by ilObjUser\_getUserData(), ilUserImportParser\extractRolesBeginTag(), ilObjectXMLParser\handlerBeginTag(), ilExerciseXMLParser\handlerBeginTag(), ilFileXMLParser\handlerBeginTag(), ilUserImportParser\importBeginTag(), ilSoapUserAdministration\importUsers(), ilSoapRBACAdministration\parseUserID(), ilGroupXMLParser\save(), and ilUserImportParser\verifyBeginTag().

                                                                       : ?int
     {
         $test_str = explode('_', $ilias_id);
 
         $parsed_inst_id = (int) ($test_str[1] ?? 0);
         $prefix = $test_str[0] ?? '';
 
         if ($prefix === 'il' && $parsed_inst_id === $inst_id && count($test_str) === 4) {
             return is_numeric($test_str[3]) ? (int) $test_str[3] : null;
         }
         return null;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ __extractRefId()

static ilUtil::__extractRefId ( string $role_title )

static

extract ref id from role title, e.g.

893 from 'il_crs_member_893'

Parameters

string $role_title with format like il_crs_member_893

Deprecated:

Definition at line 1179 of file class.ilUtil.php.

References $ref_id, and ILIAS\Repository\int().

Referenced by ilSoapCourseAdministration\getCoursesForUser(), ilSoapGroupAdministration\getGroupsForUser(), and ilSoapRoleObjectXMLWriter\start().

                                                              : ?int
     {
         $test_str = explode('_', $role_title);
         $prefix = $test_str[0] ?? '';
 
         if ($prefix === 'il') {
             $ref_id = $test_str[3] ?? null;
             return is_numeric($ref_id) ? (int) $ref_id : null;
         }
         return null;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _getHttpPath()

static ilUtil::_getHttpPath ( )

static

Deprecated:

Definition at line 1327 of file class.ilUtil.php.

References $_SERVER, $DIC, $ilIliasIniFile, and ilContext\usesHTTP().

Referenced by ilSessionReminderCheck\__construct(), ilMail\_getAutoGeneratedMessageString(), ilMail\_getInstallationSignature(), ilAuthProviderCAS\doAuthentication(), ilErrorHandling\errorHandler(), ilPasswordAssistanceGUI\getBaseUrl(), ilMailEnvironmentHelper\getHttpPath(), ilTestPlayerAbstractGUI\getNavigationUrlParameter(), ilForumMailNotification\getPermanentLink(), ilForumMailEventNotificationSender\getPermanentLink(), ilChatroomAdminViewGUI\getReadmePath(), ilMailFormCall\getRefererRedirectUrl(), ilSoapClient\init(), ilCronManagerImpl\runActiveJobs(), ilMailSummaryNotification\send(), and ilCronDeleteInactiveUserReminderMail\sendReminder().

                                          : string
     {
         global $DIC;
 
         $ilIliasIniFile = $DIC["ilIliasIniFile"];
 
         if ((isset($_SERVER['SHELL']) && $_SERVER['SHELL']) || PHP_SAPI === 'cli' ||
             // fallback for windows systems, useful in crons
             (class_exists("ilContext") && !ilContext::usesHTTP())) {
             return $ilIliasIniFile->readVariable('server', 'http_path');
         } else {
             return ILIAS_HTTP_PATH;
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _getObjectsByOperations()

static ilUtil::_getObjectsByOperations	(		$a_obj_type,
		string	$a_operation,
		int	$a_usr_id = `0`,
		int	$limit = `0`
	)

static

Get all objects of a specific type and check access This function is not recursive, instead it parses the serialized rbac_pa entries.

Get all objects of a specific type where access is granted for the given operation. This function does a checkAccess call for all objects in the object hierarchy and return only the objects of the given type. Please note if access is not granted to any object in the hierarchy the function skips all objects under it. Example: You want a list of all Courses that are visible and readable for the user. The function call would be: $your_list = IlUtil::getObjectsByOperation ("crs", "visible"); Lets say there is a course A where the user would have access to according to his role assignments. Course A lies within a group object which is not readable for the user. Therefore course A won't appear in the result list although the queried operations 'read' would actually permit the user to access course A.

public

Parameters

string/array	object type 'lm' or array('lm','sahs')
string	permission to check e.g. 'visible' or 'read'
int	id of user in question
int	limit of results. if not given it defaults to search max hits.If limit is -1 limit is unlimited

Returns: array of ref_ids

Definition at line 1054 of file class.ilUtil.php.

References $DIC, $ilDB, $ilSetting, $res, ilRbacReview\_getOperationIdsByName(), ilDBConstants\FETCHMODE_OBJECT, ILIAS\Repository\int(), RECOVERY_FOLDER_ID, and SYSTEM_ROLE_ID.

Referenced by ilGroupActionTargetExplorerGUI\__construct(), ilObjSurveyQuestionPool\_getAvailableQuestionpools(), ilObjQuestionPool\_getAvailableQuestionpools(), ilObjTest\_getAvailableTests(), ilECSSettingsGUI\exportImported(), ilGroupUserActionProvider\getCommandAccess(), ilCourseGroupingAssignmentTableGUI\getItems(), ilObjSurvey\getQuestionblocksTable(), ilECSSettingsGUI\imported(), and ilObjectCopyGUI\sourceExists().

      : array {
         global $DIC;
 
         $ilDB = $DIC->database();
         $rbacreview = $DIC->rbac()->review();
         $ilAccess = $DIC->access();
         $ilUser = $DIC->user();
         $ilSetting = $DIC->settings();
         $tree = $DIC->repositoryTree();
 
         if (!is_array($a_obj_type)) {
             $where = "WHERE type = " . $ilDB->quote($a_obj_type, "text") . " ";
         } else {
             $where = "WHERE " . $ilDB->in("type", $a_obj_type, false, "text") . " ";
         }
 
         // limit number of results default is search result limit
         if (!$limit) {
             $limit = (int) $ilSetting->get('search_max_hits', "100");
         }
         if ($limit == -1) {
             $limit = 10000;
         }
 
         // default to logged in usr
         $a_usr_id = $a_usr_id ?: $ilUser->getId();
         $a_roles = $rbacreview->assignedRoles($a_usr_id);
 
         // Since no rbac_pa entries are available for the system role. This function returns !all! ref_ids in the case the user
         // is assigned to the system role
         if ($rbacreview->isAssigned($a_usr_id, SYSTEM_ROLE_ID)) {
             $query = "SELECT ref_id FROM object_reference obr LEFT JOIN object_data obd ON obr.obj_id = obd.obj_id " .
                 "LEFT JOIN tree ON obr.ref_id = tree.child " .
                 $where .
                 "AND tree = 1";
 
             $res = $ilDB->query($query);
             $counter = 0;
             $ref_ids = [];
             while ($row = $ilDB->fetchObject($res)) {
                 // Filter recovery folder
                 if ($tree->isGrandChild(RECOVERY_FOLDER_ID, $row->ref_id)) {
                     continue;
                 }
 
                 if ($counter++ >= $limit) {
                     break;
                 }
 
                 $ref_ids[] = $row->ref_id;
             }
             return $ref_ids;
         } // End Administrators
 
         // Check ownership if it is not asked for edit_permission or a create permission
         if ($a_operation == 'edit_permissions' or strpos($a_operation, 'create') !== false) {
             $check_owner = ") ";
         } else {
             $check_owner = "OR owner = " . $ilDB->quote($a_usr_id, "integer") . ") ";
         }
 
         $ops_ids = ilRbacReview::_getOperationIdsByName([$a_operation]);
         $ops_id = $ops_ids[0];
 
         $and = "AND ((" . $ilDB->in("rol_id", $a_roles, false, "integer") . " ";
 
         $query = "SELECT DISTINCT(obr.ref_id),obr.obj_id,type FROM object_reference obr " .
             "JOIN object_data obd ON obd.obj_id = obr.obj_id " .
             "LEFT JOIN rbac_pa  ON obr.ref_id = rbac_pa.ref_id " .
             $where .
             $and .
             "AND (" . $ilDB->like("ops_id", "text", "%i:" . $ops_id . "%") . " " .
             "OR " . $ilDB->like("ops_id", "text", "%:\"" . $ops_id . "\";%") . ")) " .
             $check_owner;
 
         $res = $ilDB->query($query);
         $counter = 0;
         $ref_ids = [];
         while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
             if ($counter >= $limit) {
                 break;
             }
 
             // Filter objects in recovery folder
             if ($tree->isGrandChild(RECOVERY_FOLDER_ID, $row->ref_id)) {
                 continue;
             }
 
             // Check deleted, hierarchical access ...
             if ($ilAccess->checkAccessOfUser($a_usr_id, $a_operation, '', $row->ref_id, $row->type, $row->obj_id)) {
                 $counter++;
                 $ref_ids[] = $row->ref_id;
             }
         }
         return $ref_ids ?: [];
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _sortIds()

static ilUtil::_sortIds	(	array	$a_ids,
		string	$a_table,
		string	$a_field,
		string	$a_id_name
	)

static

Function that sorts ids by a given table field using WHERE IN E.g: __sort(array(6,7),'usr_data','lastname','usr_id') => sorts by lastname.

Deprecated:

Definition at line 1218 of file class.ilUtil.php.

References $DIC, $ilDB, $res, ilDBConstants\FETCHMODE_OBJECT, and ilArrayUtil\quoteArray().

Referenced by ilObjRoleGUI\adoptPermObject(), ilMailSearchObjectGUI\cancel(), ilAppointmentPresentationCourseGUI\collectPropertiesAndActions(), ilObjSessionGUI\eventsListObject(), ilMemberExport\fetchUsers(), ilAttendanceList\getHTML(), ilCourseGroupingAssignmentTableGUI\getItems(), ilPermissionGUI\initRoleForm(), ilConsultationHoursTableGUI\parse(), ilLDAPSettingsGUI\prepareGlobalRoleSelection(), ilAuthShibbolethSettingsGUI\prepareRoleSelect(), ilECSSettingsGUI\prepareRoleSelect(), ilCASSettingsGUI\prepareRoleSelection(), ilSamlSettingsGUI\prepareRoleSelection(), and ilOpenIdConnectSettingsGUI\prepareRoleSelection().

                                                                                                       : array
     {
         global $DIC;
 
         $ilDB = $DIC->database();
 
         if (!$a_ids) {
             return [];
         }
 
         // use database to sort user array
         $where = "WHERE " . $a_id_name . " IN (";
         $where .= implode(",", ilArrayUtil::quoteArray($a_ids));
         $where .= ") ";
 
         $query = "SELECT " . $a_id_name . " FROM " . $a_table . " " .
             $where .
             "ORDER BY " . $a_field;
 
         $res = $ilDB->query($query);
         $ids = [];
         while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
             $ids[] = $row->$a_id_name;
         }
         return $ids;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ appendUrlParameterString()

static ilUtil::appendUrlParameterString	(	string	$a_url,
		string	$a_par,
		bool	$xml_style = `false`
	)

static

Deprecated:

Definition at line 380 of file class.ilUtil.php.

References $url.

Referenced by ilCmiXapiStatementsDeleteRequest\_lookUpDataCount(), ilObjectListGUI\appendRepositoryFrameParameter(), ilXapiCompliantStatementsReportLinkBuilder\appendRequestParameters(), ilCmiXapiAbstractReportLinkBuilder\appendRequestParameters(), assImagemapQuestionGUI\buildAreaLinkTarget(), ilCmiXapiLaunchGUI\buildLaunchLink(), ilPasswordAssistanceGUI\buildUrl(), ilAssQuestionHintRequestGUI\confirmRequestCmd(), ilStartUpGUI\doApacheAuthentication(), ilTestExpressPageObjectGUI\executeCommand(), ilObjTestGUI\executeCreateQuestionObject(), ilRTEGlobalTemplate\fillJavascriptFile(), ilGlobalTemplate\fillJavascriptFile(), ilDataCollectionGlobalTemplate\fillJavascriptFile(), ilAssQuestionHintsTableGUI\fillRow(), ilCmiXapiStatementsDeleteRequest\getBatchUrl(), ilObjQuestionPoolListGUI\getCommandLink(), ilObjTestListGUI\getCommandLink(), ilTestRandomQuestionSetSourcePoolDefinitionListTableGUI\getDeleteHref(), ilCmiXapiStatementsDeleteRequest\getDeleteStateUrls(), ilTestRandomQuestionSetSourcePoolDefinitionListTableGUI\getEditHref(), ILIAS\LearningModule\Menu\ilLMMenuGUI\getEntries(), ilIntLinkRepItemExplorerGUI\getNodeHref(), assImagemapQuestionGUI\getPreviousSolutionConfirmationCheckboxHtml(), ilAuthFrontendCredentialsApache\getTargetUrl(), ILIAS\StaticURL\Handler\LegacyGotoHandler\handle(), ilInitialisation\redirect(), ilInternalLinkGUI\renderLink(), ilPCQuestionGUI\setTabs(), and ilAuthFrontendCredentialsSoap\tryAuthenticationOnLoginPage().

                                                                                                           : string
     {
         $amp = $xml_style
             ? "&amp;"
             : "&";
 
         $url = (is_int(strpos($a_url, "?")))
             ? $a_url . $amp . $a_par
             : $a_url . "?" . $a_par;
 
         return $url;
     }

Here is the caller graph for this function:

◆ deducibleSize()

static ilUtil::deducibleSize ( string $a_mime )

static

checks if mime type is provided by getimagesize()

Deprecated:

Definition at line 928 of file class.ilUtil.php.

Referenced by ilObjMediaObject\_determineWidthHeight(), ilObjMediaObject\_saveTempFileAsMediaObject(), ilClipboardTableGUI\fillRow(), ilMediaPoolTableGUI\fillRow(), ilMediaItem\getOriginalSize(), and ilObjMediaPoolSubItemListGUI\parseImage().

                                                         : bool
     {
         if (($a_mime == "image/gif") || ($a_mime == "image/jpeg") ||
             ($a_mime == "image/png") || ($a_mime == "application/x-shockwave-flash") ||
             ($a_mime == "image/tiff") || ($a_mime == "image/x-ms-bmp") ||
             ($a_mime == "image/psd") || ($a_mime == "image/iff")) {
             return true;
         } else {
             return false;
         }
     }

Here is the caller graph for this function:

◆ deliverData()

static ilUtil::deliverData	(	string	$a_data,
		string	$a_filename,
		string	$mime = `"application/octet-stream"`
	)

static

Deprecated:: use ilFileDelivery

Definition at line 357 of file class.ilUtil.php.

References $DIC, and ILIAS\FileDelivery\Delivery\setMimeType().

Referenced by ilCSVTestExport\deliver(), ilCertificateUtilHelper\deliverData(), ilMemberExportGUI\deliverData(), ilObjTest\deliverPDFfromFO(), ilPublicUserProfileGUI\deliverVCard(), ilObjLanguageFolderGUI\downloadDeprecatedObject(), ilPRGMembersExportGUI\downloadExportFile(), ilMemberExportGUI\downloadExportFile(), ilObjLanguageExtGUI\downloadObject(), ilSurveyParticipantsGUI\exportAllCodesObject(), ilRegistrationSettingsGUI\exportCodes(), ilSurveyParticipantsGUI\exportCodesObject(), ilSessionOverviewGUI\exportCSV(), ilSurveyEvaluationGUI\exportCumulatedResults(), ilSurveyEvaluationGUI\exportEvaluationUser(), ilObjLinkResourceGUI\exportHTML(), ilObjAssessmentFolderGUI\exportLogObject(), ilDidacticTemplateSettingsGUI\exportTemplate(), ilCalendarRemoteAccessHandler\handleRequest(), ilForumExportGUI\printPost(), ilObjSCORMLearningModule\sendExportFile(), and ilChatroomHistoryGUI\showMessages().

      : void {
         global $DIC;
         $delivery = new Delivery(
             Delivery::DIRECT_PHP_OUTPUT,
             $DIC->http()
         );
         $delivery->setMimeType($mime);
         $delivery->setSendMimeType(true);
         $delivery->setDisposition(Delivery::DISP_ATTACHMENT);
         $delivery->setDownloadFileName($a_filename);
         $delivery->setConvertFileNameToAsci(true);
         $repsonse = $DIC->http()->response()->withBody(Streams::ofString($a_data));
         $DIC->http()->saveResponse($repsonse);
         $delivery->deliver();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ extractParameterString()

static ilUtil::extractParameterString ( string $a_parstr )

static

Deprecated:

Definition at line 849 of file class.ilUtil.php.

Referenced by ilPCMediaObjectGUI\saveAliasProperties(), and ilMediaItem\setParameters().

                                                                    : array
     {
         // parse parameters in array
         $par = [];
         $ok = true;
         while (($spos = strpos($a_parstr, "=")) && $ok) {
             // extract parameter
             $cpar = substr($a_parstr, 0, $spos);
             $a_parstr = substr($a_parstr, $spos, strlen($a_parstr) - $spos);
             while (substr($cpar, 0, 1) == "," || substr($cpar, 0, 1) == " " || substr($cpar, 0, 1) == chr(13) || substr(
                 $cpar,
                 0,
                 1
             ) == chr(10)) {
                 $cpar = substr($cpar, 1, strlen($cpar) - 1);
             }
             while (substr($cpar, strlen($cpar) - 1, 1) == " " || substr($cpar, strlen($cpar) - 1, 1) == chr(
                 13
             ) || substr($cpar, strlen($cpar) - 1, 1) == chr(10)) {
                 $cpar = substr($cpar, 0, strlen($cpar) - 1);
             }
 
             // parameter name should only
             $cpar_old = "";
             while ($cpar != $cpar_old) {
                 $cpar_old = $cpar;
                 $cpar = preg_replace("/[^a-zA-Z0-9_]/i", "", $cpar);
             }
 
             // extract value
             if ($cpar != "") {
                 if ($spos = strpos($a_parstr, "\"")) {
                     $a_parstr = substr($a_parstr, $spos + 1, strlen($a_parstr) - $spos);
                     $spos = strpos($a_parstr, "\"");
                     if (is_int($spos)) {
                         $cval = substr($a_parstr, 0, $spos);
                         $par[$cpar] = $cval;
                         $a_parstr = substr($a_parstr, $spos + 1, strlen($a_parstr) - $spos - 1);
                     } else {
                         $ok = false;
                     }
                 } else {
                     $ok = false;
                 }
             }
         }
 
         return $ok ? $par : [];
     }

Here is the caller graph for this function:

◆ fmtFloat()

static ilUtil::fmtFloat	(	float	$a_float,
		int	$a_decimals = `0`,
		string	$a_dec_point = `null`,
		string	$a_thousands_sep = `null`,
		bool	$a_suppress_dot_zero = `false`
	)

staticprotected

format a float

this functions takes php's number_format function and formats the given value with appropriate thousand and decimal separator.

Deprecated:

Definition at line 1384 of file class.ilUtil.php.

References $DIC, $lng, and $txt.

      : string {
         global $DIC;
 
         $lng = $DIC->language();
 
         if ($a_dec_point === null) {
             $a_dec_point = ".";
         }
         if ($a_dec_point === '-lang_sep_decimal-') {
             $a_dec_point = ".";
         }
 
         if ($a_thousands_sep === null) {
             $a_thousands_sep = $lng->txt('lang_sep_thousand');
         }
         if ($a_thousands_sep === '-lang_sep_thousand-') {
             $a_thousands_sep = ",";
         }
 
         $txt = number_format($a_float, $a_decimals, $a_dec_point, $a_thousands_sep);
 
         // remove trailing ".0"
         if (($a_suppress_dot_zero == 0 || $a_decimals == 0)
             && substr($txt, -2) == $a_dec_point . '0'
         ) {
             $txt = substr($txt, 0, strlen($txt) - 2);
         }
         if ($a_float == 0 and $txt == "") {
             $txt = "0";
         }
 
         return $txt;
     }

◆ formatSize()

static ilUtil::formatSize	(	int	$size,
		string	$a_mode = `'short'`,
		?ilLanguage	$a_lng = `null`
	)

static

Returns the specified file size value in a human friendly form.

By default, the oder of magnitude 1024 is used. Thus the value returned by this function is the same value that Windows and Mac OS X return for a file. The value is a GibiBig, MebiBit, KibiBit or byte unit.

For more information about these units see: http://en.wikipedia.org/wiki/Megabyte

Parameters

integer	size in bytes
string	mode: "short" is useful for display in the repository "long" is useful for display on the info page of an object
ilLanguage	The language object, or null if you want to use the system language.

Definition at line 1440 of file class.ilUtil.php.

References $DIC, and $lng.

Referenced by ilLMDownloadTableGUI\fillRow(), ilMemberExportFileTableGUI\fillRow(), ilDclExportTableGUI\fillRow(), ilExportTableGUI\fillRow(), ilFileSystemTableGUI\fillRow(), ilMailAttachmentTableGUI\formatValue(), ilMailAttachmentGUI\saveAttachments(), ilMailFormGUI\showForm(), and ilMailAttachmentGUI\uploadFile().

                                                                                                      : string
     {
         global $DIC;
 
         $lng = $DIC->language();
         if ($a_lng == null) {
             $a_lng = $lng;
         }
 
         $mag = 1024;
 
         if ($size >= $mag * $mag * $mag) {
             $scaled_size = $size / $mag / $mag / $mag;
             $scaled_unit = 'lang_size_gb';
         } else {
             if ($size >= $mag * $mag) {
                 $scaled_size = $size / $mag / $mag;
                 $scaled_unit = 'lang_size_mb';
             } else {
                 if ($size >= $mag) {
                     $scaled_size = $size / $mag;
                     $scaled_unit = 'lang_size_kb';
                 } else {
                     $scaled_size = $size;
                     $scaled_unit = 'lang_size_bytes';
                 }
             }
         }
 
         $result = self::fmtFloat(
             $scaled_size,
             ($scaled_unit
                     == 'lang_size_bytes') ? 0 : 1,
             $a_lng->txt('lang_sep_decimal'),
             $a_lng->txt('lang_sep_thousand'),
             true
         )
             . ' ' . $a_lng->txt($scaled_unit);
         if ($a_mode == 'long' && $size > $mag) {
             $result .= ' (' . self::fmtFloat(
                 $size,
                 0,
                 $a_lng->txt('lang_sep_decimal'),
                 $a_lng->txt('lang_sep_thousand')
             ) . ' '
                 . $a_lng->txt('lang_size_bytes') . ')';
         }
 
         return $result;
     }

Here is the caller graph for this function:

◆ getHtmlPath()

static ilUtil::getHtmlPath ( string $relative_path )

static

get url of path

Parameters

$relative_path string: complete path to file, relative to web root (e.g. /data/pfplms103/mobs/mm_732/athena_standing.jpg)

Deprecated:

Definition at line 120 of file class.ilUtil.php.

Referenced by ilObjMediaObject\_getURL(), SurveyTextQuestionGUI\getPrintView(), SurveySingleChoiceQuestionGUI\getPrintView(), SurveyMultipleChoiceQuestionGUI\getPrintView(), SurveyMatrixQuestionGUI\getPrintView(), assMultipleChoiceGUI\renderSolutionOutput(), assSingleChoiceGUI\renderSolutionOutput(), assKprimChoiceGUI\renderSolutionOutput(), and ilAuthFrontendCredentialsApache\tryAuthenticationOnLoginPage().

                                                              : string
     {
         if (substr($relative_path, 0, 2) == './') {
             $relative_path = (substr($relative_path, 1));
         }
         if (substr($relative_path, 0, 1) != '/') {
             $relative_path = '/' . $relative_path;
         }
         $htmlpath = ILIAS_HTTP_PATH . $relative_path;
         return $htmlpath;
     }

Here is the caller graph for this function:

◆ getImagePath()

static ilUtil::getImagePath	(	string	$img,
		string	$module_path = `""`,
		string	$mode = `"output"`,
		bool	$offline = `false`
	)

static

get image path (for images located in a template directory)

Deprecated:: use UI Service!

Definition at line 66 of file class.ilUtil.php.

References $DIC, ilStyleDefinition\getCurrentSkin(), and ilStyleDefinition\getCurrentStyle().

      : string {
         global $DIC;
 
         $styleDefinition = null;
         if (isset($DIC["styleDefinition"])) {
             $styleDefinition = $DIC["styleDefinition"];
         }
 
         if ($module_path != "") {
             $module_path = "/" . $module_path;
         }
 
         // default image
         $default_img = "." . $module_path . "/templates/default/images/" . $img;
 
         // use ilStyleDefinition instead of account to get the current skin and style
         $current_skin = ilStyleDefinition::getCurrentSkin();
         $current_style = ilStyleDefinition::getCurrentStyle();
 
         if (is_object($styleDefinition)) {
             $image_dir = $styleDefinition->getImageDirectory($current_style);
         } else {
             $image_dir = "images";
         }
 
         $skin_img = "";
 
         if ($current_skin == "default") {
             $skin_img = "." . $module_path . "/templates/default/" . $image_dir . "/" . $img;
         } elseif (is_object($styleDefinition) && $current_skin != "default") {
             $skin_img = "./Customizing/global/skin/" .
                 $current_skin . "/" . $current_style . "/" . $module_path . $image_dir . "/" . $img;
         }
 
         if ($offline) {
             return "./images/" . $img;
         } elseif (file_exists($skin_img)) {
             return $skin_img;        // found image for skin and style
         }
 
         return $default_img;            // take image in default
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getImageTagByType()

static ilUtil::getImageTagByType	(	string	$a_type,
		string	$a_path,
		bool	$a_big = `false`
	)

static

Builds an html image tag.

Deprecated:: Use UI-Service!

Definition at line 43 of file class.ilUtil.php.

References $DIC, $filename, $lng, and ilObject\_getIcon().

Referenced by ilObjTypeDefinitionGUI\displayList(), and ilObjTypeDefinitionGUI\editObject().

                                                                                                  : string
     {
         global $DIC;
 
         $lng = $DIC->language();
 
         $size = ($a_big)
             ? "big"
             : "small";
 
         $filename = ilObject::_getIcon(0, $size, $a_type);
 
         return "<img src=\"" . $filename . "\" alt=\"" . $lng->txt("obj_" . $a_type) . "\" title=\"" . $lng->txt(
             "obj_" . $a_type
         ) . "\" border=\"0\" vspace=\"0\"/>";
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getNewContentStyleSheetLocation()

static ilUtil::getNewContentStyleSheetLocation ( string $mode = "output" )

static

get full style sheet file name (path inclusive) of current user

Deprecated:

Definition at line 186 of file class.ilUtil.php.

References ilStyleDefinition\getCurrentSkin(), and ilStyleDefinition\getCurrentStyle().

Referenced by ilTinyMCE\addCustomRTESupport(), ilTinyMCE\addRTESupport(), ilTinyMCE\addUserTextEditor(), ilDataCollectionGlobalTemplate\fillNewContentStyle(), ilGlobalTemplate\fillNewContentStyle(), and ilGlobalPageTemplate\prepareBasicCSS().

                                                                                    : string
     {
 
         // use ilStyleDefinition instead of account to get the current skin and style
         if (ilStyleDefinition::getCurrentSkin() == "default") {
             $in_style = "./templates/" . ilStyleDefinition::getCurrentSkin() . "/"
                 . ilStyleDefinition::getCurrentStyle() . "_cont.css";
         } else {
             $in_style = "./Customizing/global/skin/" . ilStyleDefinition::getCurrentSkin() . "/"
                 . ilStyleDefinition::getCurrentStyle() . "_cont.css";
         }
 
         if (is_file("./" . $in_style)) {
             return $in_style;
         } else {
             return "templates/default/delos_cont.css";
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getSecureTags()

static ilUtil::getSecureTags ( )

static

Definition at line 479 of file class.ilUtil.php.

Referenced by ilAssSelfAssessmentQuestionFormatter\getSelfAssessmentTags(), and secureString().

                                           : array
     {
         return ["strong",
                 "em",
                 "u",
                 "strike",
                 "ol",
                 "li",
                 "ul",
                 "p",
                 "div",
                 "i",
                 "b",
                 "code",
                 "sup",
                 "sub",
                 "pre",
                 "gap",
                 "a",
                 "img",
                 "bdo"
         ];
     }

Here is the caller graph for this function:

◆ getStyleSheetLocation()

static ilUtil::getStyleSheetLocation	(	string	$mode = `"output"`,
		string	$a_css_name = `""`,
		string	$a_css_location = `""`
	)

static

get full style sheet file name (path inclusive) of current user

Parameters

$mode	string Output mode of the style sheet ("output" or "filesystem"). !"filesystem" generates the ILIAS version number as attribute to force the reload of the style sheet in a different ILIAS version
$a_css_name	string The name of the style sheet. If empty, the default style name will be chosen
$a_css_location	string The location of the style sheet e.g. a module path. This parameter only makes sense when $a_css_name is used

Deprecated:

Definition at line 142 of file class.ilUtil.php.

References $DIC, $filename, $ilSetting, ilStyleDefinition\getCurrentSkin(), ilStyleDefinition\getCurrentStyle(), and ilStyleDefinition\getSkins().

Referenced by ilExport\_generateIndexFile(), ilTinyMCE\addRTESupport(), ilTinyMCE\addUserTextEditor(), ilSCORMPresentationGUI\contentSelect(), ilObjTest\deliverPDFfromHTML(), ilTestEvaluationGUI\detailedEvaluation(), ilPageObjectGUI\displayMedia(), ilObjSurveyQuestionPoolGUI\executeCommand(), ilSCORMPresentationGUI\explorer(), ilSystemStyleHTMLExport\export(), ILIAS\COPage\Page\PageQueryActionHandler\getConfig(), ILIAS\Notes\Export\NotesHtmlExport\getInitialisedTemplate(), ILIAS\Portfolio\Export\PortfolioHtmlExport\getInitialisedTemplate(), ILIAS\Blog\Export\BlogHtmlExport\getInitialisedTemplate(), ilExplorer\getOutput(), ilSCORM13PlayerGUI\getPlayer(), ilCOPageHTMLExport\getPreparedMainTemplate(), assMatchingQuestionGUI\getPreview(), ilObjQuestionPoolGUI\getQueryParamInt(), ilPlugin\getStyleSheetLocation(), assMatchingQuestionGUI\getTestOutput(), ilCOPageHTMLExport\initResourceTemplate(), ILIAS\Glossary\Export\GlossaryHtmlExport\initScreen(), ILIAS\LearningModule\Export\LMHtmlExport\initScreen(), ilLMPresentationGUI\layout(), ilGlossaryPresentationGUI\media(), ilTestServiceGUI\outCorrectSolution(), ilTestPlayerAbstractGUI\outCorrectSolution(), ilLMPresentationGUI\page(), ilGlobalPageTemplate\prepareBasicCSS(), ilTestEvaluationGUI\prepareContentForPrint(), ilObjTestGUI\printObject(), ilForumExportGUI\printPost(), ilForumExportGUI\printThread(), ilPortfolioPageGUI\renderConsultationHours(), ILIAS\Export\PrintProcessGUI\renderPrintView(), ilObjTestGUI\reviewobject(), ilTestEvaluationGUI\setCss(), ilLMPresentationGUI\setSystemStyle(), ilInternalLinkGUI\showLinkHelp(), ilContainerGUI\showLinkListObject(), ilTestPlayerAbstractGUI\showListOfAnswers(), ilObjMediaPoolGUI\showMedia(), ilPageObjectGUI\showMediaFullscreen(), ilObjMediaPoolGUI\showPage(), ilParticipantsTestResultsGUI\showUserResults(), ilSCORM13PlayerGUI\specialPage(), ilSAHSPresentationGUI\view(), and ilSCORMPresentationGUI\view().

      : string {
         global $DIC;
 
         $ilSetting = $DIC->settings();
 
         // add version as parameter to force reload for new releases
         // use ilStyleDefinition instead of account to get the current style
 
         $stylesheet_name = (strlen($a_css_name))
             ? $a_css_name
             : ilStyleDefinition::getCurrentStyle() . ".css";
         if (strlen($a_css_location) && (strcmp(substr($a_css_location, -1), "/") != 0)) {
             $a_css_location = $a_css_location . "/";
         }
 
         $filename = "";
         // use ilStyleDefinition instead of account to get the current skin
         if (ilStyleDefinition::getCurrentSkin() != "default") {
             $filename = "./Customizing/global/skin/" . ilStyleDefinition::getCurrentSkin(
             ) . "/" . ilStyleDefinition::getCurrentStyle() . "/" . $a_css_location . $stylesheet_name;
         }
         if (strlen($filename) == 0 || !file_exists($filename)) {
             $filename = "./" . $a_css_location . "templates/default/" . $stylesheet_name;
         }
         $skin_version_appendix = "";
         if ($mode !== "filesystem") {
             // use version from template xml to force reload on changes
             $skin = ilStyleDefinition::getSkins()[ilStyleDefinition::getCurrentSkin()];
             $skin_version = $skin->getVersion();
             $skin_version_appendix .= ($skin_version !== '' ? str_replace(".", "-", $skin_version) : '0');
             $skin_version_appendix = "?skin_version=" . $skin_version_appendix;
         }
         return $filename . $skin_version_appendix;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getSystemMessageHTML()

static ilUtil::getSystemMessageHTML	(	string	$a_txt,
		string	$a_type = `"info"`
	)

static

Get HTML for a system message.

Deprecated:: replace with UI Compoenten in ilGlobalPageTemplate ATTENTION: This method is deprecated. Use MessageBox from the UI-framework instead.

Definition at line 1252 of file class.ilUtil.php.

References $DIC.

Referenced by ilGroupAddToGroupActionGUI\addUser(), ilTestPasswordProtectionGUI\buildPasswordMsg(), ilGroupAddToGroupActionGUI\confirmAddUser(), ilGroupAddToGroupActionGUI\confirmCreateGroupAndAddUser(), ilObjStudyProgrammeTreeGUI\create(), ilGroupAddToGroupActionGUI\createGroup(), ilGroupAddToGroupActionGUI\createGroupAndAddUser(), ilDataCollectionGlobalTemplate\fillMessage(), ilGlobalTemplate\fillMessage(), ilClassificationBlockGUI\filterContainer(), ilCalendarAgendaListGUI\getHTML(), ilTaggingGUI\getHTML(), ilNoteGUI\getNoteListHTML(), ilInternalLinkGUI\getUserSearchResult(), ilAsyncNotifications\initJs(), ilDclRecordEditGUI\save(), ilGroupAddToGroupActionGUI\selectParent(), ilDclRecordEditGUI\sendFailure(), and ilGroupAddToGroupActionGUI\show().

     {
         global $DIC;
 
         $box_factory = $DIC->ui()->factory()->messageBox();
         switch ($a_type) {
             case 'info':
                 $box = $box_factory->info($a_txt);
                 break;
             case 'success':
                 $box = $box_factory->success($a_txt);
                 break;
             case 'question':
                 $box = $box_factory->confirmation($a_txt);
                 break;
             case 'failure':
                 $box = $box_factory->failure($a_txt);
                 break;
             default:
                 throw new InvalidArgumentException();
         }
 
         return $DIC->ui()->renderer()->render($box);
     }

Here is the caller graph for this function:

◆ groupNameExists()

static ilUtil::groupNameExists	(	string	$a_group_name,
		?int	$a_id = `null`
	)

static

checks if group name already exists.

Groupnames must be unique for mailing purposes static function

public

Parameters

string	groupname
integer	obj_id of group to exclude from the check.

Returns: boolean true if exists

Definition at line 980 of file class.ilUtil.php.

References $DIC, $ilDB, $ilErr, $message, $q, and $r.

Referenced by ilGroupNameAsMailValidator\__construct(), ilMailAddressTypeHelperImpl\doesGroupNameExists(), and ilSoapGroupAdministration\groupExists().

                                                                                    : bool
     {
         global $DIC;
 
         $ilDB = $DIC->database();
 
         $ilErr = null;
         if (isset($DIC["ilErr"])) {
             $ilErr = $DIC["ilErr"];
         }
 
         if (empty($a_group_name)) {
             $message = __METHOD__ . ": No groupname given!";
             $ilErr->raiseError($message, $ilErr->WARNING);
         }
 
         $clause = ($a_id !== null) ? " AND obj_id != " . $ilDB->quote($a_id) . " " : "";
 
         $q = "SELECT obj_id FROM object_data " .
             "WHERE title = " . $ilDB->quote($a_group_name, "text") . " " .
             "AND type = " . $ilDB->quote("grp", "text") .
             $clause;
 
         $r = $ilDB->query($q);
 
         return $r->numRows() > 0;
     }

Here is the caller graph for this function:

◆ htmlencodePlainString()

static ilUtil::htmlencodePlainString	(	string	$a_str,
		bool	$a_make_links_clickable,
		bool	$a_detect_goto_links = `false`
	)

static

Encodes a plain text string into HTML for display in a browser.

This function encodes HTML special characters: < > & with < > & and converts newlines into

If $a_make_links_clickable is set to true, URLs in the plain string which are considered to be safe, are made clickable.

Parameters

string	the plain text string
boolean	set this to true, to make links in the plain string clickable.
boolean	set this to true, to detect goto links

Definition at line 593 of file class.ilUtil.php.

References makeClickable().

Referenced by ilMailFolderGUI\confirmDeleteMails(), and ilMailFolderTableGUI\fetchTableData().

      : string {
         $encoded = "";
 
         if ($a_make_links_clickable) {
             // Find text sequences in the plain text string which match
             // the URI syntax rules, and pass them to ilUtil::makeClickable.
             // Encode all other text sequences in the plain text string using
             // htmlspecialchars and nl2br.
             // The following expressions matches URI's as specified in RFC 2396.
             //
             // The expression matches URI's, which start with some well known
             // schemes, like "http:", or with "www.". This must be followed
             // by at least one of the following RFC 2396 expressions:
             // - alphanum:           [a-zA-Z0-9]
             // - reserved:           [;\/?:|&=+$,]
             // - mark:               [\\-_.!~*\'()]
             // - escaped:            %[0-9a-fA-F]{2}
             // - fragment delimiter: #
             // - uric_no_slash:      [;?:@&=+$,]
             $matches = [];
             $numberOfMatches = preg_match_all(
                 '/(?:(?:http|https|ftp|ftps|mailto):|www\.)(?:[a-zA-Z0-9]|[;\/?:|&=+$,]|[\\-_.!~*\'()]|%[0-9a-fA-F]{2}|#|[;?:@&=+$,])+/',
                 $a_str,
                 $matches,
                 PREG_OFFSET_CAPTURE
             );
             $pos1 = 0;
             $encoded = "";
 
             foreach ($matches[0] as $match) {
                 $matched_text = $match[0];
                 $pos2 = $match[1];
 
                 // encode plain text
                 $encoded .= nl2br(htmlspecialchars(substr($a_str, $pos1, $pos2 - $pos1)));
 
                 // encode URI
                 $encoded .= ilUtil::makeClickable($matched_text, $a_detect_goto_links);
 
 
                 $pos1 = $pos2 + strlen($matched_text);
             }
             if ($pos1 < strlen($a_str)) {
                 $encoded .= nl2br(htmlspecialchars(substr($a_str, $pos1)));
             }
         } else {
             $encoded = nl2br(htmlspecialchars($a_str));
         }
         return $encoded;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ img()

static ilUtil::img	(	string	$a_src,
		?string	$a_alt = `null`,
			$a_width = `""`,
			$a_height = `""`,
			$a_border = `0`,
			$a_id = `""`,
			$a_class = `""`
	)

static

Build img tag.

Deprecated:

Definition at line 324 of file class.ilUtil.php.

       {
         $img = '<img src="' . $a_src . '"';
         if (!is_null($a_alt)) {
             $img .= ' alt="' . htmlspecialchars($a_alt) . '"';
         }
         if ($a_width != "") {
             $img .= ' width="' . htmlspecialchars($a_width) . '"';
         }
         if ($a_height != "") {
             $img .= ' height="' . htmlspecialchars($a_height) . '"';
         }
         if ($a_class != "") {
             $img .= ' class="' . $a_class . '"';
         }
         if ($a_id != "") {
             $img .= ' id="' . $a_id . '"';
         }
         $img .= ' />';
 
         return $img;
     }

Here is the caller graph for this function:

◆ insertInstIntoID()

static ilUtil::insertInstIntoID ( string $a_value )

static

inserts installation id into ILIAS id

e.g. "il__pg_3" -> "il_43_pg_3"

Deprecated:

Definition at line 960 of file class.ilUtil.php.

References IL_INST_ID.

Referenced by ilObjQuestionPool\modifyExportIdentifier(), ilObjMediaObject\modifyExportIdentifier(), ilObjTest\modifyExportIdentifier(), and ilMediaObjectDataSet\readData().

                                                             : string
     {
         if (substr($a_value, 0, 4) == "il__") {
             $a_value = "il_" . IL_INST_ID . "_" . substr($a_value, 4, strlen($a_value) - 4);
         }
 
         return $a_value;
     }

Here is the caller graph for this function:

◆ is_email()

static ilUtil::is_email	(	string	$a_email,
		ilMailRfc822AddressParserFactory	$mailAddressParserFactory = `null`
	)

static

This preg-based function checks whether an e-mail address is formally valid.

It works with all top level domains including the new ones (.biz, .info, .museum etc.) and the special ones (.arpa, .int etc.) as well as with e-mail addresses based on IPs (e.g. webma.nosp@m.ster.nosp@m.@123..nosp@m.45.1.nosp@m.23.45) Valid top level domains: http://data.iana.org/TLD/tlds-alpha-by-domain.txt

Deprecated:: use ilMailRfc822AddressParserFactory directly

Definition at line 278 of file class.ilUtil.php.

References Vendor\Package\$e, and ilMail\ILIAS_HOST.

Referenced by ilEMailInputGUI\checkInput(), ilPasswordAssistanceGUI\emailTrafo(), ilCmiXapiUser\getIdent(), ilMimeMailNotification\initLanguage(), ilSurveyExecutionGUI\mailUserResults(), ilObjSurveyGUI\mailUserResultsObject(), ilObjSurvey\updateCode(), ILIAS\Survey\Code\CodeDBRepo\updateExternalData(), ilCalendarUserNotification\validate(), and ilObjCourse\validateInfoSettings().

      : bool {
         if ($mailAddressParserFactory === null) {
             $mailAddressParserFactory = new ilMailRfc822AddressParserFactory();
         }
 
         try {
             $parser = $mailAddressParserFactory->getParser($a_email);
             $addresses = $parser->parse();
             return count($addresses) == 1 && $addresses[0]->getHost() != ilMail::ILIAS_HOST;
         } catch (ilException $e) {
             return false;
         }
     }

Here is the caller graph for this function:

◆ isHTML()

static ilUtil::isHTML ( string $a_text )

static

Checks if a given string contains HTML or not.

Parameters

string $a_text Text which should be checked

Returns: boolean public

Definition at line 1164 of file class.ilUtil.php.

Referenced by assQuestionExport\addQTIMaterial(), assTextQuestion\getSolutionSubmit(), ilAssSelfAssessmentQuestionFormatter\handleLineBreaks(), ilLegacyFormElementsUtil\prepareTextareaOutput(), and assMatchingQuestionExport\toXML().

                                                  : bool
     {
         if (strlen(strip_tags($a_text)) < strlen($a_text)) {
             return true;
         }
 
         return false;
     }

Here is the caller graph for this function:

◆ isLogin()

static ilUtil::isLogin ( string $a_login )

static

Deprecated:

Definition at line 298 of file class.ilUtil.php.

Referenced by ilUserLoginInputGUI\checkInput(), ilAuthProviderApache\doAuthentication(), ilAccountRegistrationGUI\saveForm(), and ilPersonalProfileGUI\updateLoginOrSetErrorMessages().

                                                    : bool
     {
         if (empty($a_login)) {
             return false;
         }
 
         if (strlen($a_login) < 3) {
             return false;
         }
 
         // FIXME - If ILIAS is configured to use RFC 822
         //         compliant mail addresses we should not
         //         allow the @ character.
         if (!preg_match("/^[A-Za-z0-9_\.\+\*\@!\$\%\~\-]+$/", $a_login)) {
             return false;
         }
 
         return true;
     }

Here is the caller graph for this function:

◆ isWindows()

static ilUtil::isWindows ( )

static

Deprecated:

Definition at line 1011 of file class.ilUtil.php.

Referenced by ilGitInformation\detect(), ilShellUtil\execQuoted(), and ilImagemapPreview\execQuoted().

                                       : bool
     {
         return (strtolower(substr(php_uname(), 0, 3)) === "win");
     }

Here is the caller graph for this function:

◆ makeClickable()

static ilUtil::makeClickable	(	string	$a_text,
		bool	$detectGotoLinks = `false`
	)

static

Deprecated:: Use the respective Refinery transformation $refinery->string()->makeClickable("foo bar") to convert URL-like string parts to an HTML anchor (<a>) element.

Will be removed in ILIAS 10.

Definition at line 224 of file class.ilUtil.php.

References $DIC.

Referenced by ilAppointmentPresentationGUI\addEventDescription(), ilAppointmentPresentationGroupGUI\collectPropertiesAndActions(), ilAppointmentPresentationCourseGUI\collectPropertiesAndActions(), ilAppointmentPresentationSessionGUI\collectPropertiesAndActions(), ilCourseRegistrationGUI\fillInformations(), ilGroupRegistrationGUI\fillInformations(), ilPDNewsTableGUI\fillRow(), ilADTExternalLinkPresentationBridge\getHTML(), ilCalendarAppointmentPanelGUI\getHTML(), ilPDMailGUI\getPDMailHTML(), htmlencodePlainString(), ilObjCourseGUI\infoScreen(), ilObjGroupGUI\infoScreen(), ilPDNewsTableGUI\makeClickable(), ilNewsForContextBlockGUI\makeClickable(), ilObjSessionGUI\showJoinRequestButton(), ilUtilTest\testMakeClickableWithGotoLinksAndInvalidRefId(), and ilUtilTest\testMakeClickableWithoutGotoLinks().

                                                                                        : string
     {
         global $DIC;
 
         $ret = $DIC->refinery()->string()->makeClickable()->transform($a_text);
 
         if ($detectGotoLinks) {
             $goto = '<a[^>]*href="(' . str_replace('@', '\@', ILIAS_HTTP_PATH) . '/goto';
             $regExp = $goto . '.php\?target=\w+_(\d+)[^"]*)"[^>]*>[^<]*</a>';
             $ret = preg_replace_callback(
                 '@' . $regExp . '@i',
                 [self::class, 'replaceLinkProperties'],
                 $ret
             );
 
             // Edited this regex to allow multiple links in $ret: .* to [^"><]*.
             $regExp = $goto . '_[^"><]*[a-z0-9]+_([0-9]+)\.html)"[^>]*>[^<]*</a>';
             $ret = preg_replace_callback(
                 '@' . $regExp . '@i',
                 [self::class, 'replaceLinkProperties'],
                 $ret
             );
         }
 
         return $ret;
     }

Here is the caller graph for this function:

◆ maskAttributeTag()

static ilUtil::maskAttributeTag	(	string	$a_str,
		string	$tag,
		string	$tag_att
	)

staticprivate

Definition at line 648 of file class.ilUtil.php.

References $DIC.

Referenced by maskSecureTags().

                                                                                          : string
     {
         global $DIC;
 
         $ilLog = $DIC["ilLog"];
 
         $ws = "[\s]*";
         $att = $ws . "[^>]*" . $ws;
 
         while (preg_match(
             '/<(' . $tag . $att . '(' . $tag_att . $ws . '="' . $ws . '(([$@!*()~;,_0-9A-z\/:=%.&#?+\-])*)")' . $att . ')>/i',
             $a_str,
             $found
         )) {
             $old_str = $a_str;
             $a_str = preg_replace(
                 "/<" . preg_quote($found[1], "/") . ">/i",
                 '&lt;' . $tag . ' ' . $tag_att . $tag_att . '="' . $found[3] . '"&gt;',
                 $a_str
             );
             if ($old_str == $a_str) {
                 $ilLog->write(
                     "ilUtil::maskA-" . htmlentities($old_str) . " == " .
                     htmlentities($a_str)
                 );
                 return $a_str;
             }
         }
         $a_str = str_ireplace(
             "</$tag>",
             "&lt;/$tag&gt;",
             $a_str
         );
         return $a_str;
     }

Here is the caller graph for this function:

◆ maskSecureTags()

static ilUtil::maskSecureTags	(	string	$a_str,
		array	$allow_array
	)

staticprivate

Definition at line 503 of file class.ilUtil.php.

References maskAttributeTag(), and maskTag().

Referenced by secureString().

                                                                              : string
     {
         foreach ($allow_array as $t) {
             switch ($t) {
                 case "a":
                     $a_str = ilUtil::maskAttributeTag($a_str, "a", "href");
                     break;
 
                 case "img":
                     $a_str = ilUtil::maskAttributeTag($a_str, "img", "src");
                     break;
 
                 case "p":
                 case "div":
                     $a_str = ilUtil::maskTag($a_str, $t, [
                         ["param" => "align", "value" => "left"],
                         ["param" => "align", "value" => "center"],
                         ["param" => "align", "value" => "justify"],
                         ["param" => "align", "value" => "right"]
                     ]);
                     break;
 
                 default:
                     $a_str = ilUtil::maskTag($a_str, $t);
                     break;
             }
         }
 
         return $a_str;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ maskTag()

static ilUtil::maskTag	(	string	$a_str,
		string	$tag,
		array	$fix_param = `[]`
	)

static

Definition at line 713 of file class.ilUtil.php.

Referenced by maskSecureTags().

                                                                                      : string
     {
         $a_str = str_replace(
             ["<$tag>", "<" . strtoupper($tag) . ">"],
             "&lt;" . $tag . "&gt;",
             $a_str
         );
         $a_str = str_replace(
             ["</$tag>", "</" . strtoupper($tag) . ">"],
             "&lt;/" . $tag . "&gt;",
             $a_str
         );
 
         foreach ($fix_param as $p) {
             $k = $p["param"];
             $v = $p["value"];
             $a_str = str_replace(
                 "<$tag $k=\"$v\">",
                 "&lt;" . "$tag $k=\"$v\"" . "&gt;",
                 $a_str
             );
         }
 
         return $a_str;
     }

Here is the caller graph for this function:

◆ now()

static ilUtil::now ( )

static

Return current timestamp in Y-m-d H:i:s format.

Deprecated:

Definition at line 1021 of file class.ilUtil.php.

Referenced by ilHistory\_copyEntriesForObject(), ilHistory\_createEntry(), ilLMPageObject\_getPresentationTitle(), ilObjSCORMTracking\_insertTrackData(), ilLMTracker\_isNodeVisible(), ilPageObject\_lookupActive(), ilObjUser\_setUserInactive(), ilObjUser\_toggleActiveStatusOfUsers(), ilWikiContributor\_writeStatus(), ilLikeData\addExpression(), ilExSubmission\addFileUpload(), ILIAS\Skill\Profile\SkillProfileCompletionDBRepository\addFulfilmentEntry(), ilSkillLevelDBRepository\addLevel(), ILIAS\Skill\Profile\SkillProfileCompletionDBRepository\addNonFulfilmentEntry(), ilExSubmission\addResourceObject(), ilRepositoryObjectPlugin\beforeActivation(), ilBlogPosting\create(), ilNewsItem\create(), ilWebDAVMountInstructionsDocumentFormGUI\createFilledObject(), ilPRGAssignmentDBRepository\createFor(), ilPageObject\createFromXML(), ILIAS\Notes\NotesManager\createNote(), ILIAS\Test\Setup\CloneIntroductionAndClosingRemarksMigration\createPageWithNextId(), ilAuthProviderLTI\createUser(), ilPageActivationDBRepository\getData(), ilCalendarHeaderNavigationGUI\getHTML(), ilNewsItem\getLastNewsIdForContext(), ilLMNavigationStatus\getPredecessorPageId(), ilWikiUserHTMLExport\getProcess(), ilLMNavigationStatus\getSuccessorPageId(), ilSkillUserLevelDBRepository\hasRecentSelfEvaluation(), ilLMContentRendererGUI\renderDeactivatedPageMessage(), ilSkillUserLevelDBRepository\resetUserSkillLevelStatus(), ilObjUser\saveAsNew(), ilObjForum\saveData(), ilUserProfilePromptDataGateway\saveLastUserPrompt(), ilExAssignmentMemberStatus\setFeedback(), ilExAssignmentMemberStatus\setMark(), ilExAssignmentMemberStatus\setSent(), ilExAssignmentMemberStatus\setStatus(), ilUserProfileStartUpStep\shouldInterceptRequest(), ilObjSCORMTracking\storeJsApiCmi(), ilLMTracker\trackLastPageAccess(), ilBlogPosting\unpublish(), ilObjUser\update(), ilNewsItem\update(), ilPageObject\update(), ilPageObject\updateFromXML(), ILIAS\Notes\NoteDBRepository\updateNoteText(), ilExPeerReview\updatePeerReview(), ilExPeerReview\updatePeerReviewTimestamp(), ilExSubmission\updateTextSubmission(), ilExSubmission\updateTutorDownloadTime(), ILIAS\Exercise\Submission\SubmissionDBRepository\updateWebDirAccessTime(), ilExSubmission\uploadFile(), ilPageObject\writeRenderedContent(), and ilSkillUserLevelDBRepository\writeUserSkillLevelStatus().

                                 : string
     {
         return date("Y-m-d H:i:s");
     }

Here is the caller graph for this function:

◆ parseImportId()

static ilUtil::parseImportId ( string $a_import_id )

static

Parse an ilias import id Typically of type il_[IL_INST_ID]_[OBJ_TYPE]_[OBJ_ID] returns array( 'orig' => 'il_4800_rolt_123' 'prefix' => 'il' 'inst_id => '4800' 'type' => 'rolt' 'id' => '123'.

Deprecated:

Definition at line 1356 of file class.ilUtil.php.

References ILIAS\Repository\int().

Referenced by ilQuestionPageParser\buildTag(), ilECSEnrolmentStatusCommandQueueHandler\handleCreate(), ilAdvancedMDRecordParser\handlerBeginTag(), ilQuestionPageParser\handlerEndTag(), and ilAdvancedMDFieldDefinitionInternalLink\importValueFromXML().

                                                              : array
     {
         $exploded = explode('_', $a_import_id);
 
         $parsed['orig'] = $a_import_id;
         if ($exploded[0] == 'il') {
             $parsed['prefix'] = $exploded[0];
         }
         if (is_numeric($exploded[1])) {
             $parsed['inst_id'] = (int) $exploded[1];
         }
         $parsed['type'] = $exploded[2];
 
         if (is_numeric($exploded[3])) {
             $parsed['id'] = (int) $exploded[3];
         }
         return $parsed;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ redirect()

static ilUtil::redirect ( string $a_script )

static

Deprecated:: Use $DIC->ctrl()->redirectToURL() instead

Definition at line 943 of file class.ilUtil.php.

References $DIC, and init().

Referenced by ilLearningProgressGUI\__getNextClass(), ilObjItemGroupGUI\_goto(), ilObjLearningSequence\_goto(), ilObjPollGUI\_goto(), ilObjGroupGUI\_goto(), ilObjLinkResourceGUI\_goto(), ilObjSystemFolderGUI\_goto(), ilObjCourseGUI\_goto(), ilCourseRegistrationGUI\add(), ilGroupRegistrationGUI\add(), ilObjLinkResourceGUI\afterSave(), ilObjMediaCastGUI\afterSave(), ilObjSurveyGUI\afterSave(), ilObjOrgUnitGUI\afterSave(), ilObjWikiGUI\afterSave(), ilObjSurveyQuestionPoolGUI\afterSave(), ilObjMediaPoolGUI\afterSave(), ilObjLearningSequenceGUI\afterSave(), ilObjQuestionPoolGUI\afterSave(), ilObjCourseGUI\afterSave(), ilTestPlayerAbstractGUI\afterTestPassFinishedCmd(), ilSurveyExecutionGUI\backToRepository(), ilObjTestGUI\backToRepositoryObject(), ilLMPageObjectGUI\cancel(), SurveyQuestionGUI\cancel(), assQuestionGUI\cancel(), ilMailFormGUI\cancelMail(), ilSharedResourceGUI\cancelPassword(), ilSessionControl\checkCurrentSessionIsAllowed(), ilContainerStartObjectsGUI\checkPermission(), ilInternalLinkGUI\closeLinkHelp(), ilObjectCopyGUI\copyMultipleNonContainer(), ilObjMediaPoolGUI\createMediaFromUploadDir(), ilNewsItem\deliverMobFile(), ilImageMapEditorGUI\editImagemapForward(), ilErrorHandling\errorHandler(), ilSAHSEditGUI\executeCommand(), ilTestExpressPageObjectGUI\executeCommand(), ilDashboardGUI\executeCommand(), ilObjMediaPoolGUI\executeCommand(), ilCalendarPresentationGUI\executeCommand(), ilObjTestGUI\executeCreateQuestionObject(), ilLTIViewGUI\getContextId(), ilPublicUserProfileGUI\getHTML(), ilObjWikiGUI\gotoPageObject(), ilObjItemGroupGUI\gotoParent(), ilObjWikiGUI\gotoStartPageObject(), ilMembershipRegistrationCodeUtils\handleCode(), ilTestExpressPageObjectGUI\handleToolbarCommand(), ilSharedResourceGUI\hasAccess(), ilObjSurveyQuestionPoolGUI\importFileObject(), ilObjSurveyGUI\importSurveyObject(), ilObjQuestionPoolGUI\importVerifiedFileObject(), ilObjTestGUI\importVerifiedFileObject(), ilEditClipboardGUI\insert(), ilMailingListsGUI\mailToList(), ilObjRoleGUI\mailToRoleObject(), ilObjSCORMLearningModuleGUI\newModuleVersionUpload(), ilTestExpressPageObjectGUI\nextQuestion(), ilExerciseManagementGUI\openSubmissionViewObject(), ilAssQuestionHintRequestGUI\performRequestCmd(), ilObjLearningSequenceLearnerGUI\play(), ilTestExpressPageObjectGUI\prevQuestion(), ilStartUpGUI\processIndexPHP(), ilObjQuestionPoolGUI\questionsObject(), ilObjTestGUI\questionsObject(), ilShibbolethWAYF\redirect(), ilInitialisation\redirect(), SurveyQuestionGUI\redirectAfterSaving(), ilExerciseManagementGUI\redirectFeedbackMailObject(), ilObjCourseGUI\redirectLocToTestConfirmedObject(), ilObjCourseGUI\redirectLocToTestObject(), ilBookingReservationsGUI\redirectMailToBooker(), ilPortfolioRepositoryGUI\redirectSendMailToSharer(), ilObjLinkResourceGUI\redirectToLink(), ilTestExpressPageObjectGUI\redirectToQuestionPoolSelectionPage(), ilContentStyleSettingsGUI\saveActiveStyles(), ilMailFormGUI\saveDraft(), assQuestionGUI\saveEdit(), ilPersonalSettingsGUI\savePassword(), ilPersonalProfileGUI\savePublicProfile(), ilContentStyleSettingsGUI\saveScope(), ilLPTableBaseGUI\sendMail(), ilObjContentObjectGUI\sendMailToBlockedUsers(), ilMembershipGUI\sendMailToSelectedUsers(), ilObjAuthSettingsGUI\setAuthModeObject(), ilObjFileBasedLMGUI\showLearningModule(), ilTestOutputGUI\submitSolutionCmd(), ilObjPollGUI\subscribe(), ilContentStyleSettingsGUI\toggleGlobalDefault(), ilContentStyleSettingsGUI\toggleGlobalFixed(), ilObjPortfolioGUI\toRepository(), ilObjPollGUI\unsubscribe(), ilObjSAHSLearningModuleGUI\uploadObject(), and ilObjPollGUI\vote().

                                                      : void
     {
         global $DIC;
 
         if (!isset($DIC['ilCtrl']) || !$DIC['ilCtrl'] instanceof ilCtrl) {
             (new InitCtrlService())->init($DIC);
         }
         $DIC->ctrl()->redirectToURL($a_script);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ replaceLinkProperties()

static ilUtil::replaceLinkProperties ( array $matches )

staticprivate

Definition at line 251 of file class.ilUtil.php.

References $DIC, $ref_id, and ILIAS\Repository\int().

                                                                  : string
     {
         global $DIC;
         $cache = $DIC['ilObjDataCache'];
 
         $link = $matches[0];
         $ref_id = (int) $matches[2];
         if ($ref_id > 0) {
             $obj_id = $cache->lookupObjId($ref_id);
             if ($obj_id > 0) {
                 $title = $cache->lookupTitle($obj_id);
                 $link = '<a href="' . $matches[1] . '" target="_self">' . $title . '</a>';
             }
         }
 
         return $link;
     }

Here is the call graph for this function:

◆ secureLink()

static ilUtil::secureLink ( string $a_str )

static

Deprecated:

Definition at line 759 of file class.ilUtil.php.

Referenced by ilObjMediaObjectGUI\savePropertiesObject(), ilObjMediaObjectGUI\setObjectPerCreationForm(), and unmaskAttributeTag().

                                                     : string
     {
         $a_str = str_ireplace("javascript", "jvscrpt", $a_str);
         $a_str = str_ireplace(["%00",
                                "%0a",
                                "%0d",
                                "%1a",
                                "&#00;",
                                "&#x00;",
                                "&#0;",
                                "&#x0;",
                                "&#x0a;",
                                "&#x0d;",
                                "&#10;",
                                "&#13;"
         ], "-", $a_str);
         return $a_str;
     }

Here is the caller graph for this function:

◆ securePlainString()

static ilUtil::securePlainString ( string $a_str )

static

Deprecated:

Definition at line 568 of file class.ilUtil.php.

Referenced by ilMailFormGUI\editAttachments(), ilPDMailGUI\getPDMailHTML(), ilMailFormGUI\saveDraft(), ilMailFormGUI\saveMailBeforeSearch(), ilMailFormGUI\search(), ilMailFormGUI\searchUsers(), ilMailFormGUI\sendMessage(), and ilMailFormGUI\showForm().

                                                            : string
     {
         if (ini_get("magic_quotes_gpc")) {
             return stripslashes($a_str);
         } else {
             return $a_str;
         }
     }

Here is the caller graph for this function:

◆ secureString()

static ilUtil::secureString	(	string	$a_str,
		bool	$a_strip_html = `true`,
		string	$a_allow = `""`
	)

static

Deprecated:

Definition at line 420 of file class.ilUtil.php.

References getSecureTags(), maskSecureTags(), stripScriptHTML(), and unmaskSecureTags().

Referenced by ilOrgUnitExplorerGUI\getNodeContent(), assKprimChoiceGUI\handleAnswerTextsSubmit(), ilUserDataSet\importRecord(), ilTaggingSlateContentGUI\renderResourcesForTag(), ilAssSelfAssessmentQuestionFormatter\stripHtmlExceptSelfAssessmentTags(), and stripSlashes().

                                                                                                        : string
     {
         // check whether all allowed tags can be made secure
         $only_secure = true;
         $allow_tags = explode(">", $a_allow);
         $sec_tags = ilUtil::getSecureTags();
         $allow_array = [];
         foreach ($allow_tags as $allow) {
             if ($allow != "") {
                 $allow = str_replace("<", "", $allow);
 
                 if (!in_array($allow, $sec_tags)) {
                     $only_secure = false;
                 }
                 $allow_array[] = $allow;
             }
         }
 
         // default behaviour: allow only secure tags 1:1
         if (($only_secure || $a_allow == "") && $a_strip_html) {
             if ($a_allow === "") {
                 $allow_array = ["b",
                                 "i",
                                 "strong",
                                 "em",
                                 "code",
                                 "cite",
                                 "gap",
                                 "sub",
                                 "sup",
                                 "pre",
                                 "strike",
                                 "bdo"
                 ];
             }
 
             // this currently removes parts of strings like "a <= b"
             // because "a <= b" is treated like "<spam onclick='hurt()'>ss</spam>"
             $a_str = ilUtil::maskSecureTags($a_str, $allow_array);
             $a_str = strip_tags($a_str);        // strip all other tags
             $a_str = ilUtil::unmaskSecureTags($a_str, $allow_array);
 
             // a possible solution could be something like:
             // $a_str = str_replace("<", "&lt;", $a_str);
             // $a_str = str_replace(">", "&gt;", $a_str);
             // $a_str = ilUtil::unmaskSecureTags($a_str, $allow_array);
             //
             // output would be ok then, but input fields would show
             // "a &lt;= b" for input "a <= b" if data is brought back to a form
         } else {
             // only for scripts, that need to allow more/other tags and parameters
             if ($a_strip_html) {
                 $a_str = ilUtil::stripScriptHTML($a_str, $a_allow);
             }
         }
 
         return $a_str;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ secureUrl()

static ilUtil::secureUrl ( string $url )

static

Deprecated:

Definition at line 829 of file class.ilUtil.php.

Referenced by ilGroupedListGUI\getHTML(), ilObjMediaObject\getXML(), and ilTabsGUI\removeNonTabbedLinks().

                                                  : string
     {
         // check if url is valid (absolute or relative)
         if (filter_var($url, FILTER_VALIDATE_URL) === false &&
             filter_var("http://" . $url, FILTER_VALIDATE_URL) === false &&
             filter_var("http:" . $url, FILTER_VALIDATE_URL) === false &&
             filter_var("http://de.de" . $url, FILTER_VALIDATE_URL) === false &&
             filter_var("http://de.de/" . $url, FILTER_VALIDATE_URL) === false) {
             return "";
         }
         if (trim(strtolower(parse_url($url, PHP_URL_SCHEME) ?? '')) === "javascript") {
             return "";
         }
 
         return htmlspecialchars($url, ENT_QUOTES);
     }

Here is the caller graph for this function:

◆ setCookie()

static ilUtil::setCookie	(	string	$a_cookie_name,
		string	$a_cookie_value = `''`,
		bool	$a_also_set_super_global = `true`,
		bool	$a_set_cookie_invalid = `false`
	)

static

Deprecated:: use HTTP-service instead

Definition at line 1280 of file class.ilUtil.php.

References $DIC, $http, $response, IL_COOKIE_PATH, and ILIAS\Repository\int().

Referenced by ilInitialisation\determineClient(), ilStartUpGUI\doLogout(), ilSoapAdministration\initAuth(), ilLTIViewGUI\logout(), ilStartUpGUI\processIndexPHP(), ilSessionControl\removeSessionCookie(), and ilInitialisation\setClientIdCookie().

      : void {
         global $DIC;
 
         $http = $DIC->http();
         $cookie_jar = $http->cookieJar();
 
         $cookie_factory = new CookieFactoryImpl();
 
         $cookie_expire = null;
         if (defined('IL_COOKIE_EXPIRE') && is_numeric(IL_COOKIE_EXPIRE) && IL_COOKIE_EXPIRE > 0) {
             $cookie_expire = (int) IL_COOKIE_EXPIRE;
         }
 
         $expires = null;
         if ($a_set_cookie_invalid) {
             $expires = time() - 10;
         } elseif ($cookie_expire > 0) {
             $expires = time() + $cookie_expire;
         }
 
         $cookie = $cookie_factory->create($a_cookie_name, $a_cookie_value)
                                  ->withExpires($expires)
                                  ->withSecure(defined('IL_COOKIE_SECURE') ? IL_COOKIE_SECURE : false)
                                  ->withPath(defined('IL_COOKIE_PATH') ? IL_COOKIE_PATH : '')
                                  ->withDomain(defined('IL_COOKIE_DOMAIN') ? IL_COOKIE_DOMAIN : '')
                                  ->withHttpOnly(defined('IL_COOKIE_HTTPONLY') ? IL_COOKIE_HTTPONLY : false);
 
 
         if (
             defined('IL_COOKIE_SECURE') && IL_COOKIE_SECURE &&
             (!isset(session_get_cookie_params()['samesite']) || strtolower(session_get_cookie_params()['samesite']) !== 'strict')
         ) {
             $cookie = $cookie->withSamesite(Cookie::SAMESITE_LAX);
         }
         $jar = $cookie_jar->with($cookie);
         $response = $jar->renderIntoResponseHeader($http->response());
         $http->saveResponse($response);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ stripOnlySlashes()

static ilUtil::stripOnlySlashes ( string $a_str )

static

Deprecated:

Definition at line 408 of file class.ilUtil.php.

Referenced by assQuestionGUI\writeQuestionGenericPostData().

                                                           : string
     {
         if (ini_get("magic_quotes_gpc")) {
             $a_str = stripslashes($a_str);
         }
 
         return $a_str;
     }

Here is the caller graph for this function:

◆ stripScriptHTML()

static ilUtil::stripScriptHTML	(	string	$a_str,
		string	$a_allow = `""`,
		bool	$a_rm_js = `true`
	)

static

Deprecated:

Definition at line 781 of file class.ilUtil.php.

Referenced by ILIAS\Services\UICore\MetaTemplate\PageContentGUI\fillHeader(), ilDataCollectionGlobalTemplate\fillHeader(), ilGlobalTemplate\fillHeader(), ilDataCollectionGlobalTemplate\fillWindowTitle(), ilGlobalTemplate\fillWindowTitle(), and secureString().

                                                                                                      : string
     {
         $negativestr = "a,abbr,acronym,address,applet,area,base,basefont," .
             "big,blockquote,body,br,button,caption,center,cite,code,col," .
             "colgroup,dd,del,dfn,dir,div,dl,dt,em,fieldset,font,form,frame," .
             "frameset,h1,h2,h3,h4,h5,h6,head,hr,html,i,iframe,img,input,ins,isindex,kbd," .
             "label,legend,li,link,map,menu,meta,noframes,noscript,object,ol," .
             "optgroup,option,p,param,q,s,samp,script,select,small,span," .
             "strike,strong,style,sub,sup,table,tbody,td,textarea,tfoot,th,thead," .
             "title,tr,tt,u,ul,var";
         $a_allow = strtolower($a_allow);
         $negatives = explode(",", $negativestr);
         $outer_old_str = "";
         while ($outer_old_str != $a_str) {
             $outer_old_str = $a_str;
             foreach ($negatives as $item) {
                 $pos = strpos($a_allow, "<$item>");
 
                 // remove complete tag, if not allowed
                 if ($pos === false) {
                     $old_str = "";
                     while ($old_str != $a_str) {
                         $old_str = $a_str;
                         $a_str = preg_replace("/<\/?\s*$item(\/?)\s*>/i", "", $a_str);
                         $a_str = preg_replace("/<\/?\s*$item(\/?)\s+([^>]*)>/i", "", $a_str);
                     }
                 }
             }
         }
 
         if ($a_rm_js) {
             // remove all attributes if an "on..." attribute is given
             $a_str = preg_replace("/<\s*\w*(\/?)(\s+[^>]*)?(\s+on[^>]*)>/i", "", $a_str);
 
             // remove all attributes if a "javascript" is within tag
             $a_str = preg_replace("/<\s*\w*(\/?)\s+[^>]*javascript[^>]*>/i", "", $a_str);
 
             // remove all attributes if an "expression" is within tag
             // (IE allows something like <b style='width:expression(alert(1))'>test</b>)
             $a_str = preg_replace("/<\s*\w*(\/?)\s+[^>]*expression[^>]*>/i", "", $a_str);
         }
 
         return $a_str;
     }

Here is the caller graph for this function:

◆ stripSlashes()

static ilUtil::stripSlashes	(	string	$a_str,
		bool	$a_strip_html = `true`,
		string	$a_allow = `""`
	)

static

Deprecated:

Definition at line 396 of file class.ilUtil.php.

References secureString().

Referenced by ilObjTaggingSettingsGUI\__construct(), ilSessionReminderCheck\__construct(), ilTaxonomyExplorerGUI\__construct(), ilSearchGUI\__construct(), ilLDAPSettingsGUI\__construct(), ilUserSearchFilter\__parseQueryString(), ilSearchGUI\__parseQueryString(), ilRepositorySearchGUI\__parseQueryString(), ilAdvancedSearchGUI\__performContentSearch(), ilAdvancedSearchGUI\__performEntitySearch(), ilAdvancedSearchGUI\__performGeneralSearch(), ilAdvancedSearchGUI\__performKeywordSearch(), ilAdvancedSearchGUI\__performLifecycleSearch(), ilAdvancedSearchGUI\__performTaxonSearch(), ilAdvancedSearchGUI\__performTitleSearch(), ilObjUserGUI\__sendProfileMail(), ilPCParagraph\_input2xml(), ilFileUtils\_sanitizeFilemame(), ilHierarchyFormGUI\_str(), ilObjContentObjectGUI\addTooltip(), ilPCInteractiveImage\addTriggerArea(), ILIAS\Container\Content\Filter\FilterManager\apply(), ilCmiXapiStatementsGUI\asyncUserAutocompleteCmd(), ilLTIConsumerXapiStatementsGUI\asyncUserAutocompleteCmd(), ilLTIConsumerGradeSynchronizationGUI\asyncUserAutocompleteCmd(), ilObjForumGUI\autosaveDraftAsyncObject(), ilObjForumGUI\autosaveThreadDraftAsyncObject(), ilRepositoryTrashGUI\buildPath(), ilObjSystemFolderGUI\changeHeaderTitleObject(), ilDashboardBlockGUI\changePDItemPresentationObject(), ilDashboardBlockGUI\changePDItemSortingObject(), ilMailQuickFilterInputGUI\checkInput(), ilClozeGapInputBuilderGUI\checkInput(), ilOrgUnitMultiLineInputGUI\checkInput(), ilSuggestedSolutionSelectorGUI\checkInput(), ilFileInputGUI\checkInput(), ilObjSurvey\cloneTextblocks(), ilFileSystemGUI\createDirectory(), ilObjFileBasedLMGUI\createFromDirectory(), ilObjForumGUI\decorateWithAutosave(), ilExAssignmentEditorGUI\deleteAssignmentsObject(), ilMailAttachmentGUI\deleteAttachments(), ilFileSystemGUI\deleteFile(), ilPCInteractiveImage\deleteOverlay(), ilPCInteractiveImageGUI\deleteOverlays(), ilObjSurveyGUI\doAutoCompleteObject(), ilObjForumGUI\doHistoryCheck(), ilStartUpGUI\doSamlAuthentication(), ilSCORM13PlayerGUI\downloadLog(), ilObjLanguageExtGUI\downloadObject(), ilTestExpressPageObjectGUI\executeCommand(), ilMailGUI\executeCommand(), ilCronManagerGUI\executeCommand(), ilObjTestGUI\executeCommand(), assQuestionGUI\executeCommand(), ilObjContentObjectGUI\export(), ilObjMediaPoolGUI\export(), ilObjContentObjectGUI\exportHTML(), ilFileSystemGUI\extCommand(), ilExportIDTableGUI\fillRow(), ilPDNewsTableGUI\fillRow(), ilMailSearchObjectMembershipsTableGUI\fillRow(), ilMailTemplateGUI\getAjaxPlaceholdersById(), ilPCDataTableGUI\getCellContent(), ilSCORM13MDImporter\getDescription(), ilObjUser\getFullname(), ilFormulaInputGUI\getInput(), ilTextAreaInputGUI\getInput(), ilUserLPTableGUI\getItems(), ilLMQuestionListTableGUI\getItems(), ilAssignedUsersTableGUI\getItems(), ilSCORMTrackingItemsTableGUI\getItems(), ilSCORM2004TrackingItemsTableGUI\getItems(), ilTrUserObjectsPropsTableGUI\getItems(), ilTrObjectUsersPropsTableGUI\getItems(), ilTrSummaryTableGUI\getItems(), ilExplorerBaseGUI\getNodeAsync(), assAnswerCloze\getNumericValueFromText(), ilObjForumGUI\getOrderByParam(), ilSCORMPackageParser\getPackageTitle(), assTextQuestion\getSolutionSubmit(), ilTaggingGUI\getTagsFromInput(), ilSCORM13MDImporter\getTitle(), ilUserTableGUI\getUserIdsForFilter(), ilChatroomInviteUsersToPrivateRoomGUI\getUserList(), ilPCParagraph\handleAjaxContent(), ilObjSessionGUI\handleFileUpload(), ilObjForumGUI\handleFormInput(), ilSCORMPackageParser\handlerCharacterData(), ilChatroomXMLParser\handlerEndTag(), ilForumXMLParser\handlerEndTag(), ilSCORM13Package\il_import(), ilContentPageDataSet\importRecord(), ilScormAiccImporter\importXmlRepresentation(), ilPresentationFullGUI\initFilter(), ILIAS\COPage\PC\MediaObject\MediaObjectCommandActionHandler\insertCommand(), ilObjChatroomGUI\insertObject(), ILIAS\COPage\PC\Paragraph\ParagraphCommandActionHandler\insertParagraph(), ilGlossaryPresentationGUI\listTerms(), ilECSUser\loadFromGET(), ilLDAPRoleGroupMappingSettings\loadFromPost(), ilECSSettingsGUI\loadFromPost(), ilObjEmployeeTalkSeriesGUI\loadRecurrenceSettings(), ilEmployeeTalkAppointmentGUI\loadRecurrenceSettings(), ilObjSessionGUI\loadRecurrenceSettings(), ilLDAPSettingsGUI\loadRoleAssignmentRule(), ilMailSearchGUI\lookupRecipientAsync(), ilMailFormGUI\lookupRecipientAsync(), ilObjLanguageExtGUI\maintainExecuteObject(), ilCSVReader\open(), ilSCORM13PlayerGUI\openLog(), assQuestionGUI\outChapterSelector(), assQuestionGUI\outPageSelector(), ilSCORMTrackingUsersTableGUI\parse(), ilTrashTableGUI\parse(), ilFileSystemGUI\parseCurrentDirectory(), ilObjStudyProgrammeAutoMembershipsGUI\parseQueryString(), ilRepositorySearchGUI\performSearch(), ilMarkSchemaGUI\populateMarkSchemaFormData(), ilLegacyFormElementsUtil\prepareFormOutput(), ilAnswerWizardInputGUI\prepareFormOutput(), ilLMPageGUI\processAnswer(), ilICalParser\purgeString(), ilMailBodyPurifier\purify(), ilInitialisation\redirect(), ilLuceneSearchGUI\remoteSearch(), ilExAssignmentFileSystemGUI\renameFile(), ilFileSystemGUI\renameFile(), ilTable2GUI\restoreTemplate(), ilTestScoringByQuestionsGUI\retrieveFeedback(), ilEMailInputGUI\sanitize(), ilFileSystemGUI\sanitizeCurrentDirectory(), ilQtiMatImageSecurity\sanitizeLabel(), ilChatroomFormFactory\saniziteArrayElementsTrafo(), ilLMEditShortTitlesGUI\save(), ilLMPageObjectGUI\save(), ilObjSkillTreeGUI\saveAllTemplateTitles(), ilObjSkillTreeGUI\saveAllTitles(), ilExerciseManagementGUI\saveCommentForLearnersObject(), ilExerciseManagementGUI\saveEvaluationFromModalObject(), ilObjContentObjectGUI\saveExportIds(), ilObjWikiGUI\saveGradingObject(), ilObjSystemFolderGUI\saveHeaderTitleObject(), ilObjSystemFolderGUI\saveHeaderTitlesObject(), ilSurveyEditorGUI\saveHeadingObject(), ilObjSystemFolderGUI\saveJavaServerObject(), ilTestScoringGUI\saveManScoringParticipantScreen(), ilPCParagraph\saveMetaKeywords(), ilObjLanguageExtGUI\saveObject(), ilObjPortfolioBaseGUI\savePortfolioPagesOrdering(), ilObjAssessmentFolderGUI\saveSettingsObject(), ilObjTaxonomyGUI\saveSorting(), ilPortfolioRepositoryGUI\saveTitles(), ilObjectTranslationGUI\saveTranslations(), ilObjStudyProgrammeTreeGUI\saveTreeOrder(), assLongMenu\saveWorkingData(), assClozeTest\saveWorkingData(), ilLegalDocumentsAdministrationGUI\searchUser(), ilPCTableGUI\setAlignment(), ilForumPageCommandForwarder\setBackLinkTab(), ilContentPagePageCommandForwarder\setBackLinkTab(), ilSCORM13MDImporter\setDescription(), ilPCInteractiveImage\setMapAreaProperties(), ilObjMediaObjectGUI\setObjectPerCreationForm(), ilLDAPRoleGroupMappingSetting\setRoleByName(), ilPCTableGUI\setStyles(), ilSCORM13MDImporter\setTitle(), ilPCInteractiveImage\setTriggerProperties(), ilPCTableGUI\setWidths(), ilCalendarCategoryGUI\sharePerformSearch(), ilRepositoryTrashGUI\showDeleteConfirmation(), ilStartUpGUI\showSamlLoginForm(), ilObjSCORM2004LearningModuleGUI\showTrackingItems(), ilObjSCORMLearningModuleGUI\showTrackingItems(), ilObjSCORM2004LearningModuleGUI\showTrackingItemsBySco(), ilObjSCORMLearningModuleGUI\showTrackingItemsBySco(), ilObjForumGUI\showUserObject(), ILIAS\COPage\PC\Paragraph\ParagraphCommandActionHandler\split(), ilBadgeGUIRequest\strArray(), ILIAS\User\UserGUIRequest\strArray(), ILIAS\Repository\HTML\HTMLUtil\strip(), ILIAS\Repository\strip(), ilCertificateUtilHelper\stripSlashes(), ilFormPropertyGUI\stripSlashesAddSpaceFallback(), SurveyQuestion\stripSlashesAddSpaceFallback(), ilArrayUtil\stripSlashesArray(), ilArrayUtil\stripSlashesRecursive(), assLongMenuGUI\stripSlashesRecursive(), ilClozeGapInputBuilderGUI\stripSlashesRecursive(), ilDataSet\stripTags(), ilBuddySystemGUI\transitionAsyncCommand(), ilContainerBaseXmlParser\trimAndStrip(), ilStyleImportParser\trimAndStrip(), ilExerciseXMLParser\trimAndStrip(), ilMDSaxParser\trimAndStrip(), SurveyImportParser\trimAndStrip(), ILIAS\COPage\Page\PageCommandActionHandler\updateCommand(), ilPCDataTableGUI\updateJS(), ilMDKeyword\updateKeywords(), ilObjLinkResourceGUI\updateLinks(), ilExerciseXMLParser\updateMarking(), ilSessionMembershipGUI\updateMembers(), ILIAS\COPage\PC\Paragraph\ParagraphCommandActionHandler\updateParagraph(), ilAdvancedMDSettingsGUI\updateRecords(), ilRegistrationGUI\updateSubscriptionRequest(), ilExAssignmentFileSystemGUI\uploadFile(), ilFileSystemGUI\uploadFile(), ilObjLanguageExtGUI\uploadObject(), ilObjForumGUI\viewThreadObject(), assMatchingQuestionGUI\writeAnswerSpecificPostData(), and assLongMenuGUI\writeQuestionSpecificPostData().

                                                                                                        : string
     {
         if (ini_get("magic_quotes_gpc")) {
             $a_str = stripslashes($a_str);
         }
 
         return ilUtil::secureString($a_str, $a_strip_html, $a_allow);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ switchColor()

static ilUtil::switchColor	(	int	$a_num,
		string	$a_css1,
		string	$a_css2
	)

static

switches style sheets for each even $a_num (used for changing colors of different result rows)

Deprecated:

Definition at line 211 of file class.ilUtil.php.

Referenced by ilObjForumGUI\renderPostContent(), and ilForumExportGUI\renderPostHtml().

                                                                                   : string
     {
         if (!($a_num % 2)) {
             return $a_css1;
         } else {
             return $a_css2;
         }
     }

Here is the caller graph for this function:

◆ tf2yn()

static ilUtil::tf2yn ( bool $a_tf )

static

Deprecated:

Definition at line 914 of file class.ilUtil.php.

Referenced by ilObjContentObject\exportXMLProperties(), ilObjRoleGUI\permSaveObject(), ilUserPrivacySettingsGUI\savePrivacySettings(), ilObjSAHSLearningModule\setAutoReview(), ilObjGlossary\update(), ilObjSAHSLearningModule\update(), and ilObjContentObject\updateProperties().

                                             : string
     {
         if ($a_tf) {
             return "y";
         } else {
             return "n";
         }
     }

Here is the caller graph for this function:

◆ unmaskAttributeTag()

static ilUtil::unmaskAttributeTag	(	string	$a_str,
		string	$tag,
		string	$tag_att
	)

staticprivate

Definition at line 684 of file class.ilUtil.php.

References $DIC, and secureLink().

Referenced by unmaskSecureTags().

                                                                                            : string
     {
         global $DIC;
 
         $ilLog = $DIC["ilLog"];
 
         while (preg_match(
             '/&lt;(' . $tag . ' ' . $tag_att . $tag_att . '="(([$@!*()~;,_0-9A-z\/:=%.&#?+\-])*)")&gt;/i',
             $a_str,
             $found
         )) {
             $old_str = $a_str;
             $a_str = preg_replace(
                 "/&lt;" . preg_quote($found[1], "/") . "&gt;/i",
                 '<' . $tag . ' ' . $tag_att . '="' . ilUtil::secureLink($found[2]) . '">',
                 $a_str
             );
             if ($old_str == $a_str) {
                 $ilLog->write(
                     "ilUtil::unmaskA-" . htmlentities($old_str) . " == " .
                     htmlentities($a_str)
                 );
                 return $a_str;
             }
         }
         $a_str = str_replace('&lt;/' . $tag . '&gt;', '</' . $tag . '>', $a_str);
         return $a_str;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ unmaskSecureTags()

static ilUtil::unmaskSecureTags	(	string	$a_str,
		array	$allow_array
	)

staticprivate

Definition at line 534 of file class.ilUtil.php.

References unmaskAttributeTag(), and unmaskTag().

Referenced by secureString().

                                                                                : string
     {
         foreach ($allow_array as $t) {
             switch ($t) {
                 case "a":
                     $a_str = ilUtil::unmaskAttributeTag($a_str, "a", "href");
                     break;
 
                 case "img":
                     $a_str = ilUtil::unmaskAttributeTag($a_str, "img", "src");
                     break;
 
                 case "p":
                 case "div":
                     $a_str = ilUtil::unmaskTag($a_str, $t, [
                         ["param" => "align", "value" => "left"],
                         ["param" => "align", "value" => "center"],
                         ["param" => "align", "value" => "justify"],
                         ["param" => "align", "value" => "right"]
                     ]);
                     break;
 
                 default:
                     $a_str = ilUtil::unmaskTag($a_str, $t);
                     break;
             }
         }
 
         return $a_str;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ unmaskTag()

static ilUtil::unmaskTag	(	string	$a_str,
		string	$tag,
		array	$fix_param = `[]`
	)

staticprivate

Definition at line 739 of file class.ilUtil.php.

Referenced by unmaskSecureTags().

                                                                                         : string
     {
         $a_str = str_replace("&lt;" . $tag . "&gt;", "<" . $tag . ">", $a_str);
         $a_str = str_replace("&lt;/" . $tag . "&gt;", "</" . $tag . ">", $a_str);
 
         foreach ($fix_param as $p) {
             $k = $p["param"];
             $v = $p["value"];
             $a_str = str_replace(
                 "&lt;$tag $k=\"$v\"&gt;",
                 "<" . "$tag $k=\"$v\"" . ">",
                 $a_str
             );
         }
         return $a_str;
     }

Here is the caller graph for this function:

◆ yn2tf()

static ilUtil::yn2tf ( string $a_yn )

static

Deprecated:: use Refinery instead

Definition at line 902 of file class.ilUtil.php.

Referenced by ilLMObject\_isPagePublic(), ilObjGlossaryAccess\_lookupOnline(), ilObjGlossary\_lookupOnline(), ilObjGlossaryAccess\_lookupOnlineStatus(), ilSCORM2004Tracking\_syncReadEvent(), ilChatUserActionProvider\acceptsMessages(), ilQuestionPageParser\buildTag(), ilChatroomUser\enabledBroadcastTyping(), ilLMMenuItemsTableGUI\fillRow(), ilMailSearchObjectMembershipsTableGUI\fillRow(), ilObjSAHSLearningModule\getAutoReview(), ilBuddySystemLinkButton\getHtml(), ILIAS\OnScreenChat\Provider\OnScreenChatProvider\getSlateMessageBox(), ilProfileChecklistStatus\getStatusDetails(), ilOnScreenChatAppEventListener\handleEvent(), ilLearningModuleDataSet\importRecord(), ilObjUserGUI\initForm(), ilOnScreenChatGUI\initializeFrontend(), ilUserPrivacySettingsGUI\populateWithChatSettingsSection(), ilObjGlossary\read(), ilObjSAHSLearningModule\read(), ilObjContentObject\readProperties(), ilBuddySystemGUI\requestCommand(), ilUserPrivacySettingsGUI\savePrivacySettings(), ilObjSCORMLearningModuleGUI\saveProperties(), ilObjGlossaryGUI\saveProperties(), and ilBuddySystemGUI\transitionAsyncCommand().

                                               : bool
     {
         if (strtolower($a_yn) === "y") {
             return true;
         } else {
             return false;
         }
     }

Here is the caller graph for this function:

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

Services/Utilities/classes/class.ilUtil.php

Static Public Member Functions

Static Protected Member Functions

Static Private Member Functions

Detailed Description

Member Function Documentation

◆ __extractId()

◆ __extractRefId()

◆ _getHttpPath()

◆ _getObjectsByOperations()

◆ _sortIds()

◆ appendUrlParameterString()

◆ deducibleSize()

◆ deliverData()

◆ extractParameterString()

◆ fmtFloat()

◆ formatSize()

◆ getHtmlPath()

◆ getImagePath()

◆ getImageTagByType()

◆ getNewContentStyleSheetLocation()

◆ getSecureTags()

◆ getStyleSheetLocation()

◆ getSystemMessageHTML()

◆ groupNameExists()

◆ htmlencodePlainString()

◆ img()

◆ insertInstIntoID()

◆ is_email()

◆ isHTML()

◆ isLogin()

◆ isWindows()

◆ makeClickable()

◆ maskAttributeTag()

◆ maskSecureTags()

◆ maskTag()

◆ now()

◆ parseImportId()

◆ redirect()

◆ replaceLinkProperties()

◆ secureLink()

◆ securePlainString()

◆ secureString()

◆ secureUrl()

◆ setCookie()

◆ stripOnlySlashes()

◆ stripScriptHTML()

◆ stripSlashes()

◆ switchColor()

◆ tf2yn()

◆ unmaskAttributeTag()

◆ unmaskSecureTags()

◆ unmaskTag()

◆ yn2tf()