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

Collaboration diagram for ilUtil:

Public Member Functions
	includeMathjax ($a_tpl=null)
	Include Mathjax. More...

	rangeDownload ($file)
	Send a file via range request, see http://mobiforge.com/design-development/content-delivery-mobile-devices alternatives could be. More...

Static Public Member Functions
static	getImageTagByType ($a_type, $a_path, $a_big=false)
	Builds an html image tag TODO: function still in use, but in future use getImagePath and move HTML-Code to your template file public. More...

static	getTypeIconPath ($a_type, $a_obj_id, $a_size='small')
	Get type icon path path Return image path for icon_xxx.pngs Or (if enabled) path to custom icon Deprecated, use ilObject::_getIcon instead. More...

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

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

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

static	getJSLocation ($a_js_name, $a_js_location="", $add_version=false)
	get full javascript file name (path inclusive) of current user More...

static	getP3PLocation ()
	Get p3p file path. More...

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

static	formSelect ( $selected, $varname, $options, $multiple=false, $direct_text=false, $size="0", $style_class="", $attribs="", $disabled=false)
	Builds a select form field with options and shows the selected option first. More...

static	getSelectName ($selected, $values)
	??? More...

static	formCheckbox ($checked, $varname, $value, $disabled=false)
	??? public More...

static	formDisabledRadioButton ($checked, $varname, $value, $disabled)
	??? More...

static	formRadioButton ($checked, $varname, $value, $onclick=null, $disabled=false)
	??? public More...

static	formInput ($varname, $value, $disabled=false)
	create html input area More...

static	checkInput ($vars)
	??? More...

static	setPathStr ($a_path)
	??? public More...

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

static	checkFormEmpty ($emptyFields)
	??? public More...

static	Linkbar ($AScript, $AHits, $ALimit, $AOffset, $AParams=array(), $ALayout=array(), $prefix='')
	Linkbar Diese Funktion erzeugt einen typischen Navigationsbalken mit "Previous"- und "Next"-Links und den entsprechenden Seitenzahlen. More...

static	makeClickable ($a_text, $detectGotoLinks=false)
	makeClickable In Texten enthaltene URLs und Mail-Adressen klickbar machen More...

static	replaceLinkProperties ($matches)
	replaces target _blank with _self and the link text with the according object title. More...

static	makeDateSelect ($prefix, $year="", $month="", $day="", $startyear="", $a_long_month=true, $a_further_options=array(), $emptyoption=false)
	Creates a combination of HTML selects for date inputs. More...

static	makeTimeSelect ($prefix, $short=true, $hour="", $minute="", $second="", $a_use_default=true, $a_further_options=array())
	Creates a combination of HTML selects for time inputs. More...

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

static	isPassword ($a_passwd, &$customError=null)
	validates a password public More...

static	isPasswordValidForUserContext ($clear_text_password, $user, &$error_language_variable=null)

static	getPasswordValidChars ($a_as_regex=true, $a_only_special_chars=false)
	All valid chars for password. More...

static	getPasswordRequirementsInfo ()
	infotext for ilPasswordInputGUI setInfo() More...

static	isLogin ($a_login)

static	shortenText ( $a_str, $a_len, $a_dots=false, $a_next_blank=false, $a_keep_extension=false)
	shorten a string to given length. More...

static	shortenWords ($a_str, $a_len=30, $a_dots=true)
	Ensure that the maximum word lenght within a text is not longer than $a_len. More...

static	attribsToArray ($a_str)
	converts a string of format var1 = "val1" var2 = "val2" ... More...

static	rCopy ($a_sdir, $a_tdir, $preserveTimeAttributes=false)
	Copies content of a directory $a_sdir recursively to a directory $a_tdir. More...

static	getWebspaceDir ($mode="filesystem")
	get webspace directory More...

static	getDataDir ()
	get data directory (outside webspace) More...

static	getUsersOnline ($a_user_id=0)
	reads all active sessions from db and returns users that are online OR returns only one active user if a user_id is given More...

static	ilTempnam ($a_temp_path=null)
	Returns a unique and non existing Path for e temporary file or directory. More...

static	createDirectory ($a_dir, $a_mod=0755)
	create directory More...

static	unzip ($a_file, $overwrite=false, $a_flat=false)
	unzip file More...

static	zip ($a_dir, $a_file, $compress_content=false)
	zips given directory/file into given zip.file More...

static	CreateIsoFromFolder ($a_dir, $a_file)

static	getConvertCmd ()
	get convert command More...

static	execConvert ($args)
	execute convert command More...

static	isConvertVersionAtLeast ($a_version)
	Compare convert version numbers. More...

static	convertImage ( $a_from, $a_to, $a_target_format="", $a_geometry="", $a_background_color="")
	convert image More...

static	resizeImage ($a_from, $a_to, $a_width, $a_height, $a_constrain_prop=false)
	resize image More...

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

static	deliverData ($a_data, $a_filename, $mime="application/octet-stream", $charset="")
	deliver data for download via browser. More...

static	deliverFile ( $a_file, $a_filename, $a_mime='', $isInline=false, $removeAfterDelivery=false, $a_exit_after=true)
	deliver file for download via browser. More...

static	readFile ($a_file)
	there are some known problems with the original readfile method, which sometimes truncates delivered files regardless of php.ini setting (see http://de.php.net/manual/en/function.readfile.php) use this method to avoid these problems. More...

static	getASCIIFilename ($a_filename)
	convert utf8 to ascii filename More...

static	htmlentitiesOutsideHTMLTags ($htmlText)
	Encodes HTML entities outside of HTML tags. More...

static	getJavaPath ()
	get full java path (dir + java command) More...

static	appendUrlParameterString ($a_url, $a_par, $xml_style=false)
	append URL parameter string ("par1=value1&par2=value2...") to given URL string More...

static	makeDir ($a_dir)
	creates a new directory and inherits all filesystem permissions of the parent directory You may pass only the name of your new directory or with the entire path or relative path information. More...

static	makeDirParents ($a_dir)
	Create a new directory and all parent directories. More...

static	delDir ($a_dir, $a_clean_only=false)
	removes a dir and all its content (subdirs and files) recursively More...

static	getDir ($a_dir, $a_rec=false, $a_sub_dir="")
	get directory More...

static	stripSlashesArray ($a_arr, $a_strip_html=true, $a_allow="")
	Strip slashes from array. More...

static	getClientIdByString (string $clientId)

static	stripSlashesRecursive ($a_data, $a_strip_html=true, $a_allow="")
	Strip slashes from array and sub-arrays. More...

static	stripSlashes ($a_str, $a_strip_html=true, $a_allow="")
	strip slashes if magic qoutes is enabled More...

static	stripOnlySlashes ($a_str)
	strip slashes if magic qoutes is enabled More...

static	secureString ($a_str, $a_strip_html=true, $a_allow="")
	Remove unsecure tags. More...

static	getSecureTags ()

static	maskSecureTags ($a_str, $allow_array)

static	unmaskSecureTags ($a_str, $allow_array)

static	securePlainString ($a_str)
	Remove unsecure characters from a plain text string. More...

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

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

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

static	maskTag ($a_str, $t, $fix_param="")

static	unmaskTag ($a_str, $t, $fix_param="")

static	secureLink ($a_str)

static	stripScriptHTML ($a_str, $a_allow="", $a_rm_js=true)
	strip only html tags (4.0) from text $allowed contains tags to be allowed, in format tags a and b are allowed todo: needs to be optimized-> not very efficient More...

static	prepareFormOutput ($a_str, $a_strip=false)
	prepares string output for html forms public More...

static	secureUrl ($url)
	Prepare secure href attribute. More...

static	prepareDBString ($a_str)
	prepare a string for db writing (insert/update) More...

static	removeItemFromDesktops ($a_id)
	removes object from all user's desktops public More...

static	extractParameterString ($a_parstr)
	extracts parameter value pairs from a string into an array More...

static	assembleParameterString ($a_par_arr)

static	dumpString ($a_str)
	dumps ord values of every character of string $a_str More...

static	yn2tf ($a_yn)
	convert "y"/"n" to true/false More...

static	tf2yn ($a_tf)
	convert true/false to "y"/"n" More...

static	sort_func ($a, $b)
	sub-function to sort an array More...

static	sort_func_numeric ($a, $b)
	sub-function to sort an array More...

static	sortArray ( $array, $a_array_sortby, $a_array_sortorder=0, $a_numeric=false, $a_keep_keys=false)
	sortArray More...

static	stableSortArray ($array, $a_array_sortby, $a_array_sortorder=0, $a_numeric=false)
	Sort an aray using a stable sort algorithm, which preveserves the sequence of array elements which have the same sort value. More...

static	mergesort (&$array, $cmp_function='strcmp')

static	unique_multi_array ($array, $sub_key)
	Make a multi-dimensional array to have only DISTINCT values for a certain "column". More...

static	getGDSupportedImageType ($a_desired_type)
	returns the best supported image type by this PHP build More...

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

static	redirect ($a_script)

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

static	groupNameExists ($a_group_name, $a_id=0)
	checks if group name already exists. More...

static	getMemString ()
	get current memory usage as string More...

static	isWindows ()
	check wether the current client system is a windows system More...

static	escapeShellArg ($a_arg)

static	escapeShellCmd ($a_arg)
	escape shell cmd More...

static	execQuoted ($cmd, $args=null)
	exec command and fix spaces on windows More...

static	excelTime ($year="", $month="", $day="", $hour="", $minute="", $second="")
	Calculates a Microsoft Excel date/time value. More...

static	renameExecutables ($a_dir)
	Rename uploaded executables for security reasons. More...

static	getSafeFilename ($a_initial_filename)

static	rRenameSuffix ($a_dir, $a_old_suffix, $a_new_suffix)
	Renames all files with certain suffix and gives them a new suffix. More...

static	isAPICall ()

static	KT_replaceParam ($qstring, $paramName, $paramValue)

static	replaceUrlParameterString ($url, $parametersArray)

static	generatePasswords ($a_number)
	Generate a number of passwords. More...

static	removeTrailingPathSeparators ($path)

static	array_php2js ($data)
	convert php arrays to javascript arrays More...

static	virusHandling ($a_file, $a_orig_name="", $a_clean=true)
	scan file for viruses and clean files if possible More...

static	date_mysql2time ($mysql_date_time)
	make time object from mysql_date_time More...

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

static &	processCSVRow (&$row, $quoteAll=false, $separator=";", $outUTF8=false, $compatibleWithMSExcel=true)
	Convertes an array for CSV usage. More...

static	isDN ($a_str)

static	isIPv4 ($a_str)

static	_getObjectsByOperations ($a_obj_type, $a_operation, $a_usr_id=0, $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	insertLatexImages ($a_text, $a_start='[tex]', $a_end='[/tex]')
	replace [tex]...[/tex] tags with formula image code More...

static	buildLatexImages ($a_text, $a_dir)
	replace [tex]...[/tex] tags with formula image code for offline use More...

static	prepareTextareaOutput ($txt_output, $prepare_for_latex_output=false, $omitNl2BrWhenTextArea=false)
	Prepares a string for a text area output where latex code may be in it If the text is HTML-free, CHR(13) will be converted to a line break. More...

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

static	period2String (ilDateTime $a_from, $a_to=null)
	Return a string of time period. More...

static	getFileSizeInfo ()

static	formatBytes ($size, $decimals=0)

static	getUploadSizeLimitBytes ()

static	convertPhpIniSizeValueToBytes ($phpIniSizeValue)

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

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

static	_sortIds ($a_ids, $a_table, $a_field, $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	getMySQLTimestamp ($a_ts)
	Get MySQL timestamp in 4.1.x or higher format (yyyy-mm-dd hh:mm:ss) This function converts a timestamp, if MySQL 4.0 is used. More...

static	quoteArray ($a_array)
	Quotes all members of an array for usage in DB query statement. More...

static	sendInfo ($a_info="", $a_keep=false)
	Send Info Message to Screen. More...

static	sendFailure ($a_info="", $a_keep=false)
	Send Failure Message to Screen. More...

static	sendQuestion ($a_info="", $a_keep=false)
	Send Question to Screen. More...

static	infoPanel ($a_keep=true)

static	dirsize ($directory)
	get size of a directory or a file. More...

static	randomhash ()

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

static	_sanitizeFilemame ($a_filename)

static	_getHttpPath ()

static	printBacktrace ($a_limit=0)
	printBacktrace More...

static	parseImportId ($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	unserializeSession ($data)
	Returns the unserialized ILIAS session data. More...

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

static	MB2Bytes ($a_value)

static	Bytes2MB ($a_value)

static	dbSupportsDisctinctUmlauts ()
	Only temp fix for #8603, should go to db classes. More...

static	dumpVar ($mixed=null)
	Dump var. More...

Static Protected Member Functions
static	processConvertVersion ($a_version)
	Parse convert version string, e.g. More...

static	sanitateTargetPath ($a_target)

static	_getSizeMagnitude ()
	Returns the magnitude used for size units. More...

static	fmtFloat ($a_float, $a_decimals=0, $a_dec_point=null, $a_thousands_sep=null, $a_suppress_dot_zero=false)
	format a float More...

Static Protected Attributes
static	$db_supports_distinct_umlauts

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

Version: $Id$

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

Member Function Documentation

◆ __extractId()

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

static

extract ref id from role title, e.g.

893 from 'il_122_role_893'

Parameters

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

Returns: id or false

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

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

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

Here is the caller graph for this function:

◆ __extractRefId()

static ilUtil::__extractRefId ( $role_title )

static

extract ref id from role title, e.g.

893 from 'il_crs_member_893'

Parameters

role_title with format like il_crs_member_893

Returns: ref id or false

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

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

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

Here is the caller graph for this function:

◆ _getHttpPath()

static ilUtil::_getHttpPath ( )

static

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

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

Referenced by ilMailSummaryNotification\__construct(), ilMail\_getAutoGeneratedMessageString(), ilMail\_getInstallationSignature(), ilObjFileAccessSettingsGUI\getInstallationDocsLink(), ilForumMailNotification\getPermanentLink(), ilChatroomAdminViewGUI\getReadmePath(), ilSoapClient\init(), ilWebAccessChecker\isRequestNotFromLoginPage(), ilSendMailActivity\processPlaceholders(), ilCronManager\runActiveJobs(), ilDiskQuotaSummaryNotification\send(), and ilCronDeleteInactiveUserReminderMail\sendReminder().

     {
         global $DIC;
 
         $ilIliasIniFile = $DIC["ilIliasIniFile"];
         
         if ($_SERVER['SHELL'] || php_sapi_name() == '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,
		$a_operation,
		$a_usr_id = `0`,
		$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 3997 of file class.ilUtil.php.

References $DIC, $ilDB, $ilSetting, $ilUser, $query, $res, $row, $tree, ilRbacReview\_getOperationIdsByName(), and ilDBConstants\FETCHMODE_OBJECT.

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

     {
         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 = $ilSetting->get('search_max_hits', 100);
         }
         if ($limit == -1) {
             $limit = 10000;
         }
 
         // default to logged in usr
         $a_usr_id = $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;
             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 ? $ref_ids : array();
         } // 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(array($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;
         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 ? $ref_ids : array();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _getSizeMagnitude()

static ilUtil::_getSizeMagnitude ( )

staticprotected

Returns the magnitude used for size units.

This function always returns the value 1024. 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 GibiBit, MebiBit, KibiBit or byte unit.

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

Returns: <type>

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

     {
         return 1024;
     }

◆ _sanitizeFilemame()

static ilUtil::_sanitizeFilemame ( $a_filename )

static

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

Referenced by ilSoapUtils\distributeMails(), ilFileDataMail\storeAsAttachment(), ilFileDataForumDrafts\storeUploadedFile(), ilFileDataForum\storeUploadedFile(), and ilFileDataMail\storeUploadedFile().

     {
         return strip_tags(self::stripSlashes($a_filename));
     }

Here is the caller graph for this function:

◆ _sortIds()

static ilUtil::_sortIds	(	$a_ids,
		$a_table,
		$a_field,
		$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.

Parameters

array	Array of ids
string	table name
string	table field
string	id name

Returns: array sorted ids

protected

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

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

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ appendUrlParameterString()

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

static

append URL parameter string ("par1=value1&par2=value2...") to given URL string

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

References $url.

Referenced by ilTemplate\addILIASFooter(), ilObjectListGUI\appendRepositoryFrameParameter(), ilCtrl\appendRequestTokenParameterString(), assImagemapQuestionGUI\buildAreaLinkTarget(), ilPasswordAssistanceGUI\buildUrl(), ilCaptchaInputGUI\checkInput(), ilAssQuestionHintRequestGUI\confirmRequestCmd(), ilStartUpGUI\doApacheAuthentication(), ilTestExpressPageObjectGUI\executeCommand(), ilObjTestGUI\executeCreateQuestionObject(), ilTemplate\fillJavascriptFile(), ilAssQuestionHintsTableGUI\fillRow(), ilSecurImageUtil\getAudioScript(), ilObjQuestionPoolListGUI\getCommandLink(), ilObjTestListGUI\getCommandLink(), ilTestRandomQuestionSetSourcePoolDefinitionListTableGUI\getDeleteHref(), ilTestRandomQuestionSetSourcePoolDefinitionListTableGUI\getEditHref(), ilCtrl\getFormActionByClass(), ilMainMenuGUI\getLanguageSelection(), ilIntLinkRepItemExplorerGUI\getNodeHref(), assImagemapQuestionGUI\getPreviousSolutionConfirmationCheckboxHtml(), ilLMPresentationGUI\getSourcecodeDownloadLink(), ilCtrl\getUrlParameters(), ilInitialisation\redirect(), ilInternalLinkGUI\renderLink(), ilNoteGUI\renderTargets(), ilCtrl\returnToParent(), ilObjContentObjectGUI\setilLMMenu(), ilPCQuestionGUI\setTabs(), and ilAuthFrontendCredentialsSoap\tryAuthenticationOnLoginPage().

     {
         $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:

◆ array_php2js()

static ilUtil::array_php2js ( $data )

static

convert php arrays to javascript arrays

Author: gigi@.nosp@m.orso.nosp@m.ne.co.nosp@m.m public

Parameters

array

Returns: string

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

References $data.

     {
         if (empty($data)) {
             $data = array();
         }
 
         foreach ($data as $k => $datum) {
             if (is_null($datum)) {
                 $data[$k] = 'null';
             }
             if (is_string($datum)) {
                 $data[$k] = "'" . $datum . "'";
             }
             if (is_array($datum)) {
                 $data[$k] = array_php2js($datum);
             }
         }
 
         return "[" . implode(', ', $data) . "]";
     }

◆ assembleParameterString()

static ilUtil::assembleParameterString ( $a_par_arr )

static

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

References $target_arr.

Referenced by ilMediaItem\getParameterString().

     {
         if (is_array($a_par_arr)) {
             $target_arr = array();
             foreach ($a_par_arr as $par => $val) {
                 $target_arr[] = "$par=\"$val\"";
             }
             $target_str = implode(", ", $target_arr);
         }
 
         return $target_str;
     }

Here is the caller graph for this function:

◆ attribsToArray()

static ilUtil::attribsToArray ( $a_str )

static

converts a string of format var1 = "val1" var2 = "val2" ...

into an array

Parameters

string $a_str string in format: var1 = "val1" var2 = "val2" ...

Returns: array array of variable value pairs

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

Referenced by ilPCParagraph\_input2xml(), ilPCParagraph\handleAjaxContent(), ilPCParagraph\intLinks2xml(), ilPCParagraph\xml2output(), and ilPCParagraphGUI\xml2outputJS().

     {
         $attribs = array();
         while (is_int(strpos($a_str, "="))) {
             $eq_pos = strpos($a_str, "=");
             $qu1_pos = strpos($a_str, "\"");
             $qu2_pos = strpos(substr($a_str, $qu1_pos + 1), "\"") + $qu1_pos + 1;
             if (is_int($eq_pos) && is_int($qu1_pos) && is_int($qu2_pos)) {
                 $var = trim(substr($a_str, 0, $eq_pos));
                 $val = trim(substr($a_str, $qu1_pos + 1, ($qu2_pos - $qu1_pos) - 1));
                 $attribs[$var] = $val;
                 $a_str = substr($a_str, $qu2_pos + 1);
             } else {
                 $a_str = "";
             }
         }
         return $attribs;
     }

Here is the caller graph for this function:

◆ buildLatexImages()

static ilUtil::buildLatexImages	(	$a_text,
		$a_dir
	)

static

replace [tex]...[/tex] tags with formula image code for offline use

Deprecated:

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

References ilMathJax\getInstance().

     {
         include_once './Services/MathJax/classes/class.ilMathJax.php';
         return ilMathJax::getInstance()->insertLatexImages($a_text, '[tex]', '[/tex]', $a_dir . '/teximg', './teximg');
     }

Here is the call graph for this function:

◆ Bytes2MB()

static ilUtil::Bytes2MB ( $a_value )

static

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

Referenced by ilObjUserGUI\getValues(), and ilObjRoleGUI\readRoleProperties().

     {
         return  ((int) $a_value) / (pow(self::_getSizeMagnitude(), 2));
     }

Here is the caller graph for this function:

◆ checkFormEmpty()

static ilUtil::checkFormEmpty ( $emptyFields )

static

??? public

Parameters

array

Returns: string

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

References $key.

     {
         $feedback = "";
 
         foreach ($emptyFields as $key => $val) {
             if ($val == "") {
                 if ($feedback != "") {
                     $feedback .= ", ";
                 }
                 $feedback .= $key;
             }
         }
 
         return $feedback;
     }

◆ checkInput()

static ilUtil::checkInput ( $vars )

static

???

Parameters

string

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

     {
         // TO DO:
         // Diese Funktion soll Formfeldeingaben berprfen (empty und required)
     }

◆ convertImage()

static ilUtil::convertImage	(	$a_from,
		$a_to,
		$a_target_format = `""`,
		$a_geometry = `""`,
		$a_background_color = `""`
	)

static

convert image

Parameters

string	$a_from	source file
string	$a_to	target file
string	$a_target_format	target image file format

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

References escapeShellArg(), and execConvert().

Referenced by ilCertificateUtilHelper\convertImage(), ilMediaItem\copyOriginal(), assOrderingQuestion\createImageThumbnail(), assOrderingQuestionImport\fromXML(), ilObjMediaObject\generatePreviewPic(), assSingleChoice\generateThumbForFile(), assMultipleChoice\generateThumbForFile(), assKprimChoice\generateThumbForFile(), assOrderingQuestion\generateThumbForFile(), assMatchingQuestion\generateThumbForFile(), ilMediaItem\getThumbnailTarget(), ilObjMediaObject\makeThumbnail(), assMatchingQuestion\setImageFile(), and ilObjCertificateSettings\uploadBackgroundImage().

       {
         $format_str = ($a_target_format != "")
             ? strtoupper($a_target_format) . ":"
             : "";
         $geometry = "";
         if ($a_geometry != "") {
             if (is_int(strpos($a_geometry, "x"))) {
                 $geometry = " -geometry " . $a_geometry . " ";
             } else {
                 $geometry = " -geometry " . $a_geometry . "x" . $a_geometry . " ";
             }
         }
         
         $bg_color = ($a_background_color != "")
             ? " -background color " . $a_background_color . " "
             : "";
         $convert_cmd = ilUtil::escapeShellArg($a_from) . " " . $bg_color . $geometry . ilUtil::escapeShellArg($format_str . $a_to);
 
         ilUtil::execConvert($convert_cmd);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ convertPhpIniSizeValueToBytes()

static ilUtil::convertPhpIniSizeValueToBytes ( $phpIniSizeValue )

static

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

     {
         if (is_numeric($phpIniSizeValue)) {
             return $phpIniSizeValue;
         }
 
         $suffix = substr($phpIniSizeValue, -1);
         $value = substr($phpIniSizeValue, 0, -1);
         
         switch (strtoupper($suffix)) {
             case 'P':
                 $value *= 1024;
                 // no break
             case 'T':
                 $value *= 1024;
                 // no break
             case 'G':
                 $value *= 1024;
                 // no break
             case 'M':
                 $value *= 1024;
                 // no break
             case 'K':
                 $value *= 1024;
                 break;
         }
         
         return $value;
     }

◆ createDirectory()

static ilUtil::createDirectory	(	$a_dir,
		$a_mod = `0755`
	)

static

create directory

Parameters

string	$a_dir
int	$a_mod

Deprecated:: in favour of Filesystem::createDir() located at the filesystem service.

See also: ::createDir()

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

References makeDir().

Referenced by ilObjMediaObject\_createThumbnailDirectory(), ilObjCategoryGUI\_importCategories(), ilExerciseManagementCollectFilesJob\copyFileToSubDirectory(), ilObjMediaObject\createDirectory(), ilExerciseManagementCollectFilesJob\createSubmissionsDirectory(), ilMediaItem\createWorkDirectory(), ilPropertyFormGUI\getHTML(), ilTempnam(), ilSCORM2004ScoGUI\importSave(), assQuestion\moveUploadedMediaFile(), and ilSetup\unzip().

     {
         ilUtil::makeDir($a_dir);
         //@mkdir($a_dir);
         //@chmod($a_dir, $a_mod);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ CreateIsoFromFolder()

static ilUtil::CreateIsoFromFolder	(	$a_dir,
		$a_file
	)

static

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

References $name, $source, escapeShellArg(), and execQuoted().

Referenced by ilScorm2004Export\buildExportFileISO().

     {
         $cdir = getcwd();
 
         $pathinfo = pathinfo($a_dir);
         chdir($pathinfo["dirname"]);
         
         $pathinfo = pathinfo($a_file);
         $dir = $pathinfo["dirname"];
         $file = $pathinfo["basename"];
         $zipcmd = "-r " . ilUtil::escapeShellArg($a_file) . " " . $source;
 
         $mkisofs = PATH_TO_MKISOFS;
         if (!$mkisofs) {
             chdir($cdir);
             return false;
         }
         
         $name = basename($a_dir);
         $source = ilUtil::escapeShellArg($name);
 
         $zipcmd = "-r -J -o " . $a_file . " " . $source;
         ilUtil::execQuoted($mkisofs, $zipcmd);
         chdir($cdir);
         return true;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ date_mysql2time()

static ilUtil::date_mysql2time ( $mysql_date_time )

static

make time object from mysql_date_time

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

References $tag.

Referenced by ilFileXMLWriter\start().

     {
         list($datum, $uhrzeit) = explode(" ", $mysql_date_time);
         list($jahr, $monat, $tag) = explode("-", $datum);
         list($std, $min, $sec) = explode(":", $uhrzeit);
         return mktime((int) $std, (int) $min, (int) $sec, (int) $monat, (int) $tag, (int) $jahr);
     }

Here is the caller graph for this function:

◆ dbSupportsDisctinctUmlauts()

static ilUtil::dbSupportsDisctinctUmlauts ( )

static

Only temp fix for #8603, should go to db classes.

Parameters

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

References $DIC, and $ilDB.

Referenced by ilAlphabetInputGUI\fixDBUmlauts().

     {
         global $DIC;
 
         if (!isset(self::$db_supports_distinct_umlauts)) {
             $ilDB = $DIC->database();
             $set = $ilDB->query("SELECT (" . $ilDB->quote("A", "text") . " = " . $ilDB->quote("Ä", "text") . ") t FROM DUAL ");
             $rec = $ilDB->fetchAssoc($set);
             self::$db_supports_distinct_umlauts = !(bool) $rec["t"];
         }
 
         return self::$db_supports_distinct_umlauts;
     }

Here is the caller graph for this function:

◆ deducibleSize()

static ilUtil::deducibleSize ( $a_mime )

static

checks if mime type is provided by getimagesize()

Parameters

string $a_mime mime format

Returns: boolean returns true if size is deducible by getimagesize()_DiffEngine

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

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

     {
         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:

◆ delDir()

static ilUtil::delDir	(	$a_dir,
		$a_clean_only = `false`
	)

static

removes a dir and all its content (subdirs and files) recursively

public

Parameters

string	$a_dir	dir to delete
bool	$a_clean_only

Author: Unknown flexe.nosp@m.r@cu.nosp@m.tephp.nosp@m..com (source: http://www.php.net/rmdir)

Deprecated:: in favour of Filesystem::deleteDir() located at the filesystem service.

See also: ::deleteDir()

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

References $files.

Referenced by ilMailCronOrphanedMailsDeletionProcessor\__construct(), ilFileDataMail\__deleteAttachmentDirectory(), ilObjTest\_createImportDirectory(), assSingleChoice\afterSyncWithOriginal(), assMatchingQuestion\afterSyncWithOriginal(), ilScorm2004DataSet\afterXmlRecordWriting(), ilUserDataSet\afterXmlRecordWriting(), ilPortfolioHTMLExport\buildExportFile(), ilWikiHTMLExport\buildExportFile(), ilObjBlogGUI\buildExportFile(), ilScorm2004Export\buildExportFileHTML(), ilScorm2004Export\buildExportFileHTMLOne(), ilScorm2004Export\buildExportFileISO(), ilScorm2004Export\buildExportFilePDF(), ilScorm2004Export\buildExportFileSCORM(), ilSurveyExport\buildExportFileXML(), ilObjStyleSheet\cleanExportDirectory(), assOrderingQuestion\cleanImagefiles(), ilMathJax\clearCache(), ilObjFile\clearDataDirectory(), assLongMenu\clearFolder(), ilExAssignment\clearMultiFeedbackDirectory(), ilMobMultiSrtUpload\clearMultiSrtDirectory(), ilObjMediaObject\clearMultiSrtDirectory(), ilSetup\cloneFromSource(), ilTestExportGUI\createTestArchiveExport(), ilCertificateUtilHelper\delDir(), ilUpdateUtils\delDir(), ilObjMediaObject\delete(), ilFileDataForumDrafts\delete(), ilObjFileBasedLM\delete(), ilFileSystemStorage5069\delete(), ilFileSystemStorage\delete(), ilBadgeImageTemplate\delete(), ilExportGUI\delete(), ilObjSurvey\delete(), ilObjContentObject\delete(), ilClient\delete(), SurveyQuestion\delete(), ilObjSAHSLearningModule\delete(), assQuestion\delete(), ilObjSurveyQuestionPool\deleteAllData(), ilFileDataCourse\deleteDirectory(), ilFileSystemStorage5069\deleteDirectory(), ilFileSystemStorage\deleteDirectory(), ilObjSurveyQuestionPoolGUI\deleteExportFileObject(), ilFileSystemGUI\deleteFile(), ilObjMediaObjectGUI\deleteFileObject(), ilExAssignment\deleteGlobalFeedbackFile(), ilObjQuestionPool\deleteQuestionpool(), ilBadge\deleteStaticFiles(), assQuestion\deleteSuggestedSolutions(), ilObjSurvey\deleteSurveyRecord(), ilZipBackgroundTaskHandler\deleteTempFiles(), ilObjTest\deleteTest(), ilObjFile\deleteVersions(), ilFileDataForumDrafts\deliverZipFile(), ilFileDataForum\deliverZipFile(), ilObjFile\doDelete(), ilExSubmission\downloadAllAssignmentFiles(), ilObjFolder\downloadFolder(), ilExSubmission\downloadMultipleFiles(), ilContainerGUI\downloadMultipleObjects(), ilExport\exportEntity(), ilObjGlossary\exportHTML(), ilObjFileBasedLMGUI\exportHTML(), ilObjContentObject\exportHTML(), ilExportContainer\exportObject(), ilExport\exportObject(), ilObjUser\exportPersonalData(), ilObjContentObject\exportSCORM(), ilCloudPluginUploadGUI\handleFileUpload(), ilExAssignment\handleGlobalFeedbackFileUpload(), ilObjUserFolderGUI\importCancelledObject(), ilExcCriteriaFile\importFromPeerReviewForm(), ilObjContentObject\importFromZipFile(), ilImport\importObject(), ilObjSurveyQuestionPool\importObject(), ilObjSurvey\importObject(), ilObjUserFolderGUI\importUserRoleAssignmentObject(), ilObjUserFolderGUI\importUsersObject(), ilObjQuestionPoolGUI\importVerifiedFileObject(), ilObjTestGUI\importVerifiedFileObject(), ilScormAiccImporter\importXmlRepresentation(), assMultipleChoice\isForcedEmptySolution(), ilTestExportGUI\listExportFiles(), ilZipBackgroundTaskHandler\process(), ilExSubmission\processUploadedZipFile(), ilFileUtils\processZipFile(), assKprimChoice\removeAnswerImage(), ilAssFileUploadUploadsExporter\removeFileUploadCollection(), ilObjTest\removeTestResultsByActiveIds(), ilSubmissionsZipJob\run(), ilCalendarZipJob\run(), assSingleChoice\savePreviewData(), ilObjFileGUI\saveUnzip(), ilOrgUnitExporter\sendAndCreateSimpleExportFile(), assSingleChoice\syncImages(), assMultipleChoice\syncImages(), assQuestion\syncSuggestedSolutionFiles(), ilFileDataImportMail\unlinkLast(), unzip(), ilSetup\updateNewClient(), ilObjFileGUI\uploadFiles(), ilObjHelpSettings\uploadHelpModule(), ilExAssignment\uploadMultiFeedbackFile(), ilMobMultiSrtUpload\uploadMultipleSubtitleFile(), ilObjMediaObject\uploadMultipleSubtitleFile(), ilObjSAHSLearningModuleGUI\uploadObject(), ilObjQuestionPoolGUI\uploadQplObject(), and ilObjTestGUI\uploadTstObject().

     {
         if (!is_dir($a_dir) || is_int(strpos($a_dir, ".."))) {
             return;
         }
 
         $current_dir = opendir($a_dir);
 
         $files = array();
 
         // this extra loop has been necessary because of a strange bug
         // at least on MacOS X. A looped readdir() didn't work
         // correctly with larger directories
         // when an unlink happened inside the loop. Getting all files
         // into the memory first solved the problem.
         while ($entryname = readdir($current_dir)) {
             $files[] = $entryname;
         }
 
         foreach ($files as $file) {
             if (is_dir($a_dir . "/" . $file) and ($file != "." and $file != "..")) {
                 ilUtil::delDir($a_dir . "/" . $file);
             } elseif ($file != "." and $file != "..") {
                 unlink($a_dir . "/" . $file);
             }
         }
 
         closedir($current_dir);
         if (!$a_clean_only) {
             @rmdir($a_dir);
         }
     }

Here is the caller graph for this function:

◆ deliverData()

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

static

deliver data for download via browser.

We need to set the following headers to make downloads work using IE in HTTPS mode.

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

References $ascii_filename, exit, getASCIIFilename(), and ilHTTPS\getInstance().

Referenced by ilTestExport\aggregatedResultsToCSV(), ilCertificateUtilHelper\deliverData(), ilMemberExportGUI\deliverData(), ilObjSurvey\deliverPDFfromFO(), ilObjTest\deliverPDFfromFO(), ilPublicUserProfileGUI\deliverVCard(), ilObjLanguageFolderGUI\downloadDeprecatedObject(), ilMemberExportGUI\downloadExportFile(), ilObjSystemFolderGUI\downloadJavaServerIniObject(), ilObjLanguageExtGUI\downloadObject(), ilBookmarkAdministrationGUI\export(), ilSurveyParticipantsGUI\exportAllCodesObject(), ilAccountCodesGUI\exportCodes(), ilRegistrationSettingsGUI\exportCodes(), ilSurveyParticipantsGUI\exportCodesObject(), ilSessionOverviewGUI\exportCSV(), ilSurveyEvaluationGUI\exportCumulatedResults(), ilSurveyEvaluationGUI\exportEvaluationUser(), ilForumExportGUI\exportHTML(), ilObjLinkResourceGUI\exportHTML(), ilECSSettingsGUI\exportImported(), ilObjAssessmentFolderGUI\exportLogObject(), ilNoteGUI\exportNotesHTML(), ilECSSettingsGUI\exportReleased(), ilDidacticTemplateSettingsGUI\exportTemplate(), ilTestExport\exportToCSV(), ilCalendarRemoteAccessHandler\handleRequest(), ilPageObject\send_paragraph(), and ilObjSCORMLearningModule\sendExportFile().

     {
         $disposition = "attachment"; // "inline" to view file in browser or "attachment" to download to hard disk
         //              $mime = "application/octet-stream"; // or whatever the mime type is
 
         include_once './Services/Http/classes/class.ilHTTPS.php';
         
         //if($_SERVER['HTTPS'])
         if (ilHTTPS::getInstance()->isDetected()) {
 
             // Added different handling for IE and HTTPS => send pragma after content informations
             #header("Pragma: ");
             #header("Cache-Control: ");
             #header("Expires: Mon, 26 Jul 1997 05:00:00 GMT");
             #header("Last-Modified: " . gmdate("D, d M Y H:i:s") . " GMT");
             #header("Cache-Control: no-store, no-cache, must-revalidate"); // HTTP/1.1
             #header("Cache-Control: post-check=0, pre-check=0", false);
         } elseif ($disposition == "attachment") {
             header("Cache-control: private");
         } else {
             header("Cache-Control: no-cache, must-revalidate");
             header("Pragma: no-cache");
         }
 
         $ascii_filename = ilUtil::getASCIIFilename($a_filename);
 
         if (strlen($charset)) {
             $charset = "; charset=$charset";
         }
         header("Content-Type: $mime$charset");
         header("Content-Disposition:$disposition; filename=\"" . $ascii_filename . "\"");
         header("Content-Description: " . $ascii_filename);
         header("Content-Length: " . (string) (strlen($a_data)));
 
         //if($_SERVER['HTTPS'])
         if (ilHTTPS::getInstance()->isDetected()) {
             header('Cache-Control: must-revalidate, post-check=0, pre-check=0');
             header('Pragma: public');
         }
 
         header("Connection: close");
         echo $a_data;
         exit;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ deliverFile()

static ilUtil::deliverFile	(	$a_file,
		$a_filename,
		$a_mime = `''`,
		$isInline = `false`,
		$removeAfterDelivery = `false`,
		$a_exit_after = `true`
	)

static

deliver file for download via browser.

Parameters

$mime	Mime of the file
$isInline	Set this to true, if the file shall be shown in browser

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

References $DIC, ilFileDelivery\DISP_ATTACHMENT, and ilFileDelivery\DISP_INLINE.

Referenced by ilObjTestVerificationGUI\deliver(), ilObjExerciseVerificationGUI\deliver(), ilObjSCORMVerificationGUI\deliver(), ilObjCourseVerificationGUI\deliver(), ilZipBackgroundTaskHandler\deliver(), ilMailFolderGUI\deliverAttachments(), ilCertificateUtilHelper\deliverFile(), ilWikiUserHTMLExport\deliverFile(), ilFileDataForumDrafts\deliverFile(), ilFileDataForum\deliverFile(), ilMailFolderGUI\deliverFile(), assFileUpload\deliverFileUploadZIPFile(), ilBookingObjectGUI\deliverInfo(), ilNewsItem\deliverMobFile(), ilHtmlToPdfTransformerFactory\deliverPDF(), ilBookingObjectGUI\deliverPostFile(), ilFileDataForumDrafts\deliverZipFile(), ilFileDataForum\deliverZipFile(), ilExportGUI\download(), ilIndividualAssessmentMemberGUI\downloadAttachment(), ilBlogExerciseGUI\downloadExcAssFile(), ilPortfolioExerciseGUI\downloadExcAssFile(), ilBlogExerciseGUI\downloadExcSubFile(), ilPortfolioExerciseGUI\downloadExcSubFile(), ilWikiPageGUI\downloadExcSubFile(), ilSCORM2004ScoGUI\downloadExportFile(), ilGlossaryPresentationGUI\downloadExportFile(), ilObjSCORM2004LearningModuleGUI\downloadExportFile(), ilLMPresentationGUI\downloadExportFile(), ilObjSurveyQuestionPoolGUI\downloadExportFileObject(), ilObjUserFolderGUI\downloadExportFileObject(), ilExSubmissionGUI\downloadFeedbackFileObject(), ilAdvancedMDSettingsGUI\downloadFile(), ilFileSystemGUI\downloadFile(), ilObjIndividualAssessmentGUI\downloadFileObject(), ilExSubmissionGUI\downloadFileObject(), ilObjFolder\downloadFolder(), ilObjFolderGUI\downloadFolderObject(), ilExSubmissionGUI\downloadGlobalFeedbackFileObject(), ilExAssignmentEditorGUI\downloadGlobalFeedbackFileObject(), ilExSubmission\downloadMultipleFiles(), ilContainerGUI\downloadMultipleObjects(), ilObjContentObjectGUI\downloadPDFFile(), ilExPeerReviewGUI\downloadPeerReviewObject(), ilSCORM2004ScoGUI\downloadResource(), ilExSubmission\downloadSingleFile(), ilSAHSEditGUI\executeCommand(), ilObjPortfolioBaseGUI\export(), ilObjBlogGUI\export(), ilPageLayoutAdministrationGUI\exportLayout(), ilObjQuestionPoolGUI\exportQuestionObject(), ilObjStyleSheetGUI\exportStyleObject(), ilTestExportGUI\listExportFiles(), ilOrgUnitExporter\sendAndCreateSimpleExportFile(), ilDclRecordListGUI\sendFile(), ilObjSessionGUI\sendFileObject(), ilObjCourseGUI\sendFileObject(), ilExAssignment\sendMultiFeedbackStructureFile(), and ilObjUser\sendPersonalDataFile().

       {
         global $DIC;
         // should we fail silently?
         if (!file_exists($a_file)) {
             return false;
         }
         $delivery = new ilFileDelivery($a_file);
 
         if ($isInline) {
             $delivery->setDisposition(ilFileDelivery::DISP_INLINE);
         } else {
             $delivery->setDisposition(ilFileDelivery::DISP_ATTACHMENT);
         }
 
         if (strlen($a_mime)) {
             $delivery->setMimeType($a_mime);
         }
 
         $delivery->setDownloadFileName($a_filename);
         $delivery->setConvertFileNameToAsci((bool) !$DIC->clientIni()->readVariable('file_access', 'disable_ascii'));
         $delivery->setDeleteFile($removeAfterDelivery);
         $delivery->deliver();
     }

Here is the caller graph for this function:

◆ dirsize()

static ilUtil::dirsize ( $directory )

static

get size of a directory or a file.

Parameters

string path to a directory or a file

Returns: integer. Returns -1, if the directory does not exist.

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

References $size.

Referenced by ilObjFileBasedLMAccess\_lookupDiskUsage(), ilObjMediaCastAccess\_lookupDiskUsage(), ilObjSAHSLearningModuleAccess\_lookupDiskUsage(), ilObjFileAccess\_lookupDiskUsage(), ilFileDataMail\_lookupDiskUsageOfUser(), ilExSubmission\downloadAllAssignmentFiles(), ilMathJax\getCacheSize(), ilObjPortfolio\handleQuotaUpdate(), ilVerificationObject\handleQuotaUpdate(), ilObjBlog\handleQuotaUpdate(), ilCronPersonalWorkspaceRecalculateQuota\quotaHandleFile(), ilCronPersonalWorkspaceRecalculateQuota\quotaHandleFileStorage(), ilCronPersonalWorkspaceRecalculateQuota\quotaHandleMob(), and ilCronPersonalWorkspaceRecalculateQuota\quotaHandleVerification().

     {
         $size = 0;
         if (!is_dir($directory)) {
             // BEGIN DiskQuota Suppress PHP warning when attempting to determine
             //       dirsize of non-existing directory
             $size = @filesize($directory);
             // END DiskQuota Suppress PHP warning.
             return ($size === false) ? -1 : $size;
         }
         if ($DIR = opendir($directory)) {
             while (($dirfile = readdir($DIR)) !== false) {
                 if (is_link($directory . DIRECTORY_SEPARATOR . $dirfile) || $dirfile == '.' || $dirfile == '..') {
                     continue;
                 }
                 if (is_file($directory . DIRECTORY_SEPARATOR . $dirfile)) {
                     $size += filesize($directory . DIRECTORY_SEPARATOR . $dirfile);
                 } elseif (is_dir($directory . DIRECTORY_SEPARATOR . $dirfile)) {
                     // BEGIN DiskQuota: dirsize is not a global function anymore
                     $dirSize = ilUtil::dirsize($directory . DIRECTORY_SEPARATOR . $dirfile);
                     // END DiskQuota: dirsize is not a global function anymore
                     if ($dirSize >= 0) {
                         $size += $dirSize;
                     } else {
                         return -1;
                     }
                 }
             }
             closedir($DIR);
         }
         return $size;
     }

Here is the caller graph for this function:

◆ dumpString()

static ilUtil::dumpString ( $a_str )

static

dumps ord values of every character of string $a_str

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

References $i, and $ret.

     {
         $ret = $a_str . ": ";
         for ($i = 0; $i < strlen($a_str); $i++) {
             $ret .= ord(substr($a_str, $i, 1)) . " ";
         }
         return $ret;
     }

◆ dumpVar()

static ilUtil::dumpVar ( $mixed = null )

static

Dump var.

Parameters

null $mixed

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

     {
         echo '<pre>';
         var_dump($mixed);
         echo '</pre>';
     }

◆ escapeShellArg()

static ilUtil::escapeShellArg ( $a_arg )

static

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

Referenced by ilFFmpeg\convert(), convertImage(), CreateIsoFromFolder(), ilPreviewRenderer\createPreviewImage(), ilExSubmission\downloadAllAssignmentFiles(), ilExSubmission\downloadMultipleFiles(), ilFFmpeg\extractImage(), ilObjMediaObject\generatePreviewPic(), ilObjFile\getXMLZip(), ilObjSCORMLearningModuleGUI\newModuleVersionUpload(), ilGhostscriptRenderer\renderImages(), resizeImage(), unzip(), ilSetup\unzip(), ilObjPortfolioBase\uploadImage(), ilObjBlog\uploadImage(), ilObjPoll\uploadImage(), ilPersonalProfileGUI\uploadUserPicture(), ilObjUserGUI\uploadUserPictureObject(), and zip().

     {
         setlocale(LC_CTYPE, "UTF8", "en_US.UTF-8"); // fix for PHP escapeshellcmd bug. See: http://bugs.php.net/bug.php?id=45132
         // see also ilias bug 5630
         return escapeshellarg($a_arg);
     }

Here is the caller graph for this function:

◆ escapeShellCmd()

static ilUtil::escapeShellCmd ( $a_arg )

static

escape shell cmd

public

Parameters

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

Referenced by ilImagemapPreview\createPreview(), and ilObjPoll\uploadImage().

     {
         if (ini_get('safe_mode') == 1) {
             return $a_arg;
         }
         setlocale(LC_CTYPE, "UTF8", "en_US.UTF-8"); // fix for PHP escapeshellcmd bug. See: http://bugs.php.net/bug.php?id=45132
         return escapeshellcmd($a_arg);
     }

Here is the caller graph for this function:

◆ excelTime()

static ilUtil::excelTime	(	$year = `""`,
		$month = `""`,
		$day = `""`,
		$hour = `""`,
		$minute = `""`,
		$second = `""`
	)

static

Calculates a Microsoft Excel date/time value.

Calculates a Microsoft Excel date/time value (nr of days after 1900/1/1 0:00) for a given date and time. The function only accepts dates after 1970/1/1, because the unix timestamp functions used in the function are starting with that date. If you don't enter parameters the date/time value for the actual date/time will be calculated.

static function

Parameters

integer	$year	Year
integer	$month	Month
integer	$day	Day
integer	$hour	Hour
integer	$minute	Minute
integer	$second	Second

Returns: float The Microsoft Excel date/time value public

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

     {
         $starting_time = mktime(0, 0, 0, 1, 2, 1970);
         if (strcmp("$year$month$day$hour$minute$second", "") == 0) {
             $target_time = time();
         } else {
             if ($year < 1970) {
                 return 0;
             }
         }
         $target_time = mktime($hour, $minute, $second, $month, $day, $year);
         $difference = $target_time - $starting_time;
         $days = (($difference - ($difference % 86400)) / 86400);
         $difference = $difference - ($days * 86400) + 3600;
         
         // #15343 - using a global locale leads to , instead of . for (implicit) floats
         return str_replace(",", ".", ($days + 25570 + ($difference / 86400)));
     }

◆ execConvert()

static ilUtil::execConvert ( $args )

static

execute convert command

Parameters

string $args

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

References execQuoted().

Referenced by ilObjUser\_uploadPersonalPicture(), convertImage(), ilImagemapPreview\createPreview(), ilObjectTileImage\delete(), ilObjMediaObject\generatePreviewPic(), resizeImage(), ilObjPortfolioBase\uploadImage(), ilObjBlog\uploadImage(), ilPersonalProfileGUI\uploadUserPicture(), and ilObjUserGUI\uploadUserPictureObject().

     {
         $args = self::escapeShellCmd($args);
         ilUtil::execQuoted(PATH_TO_CONVERT, $args);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ execQuoted()

static ilUtil::execQuoted	(	$cmd,
		$args = `null`
	)

static

exec command and fix spaces on windows

Parameters

string	$cmd
string	$args

Returns: array

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

References $DIC, and isWindows().

Referenced by CreateIsoFromFolder(), ilPreviewRenderer\createPreviewImage(), ilGitInformation\detect(), ilFFmpeg\exec(), execConvert(), ilPhantomJSRenderer\generatePDF(), isConvertVersionAtLeast(), ilCountPDFPagesPreProcessors\process(), ilGhostscriptRenderer\renderImages(), unzip(), ilObjPoll\uploadImage(), and zip().

     {
         global $DIC;
         
         if (ilUtil::isWindows() && strpos($cmd, " ") !== false && substr($cmd, 0, 1) !== '"') {
             // cmd won't work without quotes
             $cmd = '"' . $cmd . '"';
             if ($args) {
                 // args are also quoted, workaround is to quote the whole command AGAIN
                 // was fixed in php 5.2 (see php bug #25361)
                 if (version_compare(phpversion(), "5.2", "<") && strpos($args, '"') !== false) {
                     $cmd = '"' . $cmd . " " . $args . '"';
                 }
                 // args are not quoted or php is fixed, just append
                 else {
                     $cmd .= " " . $args;
                 }
             }
         }
         // nothing todo, just append args
         elseif ($args) {
             $cmd .= " " . $args;
         }
         exec($cmd, $arr);
 
         $DIC->logger()->root()->debug("ilUtil::execQuoted: " . $cmd . ".");
 
         return $arr;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ extractParameterString()

static ilUtil::extractParameterString ( $a_parstr )

static

extracts parameter value pairs from a string into an array

Parameters

string $a_parstr parameter string (format: par1="value1", par2="value2", ...)

Returns: array array of parameter value pairs

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

References $ok.

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

     {
         // parse parameters in array
         $par = array();
         $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;
                 }
             }
         }
 
         if ($ok) {
             return $par;
         } else {
             return false;
         }
     }

Here is the caller graph for this function:

◆ fmtFloat()

static ilUtil::fmtFloat	(	$a_float,
		$a_decimals = `0`,
		$a_dec_point = `null`,
		$a_thousands_sep = `null`,
		$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. public

Parameters

float	the float to format
integer	count of decimals
integer	display thousands separator
boolean	whether .0 should be suppressed

Returns: string formatted number

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

References $DIC, $lng, and $txt.

     {
         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;
     }

◆ formatBytes()

static ilUtil::formatBytes	(	$size,
		$decimals = `0`
	)

static

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

References $i, and $size.

     {
         $unit = array('', 'K', 'M', 'G', 'T', 'P');
 
         for ($i = 0, $maxUnits = count($unit); $size >= 1024 && $i <= $maxUnits; $i++) {
             $size /= 1024;
         }
 
         return round($size, $decimals) . $unit[$i];
     }

◆ formatSize()

static ilUtil::formatSize	(	$size,
		$a_mode = `'short'`,
		$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 4956 of file class.ilUtil.php.

References $DIC, $lng, $result, and $size.

Referenced by ilFileVersionTableGUI\__construct(), ilInfoScreenGUI\addObjectSections(), ilMemberExportFileTableGUI\fillRow(), ilDclExportTableGUI\fillRow(), ilLMDownloadTableGUI\fillRow(), ilFileVersionsTableGUI\fillRow(), ilExportTableGUI\fillRow(), ilFileSystemTableGUI\fillRow(), ilMailAttachmentTableGUI\formatValue(), ilObjFileListGUI\getProperties(), ilDiskQuotaHandler\getStatusLegend(), ilObjUserGUI\getValues(), ilObjFileGUI\infoScreenForward(), ilFolderDownloadBackgroundTaskHandler\init(), outMobImageParams(), ilDiskQuotaReminderMail\replacePlaceholders(), ilMailAttachmentGUI\saveAttachments(), ilDiskQuotaSummaryNotification\send(), ilMailFormGUI\showForm(), ilMailAttachmentGUI\uploadFile(), and ilObjFileAccessSettingsGUI\viewDiskQuotaReport().

     {
         global $DIC;
 
         $lng = $DIC->language();
         if ($a_lng == null) {
             $a_lng = $lng;
         }
 
         $mag = self::_getSizeMagnitude();
 
         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:

◆ formCheckbox()

static ilUtil::formCheckbox	(	$checked,
		$varname,
		$value,
		$disabled = `false`
	)

static

??? public

Parameters

string
string
string
boolean	disabled checked checkboxes (default: false)

Returns: string

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

Referenced by ilObjCategoryGUI\_importCategoriesForm(), ilLocalUserGUI\assignRoles(), ilObjCategoryGUI\assignRolesObject(), ilECSNodeMappingCmsExplorer\buildFormItem(), ilECSNodeMappingLocalExplorer\buildFormItem(), ilPasteIntoMultipleItemsExplorer\buildFormItem(), ilWorkspaceExplorer\buildFormItem(), ilForumModeratorsGUI\detachModeratorRole(), ilRegistrationSettingsGUI\editEmailAssignments(), ilRegistrationSettingsGUI\editRoles(), ilForumDraftsTableGUI\fillRow(), ilQuestionPoolImportVerificationTableGUI\fillRow(), ilTestPersonalDefaultSettingsTableGUI\fillRow(), ilMailAttachmentTableGUI\fillRow(), ilMarkSchemaTableGUI\fillRow(), ilWebResourceEditableLinkTableGUI\fillRow(), ilForumTopicTableGUI\fillRow(), ilBuddySystemRelationsTableGUI\fillRow(), ilForumSettingsGUI\getUserNotificationTableData(), ilObjRoleGUI\listUsersRoleObject(), ilNestedListInputGUI\render(), ilMailingListsGUI\showMailingLists(), ilMailingListsGUI\showMembersList(), ilMailSearchGUI\showResults(), and ilStartUpGUI\showTermsOfService().

     {
         $str = "<input type=\"checkbox\" name=\"" . $varname . "\"";
 
         if ($checked == 1) {
             $str .= " checked=\"checked\"";
         }
 
         if ($disabled) {
             $str .= " disabled=\"disabled\"";
         }
 
         $array_var = false;
 
         if (substr($varname, -2) == "[]") {
             $array_var = true;
         }
 
         // if varname ends with [], use varname[-2] + _ + value as id tag (e.g. "user_id[]" => "user_id_15")
         if ($array_var) {
             $varname_id = substr($varname, 0, -2) . "_" . $value;
         } else {
             $varname_id = $varname;
         }
 
         // dirty removal of other "[]" in string
         $varname_id = str_replace("[", "_", $varname_id);
         $varname_id = str_replace("]", "", $varname_id);
 
         $str .= " value=\"" . $value . "\" id=\"" . $varname_id . "\" />\n";
 
         return $str;
     }

Here is the caller graph for this function:

◆ formDisabledRadioButton()

static ilUtil::formDisabledRadioButton	(	$checked,
		$varname,
		$value,
		$disabled
	)

static

???

Parameters

string

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

     {
         if ($disabled) {
             $str = "<input disabled type=\"radio\" name=\"" . $varname . "\"";
         } else {
             $str = "<input type=\"radio\" name=\"" . $varname . "\"";
         }
         if ($checked == 1) {
             $str .= " checked=\"checked\"";
         }
 
         $str .= " value=\"" . $value . "\"";
         $str .= " id=\"" . $value . "\" />\n";
 
         return $str;
     }

◆ formInput()

static ilUtil::formInput	(	$varname,
		$value,
		$disabled = `false`
	)

static

create html input area

Parameters

string	$varname	name of form variable
string	$value	value and id of input
boolean	$disabled	if true, input appears disabled

Returns: string string

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

Referenced by ilChatroomSmiliesTableGUI\fillRow().

     {
         $str = "<input type=\"input\" name=\"" . $varname . "\"";
         if ($disabled) {
             $str .= " disabled";
         }
 
         $str .= " value=\"" . $value . "\"";
 
         $str .= " id=\"" . $value . "\" />\n";
 
         return $str;
     }

Here is the caller graph for this function:

◆ formRadioButton()

static ilUtil::formRadioButton	(	$checked,
		$varname,
		$value,
		$onclick = `null`,
		$disabled = `false`
	)

static

??? public

Parameters

string
string
string

Returns: string

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

Referenced by ilECSNodeMappingCmsExplorer\buildFormItem(), ilECSNodeMappingLocalExplorer\buildFormItem(), ilPasteIntoMultipleItemsExplorer\buildFormItem(), ilWorkspaceExplorer\buildFormItem(), and ilForumTopicTableGUI\fillRow().

     {
         $str = '<input ';
 
         if ($onclick) {
             $str .= ('onclick="' . $onclick . '"');
         }
         
         $str .= (" type=\"radio\" name=\"" . $varname . "\"");
         if ($checked == 1) {
             $str .= " checked=\"checked\"";
         }
 
         if ($disabled) {
             $str .= " disabled=\"disabled\"";
         }
 
         $str .= " value=\"" . $value . "\"";
 
         $str .= " id=\"" . $value . "\" />\n";
 
         return $str;
     }

Here is the caller graph for this function:

◆ formSelect()

static ilUtil::formSelect	(	$selected,
		$varname,
		$options,
		$multiple = `false`,
		$direct_text = `false`,
		$size = `"0"`,
		$style_class = `""`,
		$attribs = `""`,
		$disabled = `false`
	)

static

Builds a select form field with options and shows the selected option first.

public

Parameters

string/array	value to be selected
string	variable name in formular
array	array with $options (key = lang_key, value = long name)
boolean	multiple selection list true/false
boolean	if true, the option values are displayed directly, otherwise they are handled as language variable keys and the corresponding language variable is displayed
int	size
string	style class
array	additional attributes (key = attribute name, value = attribute value)
boolean	disabled

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

References $attributes, $DIC, $key, $lng, PHPMailer\PHPMailer\$options, $size, and $style.

       {
         global $DIC;
 
         $lng = $DIC->language();
 
         if ($multiple == true) {
             $multiple = " multiple=\"multiple\"";
         } else {
             $multiple = "";
             $size = 0;
         }
 
         $class = " class=\" form-control " . $style_class . "\"";
 
         // use form-inline!
         // this is workaround the whole function should be set deprecated
         // $attributes = " style='display:inline-block;' ";
 
         if (is_array($attribs)) {
             foreach ($attribs as $key => $val) {
                 $attributes .= " " . $key . "=\"" . $val . "\"";
             }
         }
         if ($disabled) {
             $disabled = ' disabled=\"disabled\"';
         }
 
         $size_str = "";
         if ($size > 0) {
             $size_str = ' size="'.$size.'" ';
         }
         $str = "<select name=\"" . $varname . "\"" . $multiple . " $class " . $size_str . " $attributes $disabled>\n";
 
         foreach ((array) $options as $key => $val) {
             $style = "";
             if (is_array($val)) {
                 $style = $val["style"];
                 $val = $val["text"];            // mus be last line, since we overwrite
             }
 
             $sty = ($style != "")
                 ? ' style="' . $style . '" '
                 : "";
                 
             if ($direct_text) {
                 $str .= " <option $sty value=\"" . $key . "\"";
             } else {
                 $str .= " <option $sty value=\"" . $val . "\"";
             }
             if (is_array($selected)) {
                 if (in_array($key, $selected)) {
                     $str .= " selected=\"selected\"";
                 }
             } elseif ($selected == $key) {
                 $str .= " selected=\"selected\"";
             }
 
             if ($direct_text) {
                 $str .= ">" . $val . "</option>\n";
             } else {
                 $str .= ">" . $lng->txt($val) . "</option>\n";
             }
         }
 
         $str .= "</select>\n";
 
         return $str;
     }

Here is the caller graph for this function:

◆ generatePasswords()

static ilUtil::generatePasswords ( $a_number )

static

Generate a number of passwords.

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

References $i, $ret, and ilSecuritySettings\_getInstance().

Referenced by ilStartUpGUI\_checkGoto(), shibUser\createFields(), ilAuthProviderSoap\handleSoapAuth(), ilAuthContainerSOAP\loginObserver(), and ilAccountRegistrationGUI\saveForm().

     {
         $ret = array();
         srand((double) microtime() * 1000000);
         
         include_once('./Services/PrivacySecurity/classes/class.ilSecuritySettings.php');
         $security = ilSecuritySettings::_getInstance();
 
         for ($i = 1; $i <= $a_number; $i++) {
             $min = ($security->getPasswordMinLength() > 0)
                 ? $security->getPasswordMinLength()
                 : 6;
             $max = ($security->getPasswordMaxLength() > 0)
                 ? $security->getPasswordMaxLength()
                 : 10;
             if ($min > $max) {
                 $max = $max + 1;
             }
             $random = new \ilRandom();
             $length  = $random->int($min, $max);
             $next  = $random->int(1, 2);
             $vowels = "aeiou";
             $vowels_uc = strtoupper($vowels);
             $consonants = "bcdfghjklmnpqrstvwxyz";
             $consonants_uc = strtoupper($consonants);
             $numbers = "1234567890";
             $special = "_.+?#-*@!$%~";
             $pw = "";
             
             if ($security->getPasswordNumberOfUppercaseChars() > 0) {
                 for ($j = 0; $j < $security->getPasswordNumberOfUppercaseChars(); $j++) {
                     switch ($next) {
                         case 1:
                             $pw.= $consonants_uc[$random->int(0, strlen($consonants_uc) - 1)];
                             $next = 2;
                             break;
                         
                         case 2:
                             $pw.= $vowels_uc[$random->int(0, strlen($vowels_uc) - 1)];
                             $next = 1;
                             break;
                     }
                 }
             }
 
             if ($security->isPasswordCharsAndNumbersEnabled()) {
                 $pw.= $numbers[$random->int(0, strlen($numbers) - 1)];
             }
 
             if ($security->isPasswordSpecialCharsEnabled()) {
                 $pw.= $special[$random->int(0, strlen($special) - 1)];
             }
 
             $num_lcase_chars = max($security->getPasswordNumberOfLowercaseChars(), $length - strlen($pw));
             for ($j = 0; $j < $num_lcase_chars; $j++) {
                 switch ($next) {
                     case 1:
                         $pw.= $consonants[$random->int(0, strlen($consonants) - 1)];
                         $next = 2;
                         break;
                     
                     case 2:
                         $pw.= $vowels[$random->int(0, strlen($vowels) - 1)];
                         $next = 1;
                         break;
                 }
             }
 
             $pw = str_shuffle($pw);
         
             $ret[] = $pw;
         }
         return $ret;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getASCIIFilename()

static ilUtil::getASCIIFilename ( $a_filename )

static

convert utf8 to ascii filename

Parameters

string $a_filename utf8 filename

Implementation note: The proper way to convert charsets is mb_convert_encoding. Unfortunately Multibyte String functions are not an installation requirement for ILIAS 3. Codelines behind three slashes '///' show how we would do it using mb_convert_encoding. Note that mb_convert_encoding has the bad habit of substituting unconvertable characters with HTML entitities. Thats why we need a regular expression which replaces HTML entities with their first character. e.g. ä => a

$ascii_filename = mb_convert_encoding($a_filename,'US-ASCII','UTF-8'); $ascii_filename = preg_replace('/&(.)[^;]*;/','\1', $ascii_filename);

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

References $ascii_filename.

Referenced by ilTestExport\aggregatedResultsToCSV(), ilTestExport\aggregatedResultsToExcel(), ilWikiHTMLExport\buildExportFile(), ilExerciseManagementCollectFilesJob\collectAssignmentData(), ilDownloadFilesBackgroundTask\collectFiles(), ilFolderDownloadBackgroundTaskHandler\copyFile(), ilContainerGUI\copyFile(), ilFileDataMail\deliverAttachmentsAsZip(), deliverData(), ilObjSurvey\deliverPDFfromFO(), ilObjTest\deliverPDFfromFO(), ilExSubmission\downloadAllAssignmentFiles(), ilObjFolderGUI\downloadFolderObject(), ilExSubmission\downloadMultipleFiles(), ilSurveyParticipantsGUI\exportAllCodesObject(), ilTestEvaluationGUI\exportCertificate(), ilSurveyParticipantsGUI\exportCodesObject(), ilSurveyEvaluationGUI\exportCumulatedResults(), ilSurveyEvaluationGUI\exportEvaluationUser(), ilObjExercise\exportGradesExcel(), ilCOPageHTMLExport\exportHTMLFileDirect(), ilTestExport\exportToCSV(), ilTestExport\exportToExcel(), ilObjMediaObject\fixFilename(), ilExSubmission\getDirectoryNameFromUserData(), ilAssFileUploadUploadsExporter\getDispoZipFileName(), ilDownloadFilesBackgroundTask\getEventFileNameFromId(), ilTestParticipantData\getFileSystemCompliantFullnameByActiveId(), ilVerificationObject\getOfflineFilename(), ilObjTest\getTitleFilenameCompliant(), assQuestion\getTitleFilenameCompliant(), ilAssFileUploadUploadsExporter\initFilenames(), ilDclMobRecordFieldModel\parseValue(), ilObjFolder\recurseFolder(), ilFolderDownloadBackgroundTaskHandler\recurseFolder(), ilContainerGUI\recurseFolder(), ilDownloadSubmissionsBackgroundTask\run(), ilDownloadFilesBackgroundTask\run(), ilQtiMatImageSecurity\sanitizeLabel(), ilExAssignment\sendMultiFeedbackStructureFile(), and ilObjMediaCastGUI\updateMediaItem().

     {
         // The filename must be converted to ASCII, as of RFC 2183,
         // section 2.3.
 
 
                 
         // #15914 - try to fix german umlauts
         $umlauts = array("Ä" => "Ae", "Ö" => "Oe", "Ü" => "Ue",
             "ä" => "ae", "ö" => "oe", "ü" => "ue", "ß" => "ss");
         foreach ($umlauts as $src => $tgt) {
             $a_filename = str_replace($src, $tgt, $a_filename);
         }
         
         $ascii_filename = htmlentities($a_filename, ENT_NOQUOTES, 'UTF-8');
         $ascii_filename = preg_replace('/\&(.)[^;]*;/', '\\1', $ascii_filename);
         $ascii_filename = preg_replace('/[\x7f-\xff]/', '_', $ascii_filename);
         
         // OS do not allow the following characters in filenames: \/:*?"<>|
         $ascii_filename = preg_replace('/[:\x5c\/\*\?\"<>\|]/', '_', $ascii_filename);
         return $ascii_filename;
     }

Here is the caller graph for this function:

◆ getClientIdByString()

static ilUtil::getClientIdByString ( string $clientId )

static

Parameters

string $clientId

Returns

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

Referenced by ilInitialisation\determineClient().

                                                                  : \ILIAS\Data\ClientId
     {
         $df = new \ILIAS\Data\Factory;
 
         return $df->clientId($clientId);
     }

Here is the caller graph for this function:

◆ getConvertCmd()

static ilUtil::getConvertCmd ( )

static

get convert command

Deprecated:

See also: ilUtil::execConvert()

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

     {
         return PATH_TO_CONVERT;
     }

◆ getDataDir()

static ilUtil::getDataDir ( )

static

get data directory (outside webspace)

Deprecated:: in favour of the filesystem service which should be used to operate on the storage directory.

See also: ::filesystem(); ::storage()

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

     {
         return CLIENT_DATA_DIR;
     }

Here is the caller graph for this function:

◆ getDir()

static ilUtil::getDir	(	$a_dir,
		$a_rec = `false`,
		$a_sub_dir = `""`
	)

static

get directory

Parameters

	$a_dir
bool	$a_rec
string	$a_sub_dir

Returns: array

Deprecated:: in favour of Filesystem::listContents() located at the filesystem service.

See also: ::listContents()

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

References $files, $si, and $size.

Referenced by assOrderingQuestion\cleanImagefiles(), ilSCORM13Package\dbImportSco(), ilObjMediaObjectGUI\editFilesObject(), ilFileDataMail\getAttachmentPathAndFilenameByMd5Hash(), ilCertificateUtilHelper\getDir(), ilFileSystemTableGUI\getEntries(), ilFileDataForumDrafts\getFileDataByMD5Filename(), ilFileDataForum\getFileDataByMD5Filename(), ilFileSystemGUI\getFileList(), ilUploadDirFilesTableGUI\getFiles(), ilAdvancedMDRecordExportFiles\getFiles(), ilObjMediaObject\getFilesOfDirectory(), ilObjStyleSheet\getImages(), ilExAssignment\getMultiFeedbackFiles(), ilMobMultiSrtUpload\getMultiSrtFiles(), ilObjMediaObject\getMultiSrtFiles(), ilObjUser\getPersonalDataExportFile(), ilObjMediaObject\getSrtFiles(), ilObjUserFolderGUI\importUserRoleAssignmentObject(), ilFileDataForumDrafts\unlinkFilesByMD5Filenames(), ilFileDataForum\unlinkFilesByMD5Filenames(), ilFileSystemGUI\unzipFile(), ilObjHelpSettings\uploadHelpModule(), and ilExAssignment\uploadMultiFeedbackFile().

     {
         $current_dir = opendir($a_dir . $a_sub_dir);
 
         $dirs = array();
         $files = array();
         $subitems = array();
         while ($entry = readdir($current_dir)) {
             if (is_dir($a_dir . "/" . $entry)) {
                 $dirs[$entry] = array("type" => "dir", "entry" => $entry,
                     "subdir" => $a_sub_dir);
                 if ($a_rec && $entry != "." && $entry != "..") {
                     $si = ilUtil::getDir($a_dir, true, $a_sub_dir . "/" . $entry);
                     $subitems = array_merge($subitems, $si);
                 }
             } else {
                 if ($entry != "." && $entry != "..") {
                     $size = filesize($a_dir . $a_sub_dir . "/" . $entry);
                     $files[$entry] = array("type" => "file", "entry" => $entry,
                     "size" => $size, "subdir" => $a_sub_dir);
                 }
             }
         }
         ksort($dirs);
         ksort($files);
 
         return array_merge($dirs, $files, $subitems);
     }

Here is the caller graph for this function:

◆ getFileSizeInfo()

static ilUtil::getFileSizeInfo ( )

static

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

References $DIC, and $lng.

Referenced by ilKprimChoiceWizardInputGUI\checkInput(), ilAssSingleChoiceCorrectionsInputGUI\insert(), ilAssMultipleChoiceCorrectionsInputGUI\insert(), ilMultipleChoiceWizardInputGUI\insert(), ilImageWizardInputGUI\insert(), ilMatchingWizardInputGUI\insert(), ilSingleChoiceWizardInputGUI\insert(), and ilMultipleImagesInputGUI\render().

     {
         $max_filesize = self::formatBytes(
             self::getUploadSizeLimitBytes()
         );
         
         global $DIC;
 
         $lng = $DIC->language();
         /*
         // get the value for the maximal uploadable filesize from the php.ini (if available)
         $umf=get_cfg_var("upload_max_filesize");
         // get the value for the maximal post data from the php.ini (if available)
         $pms=get_cfg_var("post_max_size");
 
         // use the smaller one as limit
         $max_filesize=min($umf, $pms);
         if (!$max_filesize) $max_filesize=max($umf, $pms);
         */
         return $lng->txt("file_notice") . " $max_filesize.";
     }

Here is the caller graph for this function:

◆ getGDSupportedImageType()

static ilUtil::getGDSupportedImageType ( $a_desired_type )

static

returns the best supported image type by this PHP build

Parameters

string $desired_type desired image type ("jpg" | "gif" | "png")

Returns: string supported image type ("jpg" | "gif" | "png" | "")

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

Referenced by ilMediaItem\getMapWorkCopyType().

     {
         $a_desired_type = strtolower($a_desired_type);
         // get supported Image Types
         $im_types = ImageTypes();
 
         switch ($a_desired_type) {
             case "jpg":
             case "jpeg":
             if ($im_types & IMG_JPG) {
                 return "jpg";
             }
             if ($im_types & IMG_GIF) {
                 return "gif";
             }
             if ($im_types & IMG_PNG) {
                 return "png";
             }
             break;
 
             case "gif":
             if ($im_types & IMG_GIF) {
                 return "gif";
             }
             if ($im_types & IMG_JPG) {
                 return "jpg";
             }
             if ($im_types & IMG_PNG) {
                 return "png";
             }
             break;
 
             case "png":
             if ($im_types & IMG_PNG) {
                 return "png";
             }
             if ($im_types & IMG_JPG) {
                 return "jpg";
             }
             if ($im_types & IMG_GIF) {
                 return "gif";
             }
             break;
 
             case "svg":
             if ($im_types & IMG_PNG) {
                 return "png";
             }
             if ($im_types & IMG_JPG) {
                 return "jpg";
             }
             if ($im_types & IMG_GIF) {
                 return "gif";
             }
             break;
         }
 
         return "";
     }

Here is the caller graph for this function:

◆ getHtmlPath()

static ilUtil::getHtmlPath ( $relative_path )

static

get url of path

Author: Brandon Blackmoor brand.nosp@m.on.b.nosp@m.lackm.nosp@m.oor@.nosp@m.jfcom.nosp@m..mil public

Parameters

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

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

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

     {
         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	(	$img,
		$module_path = `""`,
		$mode = `"output"`,
		$offline = `false`
	)

static

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

public

Parameters

string	full image filename (e.g. myimage.png)
boolean	should be set to true, if the image is within a module template directory (e.g. content/templates/default/images/test.png)

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

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

     {
         global $DIC;
 
         $styleDefinition = null;
         if (isset($DIC["styleDefinition"])) {
             $styleDefinition = $DIC["styleDefinition"];
         }
 
         if (is_int(strpos($_SERVER["PHP_SELF"], "setup.php"))) {
             $module_path = "..";
         }
         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
         require_once("./Services/Style/System/classes/class.ilStyleDefinition.php");
         $current_skin = ilStyleDefinition::getCurrentSkin();
         $current_style = ilStyleDefinition::getCurrentStyle();
         
         if (is_object($styleDefinition)) {
             $image_dir = $styleDefinition->getImageDirectory($current_style);
         }
         if ($current_skin == "default") {
             $user_img = "." . $module_path . "/templates/default/" . $image_dir . "/" . $img;
             $skin_img = "." . $module_path . "/templates/default/images/" . $img;
         } elseif (is_object($styleDefinition) && $current_skin != "default") {
             $user_img = "./Customizing/global/skin/" .
                 $current_skin . $module_path . "/" . $image_dir . "/" . $img;
             $skin_img = "./Customizing/global/skin/" .
                 $current_skin . $module_path . "/images/" . $img;
         }
 
         // temp svg patch
         /*
         $pi = pathinfo($img);
         if ($pi["dirname"] != "") {
             $pi["dirname"] = $pi["dirname"]."/";
         }
         $svg_img = ".".$module_path."/templates/default/images/".$pi["dirname"].$pi["filename"].".svg";
         if (file_exists($svg_img))
         {
             return $svg_img;
         }*/
 
 
         if ($offline) {
             return "./images/" . $img;
         } elseif (@file_exists($user_img) && $image_dir != "") {
             return $user_img;           // found image for skin and style
         } elseif (file_exists($skin_img)) {
             return $skin_img;           // found image in skin/images
         }
 
         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	(	$a_type,
		$a_path,
		$a_big = `false`
	)

static

Builds an html image tag TODO: function still in use, but in future use getImagePath and move HTML-Code to your template file public.

Parameters

string	object type
string	tpl path

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

References $a_type, $DIC, $filename, $lng, and $size.

Referenced by ilObjMediaPoolGUI\confirmRemove(), ilBookmarkAdministrationGUI\delete(), ilObjContentObjectGUI\delete(), ilObjStyleSheetGUI\deleteObject(), ilPageLayoutAdministrationGUI\deletePgl(), ilContentStyleSettingsGUI\deleteStyle(), ilObjSCORMLearningModuleGUI\deleteTrackingForUser(), ilObjTypeDefinitionGUI\displayList(), ilObjTypeDefinitionGUI\editObject(), and ilObjSCORMLearningModuleGUI\stopUserOfflineMode().

     {
         global $DIC;
 
         $lng = $DIC->language();
 
         $size = ($a_big)
             ? "big"
             : "small";
 
         include_once("./Services/Object/classes/class.ilObject.php");
         $filename = ilObject::_getIcon("", $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 caller graph for this function:

◆ getJavaPath()

static ilUtil::getJavaPath ( )

static

get full java path (dir + java command)

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

     {
         return PATH_TO_JAVA;
         //global $ilias;
 
         //return $ilias->getSetting("java_path");
     }

◆ getJSLocation()

static ilUtil::getJSLocation	(	$a_js_name,
		$a_js_location = `""`,
		$add_version = `false`
	)

static

get full javascript file name (path inclusive) of current user

Parameters

$a_js_name	string The name of the js file
$a_js_location	string The location of the js file e.g. a module path
$add_version	boolean Add version information to the filename public

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

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

     {
         global $DIC;
 
         $ilSetting = $DIC->settings();
 
         // add version as parameter to force reload for new releases
         $js_name = $a_js_name;
         if (strlen($a_js_location) && (strcmp(substr($a_js_location, -1), "/") != 0)) {
             $a_js_location = $a_js_location . "/";
         }
 
         $filename = "";
         // use ilStyleDefinition instead of account to get the current skin
         require_once("./Services/Style/System/classes/class.ilStyleDefinition.php");
         if (ilStyleDefinition::getCurrentSkin() != "default") {
             $filename = "./Customizing/global/skin/" . ilStyleDefinition::getCurrentSkin() . "/" . $a_js_location . $js_name;
         }
         if (strlen($filename) == 0 || !file_exists($filename)) {
             $filename = "./" . $a_js_location . "templates/default/" . $js_name;
         }
         $vers = "";
         if ($add_version) {
             $vers = str_replace(" ", "-", $ilSetting->get("ilias_version"));
             $vers = "?vers=" . str_replace(".", "-", $vers);
         }
         return $filename . $vers;
     }

Here is the call graph for this function:

◆ getMemString()

static ilUtil::getMemString ( )

static

get current memory usage as string

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

     {
         $my_pid = getmypid();
         return ("MEMORY USAGE (% KB PID ): " . `ps -eo%mem,rss,pid | grep $my_pid`);
     }

◆ getMySQLTimestamp()

static ilUtil::getMySQLTimestamp ( $a_ts )

static

Get MySQL timestamp in 4.1.x or higher format (yyyy-mm-dd hh:mm:ss) This function converts a timestamp, if MySQL 4.0 is used.

Parameters

string MySQL timestamp string

Returns: string MySQL 4.1.x timestamp string

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

References $DIC, and $ilDB.

Referenced by ilExSubmission\getLastSubmission().

     {
         global $DIC;
 
         $ilDB = $DIC->database();
 
         return $a_ts;
     }

Here is the caller graph for this function:

◆ getNewContentStyleSheetLocation()

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

static

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

public

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

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

Referenced by ilTinyMCE\addCustomRTESupport(), ilTinyMCE\addRTESupport(), ilTinyMCE\addUserTextEditor(), ilTemplate\fillNewContentStyle(), and ilKioskPageRenderer\getCSSFiles().

     {
         global $DIC;
 
         $ilSetting = $DIC->settings();
 
         // add version as parameter to force reload for new releases
         if ($mode != "filesystem") {
             $vers = str_replace(" ", "-", $ilSetting->get("ilias_version"));
             $vers = "?vers=" . str_replace(".", "-", $vers);
         }
 
         // use ilStyleDefinition instead of account to get the current skin and style
         require_once("./Services/Style/System/classes/class.ilStyleDefinition.php");
         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 . $vers;
         } else {
             return "templates/default/delos_cont.css" . $vers;
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getP3PLocation()

static ilUtil::getP3PLocation ( )

static

Get p3p file path.

(Not in use yet, see class.ilTemplate.php->show())

public

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

References $base, $i, and ILIAS_MODULE.

     {
         if (defined("ILIAS_MODULE")) {
             $base = '';
             for ($i = 0;$i < count(explode('/', ILIAS_MODULE));$i++) {
                 $base .= "../Services/Privacy/";
             }
         } else {
             $base = "./Services/Privacy/";
         }
 
         if (is_file($base . "w3c/p3p.xml")) {
             return ILIAS_HTTP_PATH . "w3c/p3p.xml";
         } else {
             return ILIAS_HTTP_PATH . "/w3c/p3p_template.xml";
         }
     }

◆ getPasswordRequirementsInfo()

static ilUtil::getPasswordRequirementsInfo ( )

static

infotext for ilPasswordInputGUI setInfo()

<type> $lng

Returns: <string> info about allowed chars for password

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

References $DIC, $lng, and ilSecuritySettings\_getInstance().

Referenced by ilUserProfile\addStandardFieldsToForm(), ilPasswordAssistanceGUI\getAssignPasswordForm(), ilObjUserGUI\getValues(), ilPersonalSettingsGUI\initPasswordForm(), and ilPDNewsBlockGUI\initPrivateSettingsForm().

     {
         global $DIC;
 
         $lng = $DIC->language();
 
         include_once('./Services/PrivacySecurity/classes/class.ilSecuritySettings.php');
         $security = ilSecuritySettings::_getInstance();
         
         $infos = array(sprintf($lng->txt('password_allow_chars'), self::getPasswordValidChars(false)));
                 
         // check if password to short
         if ($security->getPasswordMinLength() > 0) {
             $infos[] = sprintf($lng->txt('password_to_short'), $security->getPasswordMinLength());
         }
         
         // check if password not to long
         if ($security->getPasswordMaxLength() > 0) {
             $infos[] = sprintf($lng->txt('password_to_long'), $security->getPasswordMaxLength());
         }
 
         // if password must contains Chars and Numbers
         if ($security->isPasswordCharsAndNumbersEnabled()) {
             $infos[] = $lng->txt('password_must_chars_and_numbers');
         }
 
         // if password must contains Special-Chars
         if ($security->isPasswordSpecialCharsEnabled()) {
             $infos[] = $lng->txt('password_must_special_chars');
         }
 
         if ($security->getPasswordNumberOfUppercaseChars() > 0) {
             $infos[] = sprintf($lng->txt('password_must_contain_ucase_chars'), $security->getPasswordNumberOfUppercaseChars());
         }
 
         if ($security->getPasswordNumberOfLowercaseChars() > 0) {
             $infos[] = sprintf($lng->txt('password_must_contain_lcase_chars'), $security->getPasswordNumberOfLowercaseChars());
         }
 
         return implode('<br />', $infos);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getPasswordValidChars()

static ilUtil::getPasswordValidChars	(	$a_as_regex = `true`,
		$a_only_special_chars = `false`
	)

static

All valid chars for password.

Parameters

bool	$a_as_regex
bool	$a_only_special_chars

Returns: string

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

     {
         if ($a_as_regex) {
             if ($a_only_special_chars) {
                 return '/[_\.\+\?\#\-\*\@!\$\%\~\/\:\;]+/';
             } else {
                 return '/^[A-Za-z0-9_\.\+\?\#\-\*\@!\$\%\~\/\:\;]+$/';
             }
         } else {
             return 'A-Z a-z 0-9 _.+?#-*@!$%~/:;';
         }
     }

◆ getSafeFilename()

static ilUtil::getSafeFilename ( $a_initial_filename )

static

Parameters

string $a_initial_filename

Returns: mixed|string

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

Referenced by ilExAssignment\instructionFileInsertOrder().

     {
         $file_peaces = explode('.', $a_initial_filename);
 
         $file_extension = array_pop($file_peaces);
 
         if (SUFFIX_REPL_ADDITIONAL) {
             $string_extensions = SUFFIX_REPL_DEFAULT . "," . SUFFIX_REPL_ADDITIONAL;
         } else {
             $string_extensions = SUFFIX_REPL_DEFAULT;
         }
 
         $sufixes = explode(",", $string_extensions);
 
         if (in_array($file_extension, $sufixes)) {
             $file_extension = "sec";
         }
 
         array_push($file_peaces, $file_extension);
 
         $safe_filename = "";
         foreach ($file_peaces as $piece) {
             $safe_filename .= "$piece";
             if ($piece != end($file_peaces)) {
                 $safe_filename .= ".";
             }
         }
 
         return $safe_filename;
     }

Here is the caller graph for this function:

◆ getSecureTags()

static ilUtil::getSecureTags ( )

static

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

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

     {
         return array("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:

◆ getSelectName()

static ilUtil::getSelectName	(	$selected,
		$values
	)

static

???

public

Parameters

string
string

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

References $values.

     {
         return($values[$selected]);
     }

◆ getStyleSheetLocation()

static ilUtil::getStyleSheetLocation	(	$mode = `"output"`,
		$a_css_name = `""`,
		$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 public

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

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

Referenced by ilExport\_generateIndexFile(), ilTinyMCE\addRTESupport(), ilCharSelectorGUI\addToPage(), ilTinyMCE\addUserTextEditor(), ilSCORMPresentationGUI\contentSelect(), ilObjTest\deliverPDFfromHTML(), ilTestEvaluationGUI\detailedEvaluation(), ilPageObjectGUI\displayMedia(), ilPCDataTableGUI\editData(), ilSCORMOfflineModeGUI\executeCommand(), ilObjSurveyGUI\executeCommand(), ilObjQuestionPoolGUI\executeCommand(), ilObjSurveyQuestionPoolGUI\executeCommand(), ilPersonalDesktopGUI\executeCommand(), ilSAHSPresentationGUI\explorer(), ilSCORMPresentationGUI\explorer(), ilObjContentObjectGUI\explorer(), ilSystemStyleHTMLExport\export(), ilForumExportGUI\exportHTML(), ilObjGlossary\exportHTML(), ilObjContentObject\exportHTML(), ilSAHSPresentationGUI\finishSahs(), ilSCORMPresentationGUI\finishSahs(), ilKioskPageRenderer\getCSSFiles(), ilObjTest\getCustomStyles(), ilAttendanceList\getFullscreenHTML(), ilExplorer\getOutput(), ilSCORM13Player\getPlayer(), assMatchingQuestionGUI\getPreview(), ilSCORMOfflineMode\getSopManifestEntries(), ilPlugin\getStyleSheetLocation(), assMatchingQuestionGUI\getTestOutput(), ilObjTest\getTestStyleLocation(), ilLMPresentationGUI\glossary(), ilLMPresentationGUI\ilMedia(), ilFileUploadGUI\initFileUpload(), ilInitialisation\initHTML(), ilInitialisation\initILIAS(), ilPreviewGUI\initPreview(), ilLMPresentationGUI\initScreenHead(), ilLMPresentationGUI\layout(), ilGlossaryPresentationGUI\media(), ilTestServiceGUI\outCorrectSolution(), ilTestPlayerAbstractGUI\outCorrectSolution(), ilTestEvaluationGUI\outEvaluation(), ilTestEvaluationGUI\outParticipantsPassDetails(), ilTestEvaluationGUI\outParticipantsResultsOverview(), ilTestEvaluationGUI\outUserListOfAnswerPasses(), ilTestEvaluationGUI\outUserPassDetails(), ilTestEvaluationGUI\outUserResultsOverview(), ilObjTestGUI\printobject(), ilForumExportGUI\printPost(), ilForumExportGUI\printThread(), ilObjPortfolioGUI\printView(), ilPortfolioPageGUI\renderConsultationHours(), ilObjTestGUI\reviewobject(), ilSCORM2004ScoGUI\sco_preview(), LTI\ilMainMenuGUI\setTemplateVars(), ilMainMenuGUI\setTemplateVars(), ilContainerLinkListGUI\show(), ilFramesetGUI\show(), ilCalendarPresentationGUI\show(), ilStartUpGUI\showClientList(), ilLMPresentationGUI\showDownloadList(), ilInternalLinkGUI\showLinkHelp(), ilContainerGUI\showLinkListObject(), ilTestPlayerAbstractGUI\showListOfAnswers(), ilObjMediaPoolGUI\showMedia(), ilPageObjectGUI\showMediaFullscreen(), ilObjMediaPoolGUI\showPage(), ilPageObjectGUI\showPage(), ilLMPresentationGUI\showPrintViewSelection(), ilTestPlayerAbstractGUI\showSideList(), ilLMPresentationGUI\showTableOfContents(), ilRepositoryGUI\showTree(), ilObjSCORM2004LearningModuleGUI\showTree(), ilParticipantsTestResultsGUI\showUserResults(), ilSCORM13Player\specialPage(), ilSAHSPresentationGUI\unloadSahs(), ilSCORMPresentationGUI\unloadSahs(), ilSAHSPresentationGUI\view(), and ilSCORMPresentationGUI\view().

     {
         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
         require_once("./Services/Style/System/classes/class.ilStyleDefinition.php");
         $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
         require_once("./Services/Style/System/classes/class.ilStyleDefinition.php");
         if (ilStyleDefinition::getCurrentSkin() != "default") {
             $filename = "./Customizing/global/skin/" . ilStyleDefinition::getCurrentSkin() . "/" . $a_css_location . $stylesheet_name;
         }
         if (strlen($filename) == 0 || !file_exists($filename)) {
             $filename = "./" . $a_css_location . "templates/default/" . $stylesheet_name;
         }
         $vers = "";
         if ($mode != "filesystem") {
             $vers = str_replace(" ", "-", $ilSetting->get("ilias_version"));
             $vers = "?vers=" . str_replace(".", "-", $vers);
             // use version from template xml to force reload on changes
             $skin = ilStyleDefinition::getSkins()[ilStyleDefinition::getCurrentSkin()];
             $vers .= ($skin->getVersion() != '' ? str_replace(".", "-", '-' . $skin->getVersion()) : '');
         }
         return $filename . $vers;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getTypeIconPath()

static ilUtil::getTypeIconPath	(	$a_type,
		$a_obj_id,
		$a_size = `'small'`
	)

static

Get type icon path path Return image path for icon_xxx.pngs Or (if enabled) path to custom icon Deprecated, use ilObject::_getIcon instead.

Parameters

string	$a_type	obj_type
int	$a_obj_id	obj_id
string	$a_size	size 'tiny','small' or 'big'

Returns: string path

Deprecated:

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

References $a_type.

Referenced by ilCourseContentGUI\__renderItem(), ilCourseContentGUI\__renderUserItem(), ilAdministrationCommandGUI\delete(), ilSCTreeDuplicatesTableGUI\fillObjectRow(), ilObjectCopyProgressTableGUI\fillRow(), ilECSImportedContentTableGUI\fillRow(), ilObjectTableGUI\fillRow(), ilPathGUI\getHTML(), ilLPObjectStatisticsTypesTableGUI\getItems(), ilTrMatrixTableGUI\getSelectableColumns(), ilLPListOfSettingsGUI\handleLPUsageInfo(), ilCourseObjectivesGUI\initFormLimits(), ilPortfolioPageGUI\renderMyCourses(), and ilTestLearningObjectivesStatusGUI\renderStatus().

     {
         include_once("./Services/Object/classes/class.ilObject.php");
         return ilObject::_getIcon($a_obj_id, $a_size, $a_type);
     }

Here is the caller graph for this function:

◆ getUploadSizeLimitBytes()

static ilUtil::getUploadSizeLimitBytes ( )

static

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

     {
         $uploadSizeLimitBytes = min(
             self::convertPhpIniSizeValueToBytes(ini_get('post_max_size')),
             self::convertPhpIniSizeValueToBytes(ini_get('upload_max_filesize'))
         );
         
         return $uploadSizeLimitBytes;
     }

◆ getUsersOnline()

static ilUtil::getUsersOnline ( $a_user_id = 0 )

static

reads all active sessions from db and returns users that are online OR returns only one active user if a user_id is given

Parameters

integer user_id (optional)

Returns: array

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

     {
         include_once("./Services/User/classes/class.ilObjUser.php");
         return ilObjUser::_getUsersOnline($a_user_id);
     }

◆ getWebspaceDir()

static ilUtil::getWebspaceDir ( $mode = "filesystem" )

static

get webspace directory

Parameters

string $mode use "filesystem" for filesystem operations and "output" for output operations, e.g. images

Returns: string

Deprecated:: in favour of the filesystem service which should be used for operations on the web dir.

See also: ::filesystem(); Filesystems::web()

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

Referenced by ilMathJax\__construct(), ilObjStyleSheet\_createImagesDirectory(), ilObjMediaObject\_createThumbnailDirectory(), ilObjFileBasedLMAccess\_determineStartUrl(), ilContainer\_getContainerDirectory(), ilObjMediaObject\_getDirectory(), ilObjStyleSheet\_getImagesDirectory(), ilChatroomAdminSmileyGUI\_getSmileyDir(), ilChatroomSmilies\_getSmileyDir(), ilObjMediaObject\_getThumbnailDirectory(), ilObjMediaObject\_getURL(), ilObjFileBasedLMAccess\_lookupDiskUsage(), ilObjSAHSLearningModuleAccess\_lookupDiskUsage(), ilPCTableGUI\_renderTable(), ilObjUser\_uploadPersonalPicture(), ilTestPlayerAbstractGUI\archiveParticipantSubmission(), ilObjMediaObjectGUI\assignFullscreenObject(), ilObjMediaObjectGUI\assignStandardObject(), ilTestSubmissionReviewGUI\buildPdfFilename(), ilContObjParser\copyMobFiles(), ilObjUser\copyProfilePicturesToDirectory(), ilContainer\createContainerDirectory(), ilObjSAHSLearningModule\createDataDirectory(), ilObjMediaObjectGUI\createDirectoryObject(), ilObjectTileImage\createFromImportDir(), ilObjectCustomIconImpl\createFromImportDir(), ilObjStyleSheet\delete(), ilObjMediaObjectGUI\deleteFileObject(), ilPublicUserProfileGUI\deliverVCard(), ilPageObjectGUI\displayMedia(), ilObjMediaObjectGUI\editFilesObject(), ilObjMediaObjectGUI\executeCommand(), ilObjMediaObject\exportFiles(), ilObjContentObject\exportHTML(), ilCOPageHTMLExport\exportHTMLMOB(), ilObjGlossary\exportHTMLMOB(), ilObjContentObject\exportHTMLMOB(), ilStudyProgrammeTypeTableGUI\fillRow(), ilBadgeHandler\getBasePath(), ilObjStyleSheet\getContentStylePath(), ilObjFileBasedLM\getDataDirectory(), ilObjSAHSLearningModule\getDataDirectory(), ilObjMediaObject\getDataDirectory(), ilPublicUserProfileGUI\getEmbeddable(), ilScormAiccDataSet\getExtendedXmlRepresentation(), ilObjectTileImage\getFullPath(), ilObjectCustomIconImpl\getFullPath(), ilOrgUnitType\getIconPath(), ilOpenIdConnectSettings\getImageFilePath(), ilImageMapEditorGUI\getImageMapOutput(), ilSCORMOfflineMode\getLmManifestEntries(), ilFileDataCourse\getOnlineLink(), ilFSStorageCourse\getOnlineLink(), ilObjUser\getPersonalPicturePath(), ilUserXMLWriter\getPictureValue(), ilFSStorageMail\getRelativePathExMailDirectory(), ilChatroomSmilies\getSmiliesBasePath(), ilLMPresentationGUI\ilMedia(), ilScormAiccImporter\importXmlRepresentation(), ilFileSystemStorage5069\init(), ilFileSystemStorage\init(), ilStudyProgrammeTypeCustomIconsFormGUI\initForm(), ilUserCertificateGUI\listCertificates(), ilGlossaryPresentationGUI\media(), ilObjUser\removeUserPicture(), ilObjUserGUI\removeUserPictureObject(), ilObjMediaPoolGUI\showMedia(), ilPageObjectGUI\showMediaFullscreen(), ilPageObjectGUI\showPage(), ilLMPresentationGUI\showPrintView(), ilObjMediaObjectGUI\uploadFileObject(), ilObjSAHSLearningModuleGUI\uploadObject(), ilPersonalProfileGUI\uploadUserPicture(), ilObjUserGUI\uploadUserPictureObject(), ilObjStyleSheet\writeCSSFile(), and ilObjSAHSLearningModule\zipLmForOfflineMode().

     {
         if ($mode == "filesystem") {
             return "./" . ILIAS_WEB_DIR . "/" . CLIENT_ID;
         } else {
             if (defined("ILIAS_MODULE")) {
                 return "../" . ILIAS_WEB_DIR . "/" . CLIENT_ID;
             } else {
                 return "./" . ILIAS_WEB_DIR . "/" . CLIENT_ID;
             }
         }
     }

Here is the caller graph for this function:

◆ groupNameExists()

static ilUtil::groupNameExists	(	$a_group_name,
		$a_id = `0`
	)

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

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

Referenced by ilSoapGroupAdministration\groupExists().

     {
         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) ? " 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);
 
         if ($r->numRows()) {
             return true;
         } else {
             return false;
         }
     }

Here is the caller graph for this function:

◆ htmlencodePlainString()

static ilUtil::htmlencodePlainString	(	$a_str,
		$a_make_links_clickable,
		$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 2585 of file class.ilUtil.php.

References makeClickable().

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

     {
         $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 = array();
             $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:

◆ htmlentitiesOutsideHTMLTags()

static ilUtil::htmlentitiesOutsideHTMLTags ( $htmlText )

static

Encodes HTML entities outside of HTML tags.

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

References $i.

     {
         $matches = array();
         $sep = '###HTMLTAG###';
 
         preg_match_all("@<[^>]*>@", $htmlText, $matches);
         $tmp = preg_replace("@(<[^>]*>)@", $sep, $htmlText);
         $tmp = explode($sep, $tmp);
 
         for ($i = 0; $i < count($tmp); $i++) {
             $tmp[$i] = htmlentities($tmp[$i], ENT_COMPAT, "UTF-8");
         }
 
         $tmp = join($sep, $tmp);
 
         for ($i = 0; $i < count($matches[0]); $i++) {
             $tmp = preg_replace("@$sep@", $matches[0][$i], $tmp, 1);
         }
 
         return $tmp;
     }

◆ ilTempnam()

static ilUtil::ilTempnam ( $a_temp_path = null )

static

Returns a unique and non existing Path for e temporary file or directory.

Parameters

string $a_temp_path

Returns: string

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

References createDirectory(), and getDataDir().

Referenced by ilImagemapPreview\__construct(), ilTestExport\aggregatedResultsToExcel(), ilTestArchiveService\buildOverviewFilename(), ilVirusScanner\createBufferFile(), ilRestFileStorage\createFile(), ilAdvancedMDParser\createLocalRecord(), ilTestExportGUI\createTestArchiveExport(), ilCalendarCopyFilesToTempDirectoryJob\createUniqueTempDirectory(), ilExerciseManagementCollectFilesJob\createUniqueTempDirectory(), ilFileDataMail\deliverAttachmentsAsZip(), ilObjSurvey\deliverPDFfromFO(), ilObjTest\deliverPDFfromFO(), ilObjFolder\downloadFolder(), ilExSubmission\downloadMultipleFiles(), ilContainerGUI\downloadMultipleObjects(), ilPageLayoutAdministrationGUI\exportLayout(), ilTestExport\exportToExcel(), ilHtmlToPdfTransformerFactory\generateTempPath(), ilAbstractHtmlToPdfTransformer\getTempFileName(), ilPhantomJSRenderer\getTempFileName(), ilScorm2004DataSet\getXmlRecord(), ilUserDataSet\getXmlRecord(), ilCloudPluginUploadGUI\handleFileUpload(), ilFileXMLParser\handlerBeginTag(), ilFileXMLParser\handlerEndTag(), ilImport\importObject(), ilDidacticTemplateSettingsGUI\importTemplate(), ilAssFileUploadUploadsExporter\initFilenames(), ilExSubmission\processUploadedZipFile(), ilGhostscriptRenderer\renderImages(), ilUserImportParser\saveTempImage(), ilObjFileGUI\saveUnzip(), ilBookmarkAdministrationGUI\sendmail(), ilExAssignment\sendMultiFeedbackStructureFile(), ilExcel\sendToClient(), ilRestFileStorage\storeFileForRest(), unzip(), ilECSConnector\updateResource(), ilCalendarCategoryGUI\uploadAppointments(), ilObjFileGUI\uploadFiles(), ilObjLanguageExtGUI\uploadObject(), and ilExcel\writeToTmpFile().

     {
         if ($a_temp_path === null) {
             $temp_path = ilUtil::getDataDir() . "/temp";
         } else {
             $temp_path = $a_temp_path;
         }
 
         if (!is_dir($temp_path)) {
             ilUtil::createDirectory($temp_path);
         }
         $temp_name = $temp_path . "/" . uniqid("tmp");
 
         return $temp_name;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ img()

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

static

Build img tag.

Deprecated:

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

References $img.

Referenced by ilLearningProgressBaseGUI\__appendLPDetails(), ilLPObjectStatisticsLPTableGUI\__construct(), ilLMChapterImportForm\addNode(), ilDclRecordListTableGUI\buildData(), ilMailFolderGUI\confirmDeleteMails(), ilChatroomAdminSmileyGUI\deleteMultipleObject(), ilTable2GUI\fillHeader(), ilObjClipboardTableGUI\fillRow(), ilTrashTableGUI\fillRow(), ilPCIIMOverlaysTableGUI\fillRow(), ilLMPagesTableGUI\fillRow(), ilSkillLevelResourcesTableGUI\fillRow(), ilItemGroupItemsTableGUI\fillRow(), ilExportIDTableGUI\fillRow(), ilSearchResultTableGUI\fillRow(), ilSkillCatTableGUI\fillRow(), ilSkillAssignMaterialsTableGUI\fillRow(), ilListOfQuestionsTableGUI\fillRow(), ilSkillLevelTableGUI\fillRow(), ilAdminSubItemsTableGUI\fillRow(), ilTrUserObjectsPropsTableGUI\fillRow(), ilMediaPoolTableGUI\fillRow(), ilLPObjectStatisticsLPTableGUI\getDetailItems(), ilAdministrationGUI\getDropDown(), ilCloudPluginItemCreationListGUI\getGroupedListItems(), ilObjectListGUI\getHeaderAction(), ilDclMobRecordRepresentation\getHTML(), ilMainMenuSearchGUI\getHTML(), ilLMChapterImportForm\getHTML(), ilObjectAddNewItemGUI\getHTML(), ilTaggingGUI\getHTML(), ilTrSummaryTableGUI\getItems(), ilObjContentObjectGUI\getLayoutOption(), ilLTIViewGUI\getNavEntries(), ilNoteGUI\getNoteListHTML(), ilRepositoryGlobalScreenProvider\getStaticSubItems(), ilLearningProgressGUI\initCollectionManualForm(), ilLMPageObjectGUI\initEditLayoutForm(), ilOnScreenChatGUI\initializeFrontend(), ilPCResourcesGUI\insertResourcesIntoPageContent(), ilObjMediaPoolSubItemListGUI\parseImage(), ilSCORMTrackingItemsTableGUI\parseValue(), ilSCORM2004TrackingItemsTableGUI\parseValue(), ilLPTableBaseGUI\parseValue(), ilLPStatus\preloadListGUIData(), ilNestedListInputGUI\render(), ilExplorerBaseGUI\renderNode(), ilMainMenuGUI\setTemplateVars(), ilChatroomAdminSmileyGUI\showDeleteSmileyFormObject(), ilObjMediaCastGUI\showGallery(), and ilLearningProgressGUI\showtlt().

     {
         $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:

◆ includeMathjax()

ilUtil::includeMathjax ( $a_tpl = null )

Include Mathjax.

Deprecated:

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

References ilMathJax\getInstance().

     {
         include_once './Services/MathJax/classes/class.ilMathJax.php';
         ilMathJax::getInstance()->includeMathJax($a_tpl);
     }

Here is the call graph for this function:

◆ infoPanel()

static ilUtil::infoPanel ( $a_keep = true )

static

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

References $_SESSION, $DIC, $ilUser, $lng, $tpl, ilFrameTargetInfo\_getFrame(), and ilSession\clear().

Referenced by ilLearningProgressBaseGUI\__buildHeader(), ilObjRoleGUI\__prepareOutput(), ilObjLinkResourceGUI\__prepareOutput(), ilObjForumGUI\confirmDeleteThreadDraftsObject(), ilPDNewsGUI\displayHeader(), ilPDNotesGUI\displayHeader(), ilBookmarkAdministrationGUI\displayHeader(), ilPersonalDesktopGUI\getStandardTemplates(), ilPersonalDesktopGUI\prepareContentView(), ilSearchBaseGUI\prepareOutput(), ilObjectGUI\prepareOutput(), ilObjTestGUI\prepareSubGuiOutput(), and ilMailGUI\showHeader().

     {
         global $DIC;
 
         $tpl = $DIC["tpl"];
         $lng = $DIC->language();
         $ilUser = $DIC->user();
 
         if (!empty($_SESSION["infopanel"]) and is_array($_SESSION["infopanel"])) {
             $tpl->addBlockFile(
                 "INFOPANEL",
                 "infopanel",
                 "tpl.infopanel.html",
                 "Services/Utilities"
             );
             $tpl->setCurrentBlock("infopanel");
 
             if (!empty($_SESSION["infopanel"]["text"])) {
                 $link = "<a href=\"" . $_SESSION["infopanel"]["link"] . "\" target=\"" .
                     ilFrameTargetInfo::_getFrame("MainContent") .
                     "\">";
                 $link .= $lng->txt($_SESSION["infopanel"]["text"]);
                 $link .= "</a>";
             }
 
             // deactivated
             if (!empty($_SESSION["infopanel"]["img"])) {
                 $link .= "<td><a href=\"" . $_SESSION["infopanel"]["link"] . "\" target=\"" .
                     ilFrameTargetInfo::_getFrame("MainContent") .
                     "\">";
                 $link .= "<img src=\"" . "./templates/" . $ilUser->prefs["skin"] . "/images/" .
                     $_SESSION["infopanel"]["img"] . "\" border=\"0\" vspace=\"0\"/>";
                 $link .= "</a></td>";
             }
 
             $tpl->setVariable("INFO_ICONS", $link);
             $tpl->parseCurrentBlock();
         }
 
         //if (!$a_keep)
         //{
         ilSession::clear("infopanel");
         //}
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ insertInstIntoID()

static ilUtil::insertInstIntoID ( $a_value )

static

inserts installation id into ILIAS id

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

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

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

     {
         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:

◆ insertLatexImages()

static ilUtil::insertLatexImages	(	$a_text,
		$a_start = `'[tex]'`,
		$a_end = `'[/tex]'`
	)

static

replace [tex]...[/tex] tags with formula image code

Deprecated:

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

References ilMathJax\getInstance().

     {
         include_once './Services/MathJax/classes/class.ilMathJax.php';
         return ilMathJax::getInstance()->insertLatexImages($a_text, $a_start, $a_end);
     }

Here is the call graph for this function:

◆ is_email()

static ilUtil::is_email	(		$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

Author: Unknown mail@.nosp@m.phil.nosp@m.ipp-l.nosp@m.ouis.nosp@m..de (source: http://www.php.net/preg_match) public

Parameters

	string	email address
ilMailRfc822AddressParserFactory \| null	$mailAddressParserFactory

Returns: bool true if valid

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

References $parser, and ilMail\ILIAS_HOST.

Referenced by ilMailAutoCompleteProviderEmailFilter\accept(), ilSetup\checkClientContact(), ilEMailInputGUI\checkInput(), ilMimeMailNotification\initLanguage(), ilSurveyExecutionGUI\mailUserResults(), ilObjSurveyGUI\mailUserResultsObject(), ilPersonalProfileGUI\saveProfile(), ilObjSurvey\updateCode(), ilCalendarUserNotification\validate(), and ilObjCourse\validateInfoSettings().

     {
         if (null === $a_email || !is_string($a_email)) {
             return false;
         }
 
         if ($mailAddressParserFactory === null) {
             $mailAddressParserFactory = new ilMailRfc822AddressParserFactory();
         }
 
         try {
             $parser = $mailAddressParserFactory->getParser((string) $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:

◆ isAPICall()

static ilUtil::isAPICall ( )

static

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

References $_SERVER.

Referenced by ilRepositoryGUI\__construct(), and ilAdministrationGUI\__construct().

     {
         return  strpos($_SERVER["SCRIPT_FILENAME"], "api") !== false ||
         strpos($_SERVER["SCRIPT_FILENAME"], "dummy") !== false;
     }

Here is the caller graph for this function:

◆ isConvertVersionAtLeast()

static ilUtil::isConvertVersionAtLeast ( $a_version )

static

Compare convert version numbers.

Parameters

string $a_version w.x.y-z

Returns: bool

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

References $version, and execQuoted().

Referenced by ilObjMediaObject\generatePreviewPic(), ilPersonalProfileGUI\uploadUserPicture(), and ilObjUserGUI\uploadUserPictureObject().

     {
         $current_version = ilUtil::execQuoted(PATH_TO_CONVERT, "--version");
         $current_version = self::processConvertVersion($current_version[0]);
         $version = self::processConvertVersion($a_version);
         if ($current_version >= $version) {
             return true;
         }
         return false;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isDN()

static ilUtil::isDN ( $a_str )

static

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

Referenced by ilRadiusSettings\validateServers().

     {
         return(preg_match("/^[a-z]+([a-z0-9-]*[a-z0-9]+)?(\.([a-z]+([a-z0-9-]*[a-z0-9]+)?)+)*$/", $a_str));
     }

Here is the caller graph for this function:

◆ isHTML()

static ilUtil::isHTML ( $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 4217 of file class.ilUtil.php.

Referenced by assTextQuestion\getSolutionSubmit(), ilAssSelfAssessmentQuestionFormatter\handleLineBreaks(), and assQuestion\isHTML().

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

Here is the caller graph for this function:

◆ isIPv4()

static ilUtil::isIPv4 ( $a_str )

static

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

Referenced by ilRadiusSettings\validateServers().

     {
         return(preg_match("/^(\d{1,2}|1\d\d|2[0-4]\d|25[0-5])\.(\d{1,2}|1\d\d|2[0-4]\d|25[0-5])\." .
                           "(\d{1,2}|1\d\d|2[0-4]\d|25[0-5])\.(\d{1,2}|1\d\d|2[0-4]\d|25[0-5])$/", $a_str));
     }

Here is the caller graph for this function:

◆ isLogin()

static ilUtil::isLogin ( $a_login )

static

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

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

     {
         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:

◆ isPassword()

static ilUtil::isPassword	(		$a_passwd,
		&	$customError = `null`
	)

static

validates a password public

Parameters

string password

Returns: boolean true if valid

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

References $DIC, $errors, $lng, ilSecuritySettings\_getInstance(), and ilStr\strLen().

Referenced by ilPasswordInputGUI\checkInput(), and ilPersonalSettingsGUI\savePassword().

     {
         global $DIC;
 
         $lng = $DIC->language();
         
         include_once('./Services/PrivacySecurity/classes/class.ilSecuritySettings.php');
         $security = ilSecuritySettings::_getInstance();
 
         // check if password is empty
         if (empty($a_passwd)) {
             $customError = $lng->txt('password_empty');
             return false;
         }
         
         $isPassword = true;
         $errors = array();
         
         // check if password to short
         if ($security->getPasswordMinLength() > 0 && strlen($a_passwd) < $security->getPasswordMinLength()) {
             $errors[] = sprintf($lng->txt('password_to_short'), $security->getPasswordMinLength());
             $isPassword = false;
         }
         
         // check if password not to long
         // Hmmmmm, maybe we should discuss this limitation. In my opinion it is stupid to limit the password length ;-). There should only be a technical limitation (field size in database).
         if ($security->getPasswordMaxLength() > 0 && strlen($a_passwd) > $security->getPasswordMaxLength()) {
             $errors[] = sprintf($lng->txt('password_to_long'), $security->getPasswordMaxLength());
             $isPassword = false;
         }
 
         // if password must contains Chars and Numbers
         if ($security->isPasswordCharsAndNumbersEnabled()) {
             $hasCharsAndNumbers = true;
 
             // check password for existing chars
             if (!preg_match('/[A-Za-z]+/', $a_passwd)) {
                 $hasCharsAndNumbers = false;
             }
 
             // check password for existing numbers
             if (!preg_match('/[0-9]+/', $a_passwd)) {
                 $hasCharsAndNumbers = false;
             }
 
             if (!$hasCharsAndNumbers) {
                 $errors[] = $lng->txt('password_must_chars_and_numbers');
                 $isPassword = false;
             }
         }
 
         require_once 'Services/Utilities/classes/class.ilStr.php';
         if ($security->getPasswordNumberOfUppercaseChars() > 0) {
             if (ilStr::strLen($a_passwd) - ilStr::strLen(preg_replace('/[A-Z]/', '', $a_passwd)) < $security->getPasswordNumberOfUppercaseChars()) {
                 $errors[] = sprintf($lng->txt('password_must_contain_ucase_chars'), $security->getPasswordNumberOfUppercaseChars());
                 $isPassword = false;
             }
         }
 
         if ($security->getPasswordNumberOfLowercaseChars() > 0) {
             if (ilStr::strLen($a_passwd) - ilStr::strLen(preg_replace('/[a-z]/', '', $a_passwd)) < $security->getPasswordNumberOfLowercaseChars()) {
                 $errors[] = sprintf($lng->txt('password_must_contain_lcase_chars'), $security->getPasswordNumberOfLowercaseChars());
                 $isPassword = false;
             }
         }
 
         // if password must contains Special-Chars
         if ($security->isPasswordSpecialCharsEnabled()) {
             // check password for existing special-chars
             if (!preg_match(self::getPasswordValidChars(true, true), $a_passwd)) {
                 $errors[] = $lng->txt('password_must_special_chars');
                 $isPassword = false;
             }
         }
         
         // ensure password matches the positive list of chars/special-chars
         if (!preg_match(self::getPasswordValidChars(), $a_passwd)) {
             $errors[] = $lng->txt('password_contains_invalid_chars');
             $isPassword = false;
         }
         
         // build custom error message
         if (count($errors) == 1) {
             $customError = $errors[0];
         } elseif (count($errors) > 1) {
             $customError = $lng->txt('password_multiple_errors');
             $customError .= '<br />' . implode('<br />', $errors);
         }
 
         return $isPassword;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isPasswordValidForUserContext()

static ilUtil::isPasswordValidForUserContext	(		$clear_text_password,
			$user,
		&	$error_language_variable = `null`
	)

static

Parameters

string	$clear_text_password	The validated clear text password
ilObjUser \| string \| array	$user	Could be an instance of ilObjUser, the users' loginname as string, or an array containing the users' loginname and id
null \| string	$error_language_variable

Returns: bool

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

References $login, $user, and ilSecuritySettings\_getInstance().

Referenced by ilAccountRegistrationGUI\saveForm(), ilPersonalSettingsGUI\savePassword(), and ilPasswordAssistanceGUI\submitAssignPasswordForm().

     {
         include_once 'Services/PrivacySecurity/classes/class.ilSecuritySettings.php';
         $security = ilSecuritySettings::_getInstance();
 
         $login = null;
 
         if (is_string($user)) {
             $login = $user;
         } elseif (is_array($user)) {
             // Try to get loginname and user_id from array
             $login = $user['login'];
             $userId = $user['id'];
         } elseif ($user instanceof ilObjUser) {
             $login = $user->getLogin();
             $userId = $user->getId();
         }
 
         // The user context (user instance or id) can be used for further validation (e.g. compare a password with the users' password history, etc.) in future releases.
 
         if ($login && (int) $security->getPasswordMustNotContainLoginnameStatus() &&
             strpos(strtolower($clear_text_password), strtolower($login)) !== false
         ) {
             $error_language_variable = 'password_contains_parts_of_login_err';
             return false;
         }
 
         return true;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isWindows()

static ilUtil::isWindows ( )

static

check wether the current client system is a windows system

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

Referenced by ilPreviewRenderer\createPreviewImage(), ilGitInformation\detect(), ilSetupGUI\determineTools(), execQuoted(), ilSetupGUI\initBasicSettingsForm(), ilSetupGUI\saveBasicSettings(), and ilSetupGUI\updateBasicSettings().

     {
         if (strtolower(substr(php_uname(), 0, 3)) == "win") {
             return true;
         }
         return false;
     }

Here is the caller graph for this function:

◆ KT_replaceParam()

static ilUtil::KT_replaceParam	(	$qstring,
		$paramName,
		$paramValue
	)

static

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

Referenced by replaceUrlParameterString().

     {
         if (preg_match("/&" . $paramName . "=/", $qstring)) {
             return preg_replace("/&" . $paramName . "=[^&]+/", "&" . $paramName . "=" . urlencode($paramValue), $qstring);
         } else {
             return $qstring . "&" . $paramName . "=" . urlencode($paramValue);
         }
     }

Here is the caller graph for this function:

◆ Linkbar()

static ilUtil::Linkbar	(	$AScript,
		$AHits,
		$ALimit,
		$AOffset,
		$AParams = `array()`,
		$ALayout = `array()`,
		$prefix = `''`
	)

static

Linkbar Diese Funktion erzeugt einen typischen Navigationsbalken mit "Previous"- und "Next"-Links und den entsprechenden Seitenzahlen.

die komplette LinkBar wird zur?ckgegeben der Variablenname f?r den offset ist "offset"

Author: Sascha Hofmann shofm.nosp@m.ann@.nosp@m.datab.nosp@m.ay.d.nosp@m.e

public

Parameters

integer	Name der Skriptdatei (z.B. test.php)
integer	Anzahl der Elemente insgesamt
integer	Anzahl der Elemente pro Seite
integer	Das aktuelle erste Element in der Liste
array	Die zu ?bergebenen Parameter in der Form $AParams["Varname"] = "Varwert" (optional)
array	layout options (all optional) link => css name for -tag prev => value for 'previous page' (default: '<<') next => value for 'next page' (default: '>>')

Returns: array linkbar or false on error

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

References $i, $key, and PHPMailer\PHPMailer\$params.

Referenced by ilObjForumGUI\getForumObjects(), and ilTableGUI\render().

     {
         $LinkBar = "";
 
         $layout_link = "";
         $layout_prev = "&lt;&lt;";
         $layout_next = "&gt;&gt;";
 
         // layout options
         if ((is_array($ALayout) && (count($ALayout) > 0))) {
             if ($ALayout["link"]) {
                 $layout_link = " class=\"" . $ALayout["link"] . "\"";
             }
 
             if ($ALayout["prev"]) {
                 $layout_prev = $ALayout["prev"];
             }
 
             if ($ALayout["next"]) {
                 $layout_next = $ALayout["next"];
             }
         }
 
         // show links, if hits greater limit
         // or offset > 0 (can be > 0 due to former setting)
         if ($AHits > $ALimit || $AOffset > 0) {
             if (!empty($AParams)) {
                 foreach ($AParams as $key => $value) {
                     $params .= $key . "=" . $value . "&";
                 }
             }
             // if ($params) $params = substr($params,0,-1);
             if (strpos($AScript, '&')) {
                 $link = $AScript . "&" . $params . $prefix . "offset=";
             } else {
                 $link = $AScript . "?" . $params . $prefix . "offset=";
             }
 
             // ?bergehe "zurck"-link, wenn offset 0 ist.
             if ($AOffset >= 1) {
                 $prevoffset = $AOffset - $ALimit;
                 if ($prevoffset < 0) {
                     $prevoffset = 0;
                 }
                 $LinkBar .= "<a" . $layout_link . " href=\"" . $link . $prevoffset . "\">" . $layout_prev . "&nbsp;</a>";
             }
 
             // Ben?tigte Seitenzahl kalkulieren
             $pages = intval($AHits / $ALimit);
 
             // Wenn ein Rest bleibt, addiere eine Seite
             if (($AHits % $ALimit)) {
                 $pages++;
             }
 
             // Bei Offset = 0 keine Seitenzahlen anzeigen : DEAKTIVIERT
             //                  if ($AOffset != 0) {
 
             // ansonsten zeige Links zu den anderen Seiten an
             for ($i = 1 ;$i <= $pages ; $i++) {
                 $newoffset = $ALimit * ($i - 1);
 
                 if ($newoffset == $AOffset) {
                     $LinkBar .= "[" . $i . "] ";
                 } else {
                     $LinkBar .= '<a ' . $layout_link . ' href="' .
                         $link . $newoffset . '">[' . $i . ']</a> ';
                 }
             }
             //                  }
 
             // Checken, ob letze Seite erreicht ist
             // Wenn nicht, gebe einen "Weiter"-Link aus
             if (!(($AOffset / $ALimit) == ($pages - 1)) && ($pages != 1)) {
                 $newoffset = $AOffset + $ALimit;
                 $LinkBar .= "<a" . $layout_link . " href=\"" . $link . $newoffset . "\">&nbsp;" . $layout_next . "</a>";
             }
 
             return $LinkBar;
         } else {
             return false;
         }
     }

Here is the caller graph for this function:

◆ makeClickable()

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

static

makeClickable In Texten enthaltene URLs und Mail-Adressen klickbar machen

public

Parameters

string	$text,	Der Text
boolean	$detectGotoLinks	if true, internal goto-links will be retargeted to _self and text is replaced by title

Returns: string clickable link

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

References $parser, and $ret.

Referenced by ilPDMailGUI\__construct(), ilAppointmentPresentationGUI\addEventDescription(), ilExAssignmentGUI\addInstructions(), ilMimeMail\buildBodyParts(), ilAppointmentPresentationGroupGUI\collectPropertiesAndActions(), ilAppointmentPresentationCourseGUI\collectPropertiesAndActions(), ilCourseRegistrationGUI\fillInformations(), ilGroupRegistrationGUI\fillInformations(), ilPDNewsTableGUI\fillRow(), ilADTExternalLinkPresentationBridge\getHTML(), ilCalendarAppointmentPanelGUI\getHTML(), htmlencodePlainString(), ilObjCourseGUI\infoScreen(), ilObjSessionGUI\infoScreen(), ilObjGroupGUI\infoScreen(), ilNewsDefaultRendererGUI\makeClickable(), ilPDNewsTableGUI\makeClickable(), and ilNewsForContextBlockGUI\makeClickable().

     {
         // New code, uses MediaWiki Sanitizer
         $ret = $a_text;
 
         // www-URL ohne ://-Angabe
         $ret = preg_replace(
             "/(^|[\s]+)(www\.)([A-Za-z0-9#&=?.\/\-]+)/i",
             "$1http://$2$3",
             $ret
         );
 
         // ftp-URL ohne ://-Angabe
         $ret = preg_replace(
             "/(^|[\s]+)(ftp\.)([A-Za-z0-9#&=?.\/\-]+)/i",
             "$1ftp://$2$3",
             $ret
         );
 
         // E-Mail (this does not work as expected, users must add mailto: manually)
         //$ret = preg_replace("/(([a-z0-9_]|\-|\.)+@([^[\s]*)([A-Za-z0-9\-]))/i",
         //      "mailto:$1", $ret);
 
         // mask existing image tags
         $ret = str_replace('src="http://', '"***masked_im_start***', $ret);
         
         include_once("./Services/Utilities/classes/class.ilMWParserAdapter.php");
         $parser = new ilMWParserAdapter();
         $ret = $parser->replaceFreeExternalLinks($ret);
 
         // unmask existing image tags
         $ret = str_replace('"***masked_im_start***', 'src="http://', $ret);
 
         // Should be Safe
 
         if ($detectGotoLinks) {
             // replace target blank with self and text with object title.
             $regExp = "<a[^>]*href=\"(" . str_replace("/", "\/", ILIAS_HTTP_PATH) . "\/goto.php\?target=\w+_(\d+)[^\"]*)\"[^>]*>[^<]*<\/a>";
             //                  echo htmlentities($regExp);
             $ret = preg_replace_callback(
                 "/" . $regExp . "/i",
                 array("ilUtil", "replaceLinkProperties"),
                 $ret
             );
 
             // Static links
             $regExp = "<a[^>]*href=\"(" . str_replace("/", "\/", ILIAS_HTTP_PATH) . "\/goto_.*[a-z0-9]+_([0-9]+)\.html)\"[^>]*>[^<]*<\/a>";
             //                  echo htmlentities($regExp);
             $ret = preg_replace_callback(
                 "/" . $regExp . "/i",
                 array("ilUtil", "replaceLinkProperties"),
                 $ret
             );
         }
 
         return($ret);
     }

Here is the caller graph for this function:

◆ makeDateSelect()

static ilUtil::makeDateSelect	(	$prefix,
		$year = `""`,
		$month = `""`,
		$day = `""`,
		$startyear = `""`,
		$a_long_month = `true`,
		$a_further_options = `array()`,
		$emptyoption = `false`
	)

static

Creates a combination of HTML selects for date inputs.

Creates a combination of HTML selects for date inputs The select names are $prefix[y] for years, $prefix[m] for months and $prefix[d] for days.

public

Parameters

string	$prefix	Prefix of the select name
integer	$year	Default value for year select
integer	$month	Default value for month select
integer	$day	Default value for day select

Returns: string HTML select boxes

Author: Aresch Yavari ay@da.nosp@m.taba.nosp@m.y.de; Helmut Schottmüller hscho.nosp@m.ttm@.nosp@m.tzi.d.nosp@m.e

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

References $DIC, $i, $lng, and $name.

Referenced by ilCourseContentGUI\__renderItem(), ilRegistrationSettingsGUI\editRoleAccessLimitations(), and ilCourseContentGUI\editTimings().

     {
         global $DIC;
 
         $lng = $DIC->language();
 
         $disabled = '';
         if (isset($a_further_options['disabled']) and $a_further_options['disabled']) {
             $disabled = 'disabled="disabled" ';
         }
 
         $now = getdate();
         if (!$emptyoption) {
             if (!strlen($year)) {
                 $year = $now["year"];
             }
             if (!strlen($month)) {
                 $month = $now["mon"];
             }
             if (!strlen($day)) {
                 $day = $now["mday"];
             }
         }
 
         $year = (int) $year;
         $month = (int) $month;
         $day = (int) $day;
 
         // build day select
 
         $sel_day .= '<select class="form-control" ';
         if (isset($a_further_options['select_attributes'])) {
             foreach ($a_further_options['select_attributes'] as $name => $value) {
                 $sel_day .= ($name . '="' . $value . '" ');
             }
         }
         
         $sel_day .= $disabled . "name=\"" . $prefix . "[d]\" id=\"" . $prefix . "_d\">\n";
         
         if ($emptyoption) {
             $sel_day .= "<option value=\"0\">--</option>\n";
         }
         for ($i = 1; $i <= 31; $i++) {
             $sel_day .= "<option value=\"$i\">" . sprintf("%02d", $i) . "</option>\n";
         }
         $sel_day .= "</select>\n";
         $sel_day = preg_replace("/(value\=\"$day\")/", "$1 selected=\"selected\"", $sel_day);
 
         // build month select
         $sel_month = '<select class="form-control" ';
         if (isset($a_further_options['select_attributes'])) {
             foreach ($a_further_options['select_attributes'] as $name => $value) {
                 $sel_month .= ($name . '="' . $value . '" ');
             }
         }
         $sel_month .= $disabled . "name=\"" . $prefix . "[m]\" id=\"" . $prefix . "_m\">\n";
 
         if ($emptyoption) {
             $sel_month .= "<option value=\"0\">--</option>\n";
         }
         for ($i = 1; $i <= 12; $i++) {
             if ($a_long_month) {
                 $sel_month .= "<option value=\"$i\">" . $lng->txt("month_" . sprintf("%02d", $i) . "_long") . "</option>\n";
             } else {
                 $sel_month .= "<option value=\"$i\">" . $i . "</option>\n";
             }
         }
         $sel_month .= "</select>\n";
         $sel_month = preg_replace("/(value\=\"$month\")/", "$1 selected=\"selected\"", $sel_month);
 
         // build year select
         $sel_year = '<select class="form-control" ';
         if (isset($a_further_options['select_attributes'])) {
             foreach ($a_further_options['select_attributes'] as $name => $value) {
                 $sel_year .= ($name . '="' . $value . '" ');
             }
         }
         $sel_year .= $disabled . "name=\"" . $prefix . "[y]\" id=\"" . $prefix . "_y\">\n";
         if ((strlen($startyear) == 0) || ($startyear > $year)) {
             if (!$emptyoption || $year != 0) {
                 $startyear = $year - 5;
             }
         }
 
         if (($year + 5) < (date('Y', time()) + 5)) {
             $end_year = date('Y', time()) + 5;
         } else {
             $end_year = $year + 5;
         }
 
         if ($emptyoption) {
             $sel_year .= "<option value=\"0\">----</option>\n";
         }
         for ($i = $startyear; $i <= $end_year; $i++) {
             $sel_year .= "<option value=\"$i\">" . sprintf("%04d", $i) . "</option>\n";
         }
         $sel_year .= "</select>\n";
         $sel_year = preg_replace("/(value\=\"$year\")/", "$1 selected=\"selected\"", $sel_year);
 
         //$dateformat = $lng->text["lang_dateformat"];
         $dateformat = "d-m-Y";
         $dateformat = strtolower(preg_replace("/\W/", "", $dateformat));
         $dateformat = strtolower(preg_replace("/(\w)/", "%%$1", $dateformat));
         $dateformat = preg_replace("/%%d/", $sel_day, $dateformat);
         $dateformat = preg_replace("/%%m/", $sel_month, $dateformat);
         $dateformat = preg_replace("/%%y/", $sel_year, $dateformat);
         return $dateformat;
     }

Here is the caller graph for this function:

◆ makeDir()

static ilUtil::makeDir ( $a_dir )

static

creates a new directory and inherits all filesystem permissions of the parent directory You may pass only the name of your new directory or with the entire path or relative path information.

examples: a_dir = /tmp/test/your_dir a_dir = ../test/your_dir a_dir = your_dir (–> creates your_dir in current directory)

public

Parameters

string [path] + directory name

Returns: boolean

Deprecated:: in favour of Filesystem::createDir() located at the filesystem service.

See also: ::createDir()

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

References $path.

     {
         $a_dir = trim($a_dir);
 
         // remove trailing slash (bugfix for php 4.2.x)
         if (substr($a_dir, -1) == "/") {
             $a_dir = substr($a_dir, 0, -1);
         }
 
         // check if a_dir comes with a path
         if (!($path = substr($a_dir, 0, strrpos($a_dir, "/") - strlen($a_dir)))) {
             $path = ".";
         }
 
         // create directory with file permissions of parent directory
         umask(0000);
         return @mkdir($a_dir, fileperms($path));
     }

Here is the caller graph for this function:

◆ makeDirParents()

static ilUtil::makeDirParents ( $a_dir )

static

Create a new directory and all parent directories.

Creates a new directory and inherits all filesystem permissions of the parent directory If the parent directories doesn't exist, they will be created recursively. The directory name NEEDS TO BE an absolute path, because it seems that relative paths are not working with PHP's file_exists function.

Author: Helmut Schottmüller hscho.nosp@m.ttm@.nosp@m.tzi.d.nosp@m.e

Parameters

string $a_dir The directory name to be created public

Returns: bool

Deprecated:: in favour of Filesystem::createDir() located at the filesystem service.

See also: ::createDir()

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

References $key, and Monolog\Handler\error_log().

     {
         $dirs = array($a_dir);
         $a_dir = dirname($a_dir);
         $last_dirname = '';
 
         while ($last_dirname != $a_dir) {
             array_unshift($dirs, $a_dir);
             $last_dirname = $a_dir;
             $a_dir = dirname($a_dir);
         }
 
         // find the first existing dir
         $reverse_paths = array_reverse($dirs, true);
         $found_index = -1;
         foreach ($reverse_paths as $key => $value) {
             if ($found_index == -1) {
                 if (is_dir($value)) {
                     $found_index = $key;
                 }
             }
         }
 
         umask(0000);
         foreach ($dirs as $dirindex => $dir) {
             // starting with the longest existing path
             if ($dirindex >= $found_index) {
                 if (!file_exists($dir)) {
                     if (strcmp(substr($dir, strlen($dir) - 1, 1), "/") == 0) {
                         // on some systems there is an error when there is a slash
                         // at the end of a directory in mkdir, see Mantis #2554
                         $dir = substr($dir, 0, strlen($dir) - 1);
                     }
                     if (!mkdir($dir, $umask)) {
                         error_log("Can't make directory: $dir");
                         return false;
                     }
                 } elseif (!is_dir($dir)) {
                     error_log("$dir is not a directory");
                     return false;
                 } else {
                     // get umask of the last existing parent directory
                     $umask = fileperms($dir);
                 }
             }
         }
         return true;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ makeTimeSelect()

static ilUtil::makeTimeSelect	(	$prefix,
		$short = `true`,
		$hour = `""`,
		$minute = `""`,
		$second = `""`,
		$a_use_default = `true`,
		$a_further_options = `array()`
	)

static

Creates a combination of HTML selects for time inputs.

Creates a combination of HTML selects for time inputs. The select names are $prefix[h] for hours, $prefix[m] for minutes and $prefix[s] for seconds.

public

Parameters

string	$prefix	Prefix of the select name
boolean	$short	Set TRUE for a short time input (only hours and minutes). Default is TRUE
integer	$hour	Default hour value
integer	$minute	Default minute value
integer	$second	Default second value

Returns: string HTML select boxes

Author: Helmut Schottmüller hscho.nosp@m.ttm@.nosp@m.tzi.d.nosp@m.e

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

References $DIC, $format, $i, $ilUser, $lng, $name, and ilCalendarSettings\TIME_FORMAT_24.

Referenced by ilLPCollectionSettingsTableGUI\fillRow(), ilTypicalLearningTimeInputGUI\insert(), ilMDEditorGUI\listEducational(), and ilMDEditorGUI\listQuickEdit_scorm().

     {
         global $DIC;
 
         $lng = $DIC->language();
         $ilUser = $DIC->user();
 
         $minute_steps = 1;
         $disabled = '';
         if (count($a_further_options)) {
             if (isset($a_further_options['minute_steps'])) {
                 $minute_steps = $a_further_options['minute_steps'];
             }
             if (isset($a_further_options['disabled']) and $a_further_options['disabled']) {
                 $disabled = 'disabled="disabled" ';
             }
         }
 
         if ($a_use_default and !strlen("$hour$minute$second")) {
             $now = localtime();
             $hour = $now[2];
             $minute = $now[1];
             $second = $now[0];
         } else {
             $hour = (int) $hour;
             $minute = (int) $minute;
             $second = (int) $second;
         }
         // build hour select
         $sel_hour = '<select ';
         if (isset($a_further_options['select_attributes'])) {
             foreach ($a_further_options['select_attributes'] as $name => $value) {
                 $sel_hour .= $name . '=' . $value . ' ';
             }
         }
         $sel_hour .= " " . $disabled . "name=\"" . $prefix . "[h]\" id=\"" . $prefix . "_h\" class=\"form-control\">\n";
 
         $format = $ilUser->getTimeFormat();
         for ($i = 0; $i <= 23; $i++) {
             if ($format == ilCalendarSettings::TIME_FORMAT_24) {
                 $sel_hour .= "<option value=\"$i\">" . sprintf("%02d", $i) . "</option>\n";
             } else {
                 $sel_hour .= "<option value=\"$i\">" . date("ga", mktime($i, 0, 0)) . "</option>\n";
             }
         }
         $sel_hour .= "</select>\n";
         $sel_hour = preg_replace("/(value\=\"$hour\")/", "$1 selected=\"selected\"", $sel_hour);
 
         // build minutes select
         $sel_minute .= "<select " . $disabled . "name=\"" . $prefix . "[m]\" id=\"" . $prefix . "_m\" class=\"form-control\">\n";
 
         for ($i = 0; $i <= 59; $i = $i + $minute_steps) {
             $sel_minute .= "<option value=\"$i\">" . sprintf("%02d", $i) . "</option>\n";
         }
         $sel_minute .= "</select>\n";
         $sel_minute = preg_replace("/(value\=\"$minute\")/", "$1 selected=\"selected\"", $sel_minute);
 
         if (!$short) {
             // build seconds select
             $sel_second .= "<select " . $disabled . "name=\"" . $prefix . "[s]\" id=\"" . $prefix . "_s\" class=\"form-control\">\n";
 
             for ($i = 0; $i <= 59; $i++) {
                 $sel_second .= "<option value=\"$i\">" . sprintf("%02d", $i) . "</option>\n";
             }
             $sel_second .= "</select>\n";
             $sel_second = preg_replace("/(value\=\"$second\")/", "$1 selected=\"selected\"", $sel_second);
         }
         $timeformat = $lng->text["lang_timeformat"];
         if (strlen($timeformat) == 0) {
             $timeformat = "H:i:s";
         }
         $timeformat = strtolower(preg_replace("/\W/", "", $timeformat));
         $timeformat = preg_replace("/(\w)/", "%%$1", $timeformat);
         $timeformat = preg_replace("/%%h/", $sel_hour, $timeformat);
         $timeformat = preg_replace("/%%i/", $sel_minute, $timeformat);
         if ($short) {
             $timeformat = preg_replace("/%%s/", "", $timeformat);
         } else {
             $timeformat = preg_replace("/%%s/", $sel_second, $timeformat);
         }
         return $timeformat;
     }

Here is the caller graph for this function:

◆ maskAttributeTag()

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

static

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

References $DIC, $ilLog, and $tag.

Referenced by maskSecureTags().

     {
         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	(	$a_str,
		$allow_array
	)

static

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

References $t, maskAttributeTag(), and maskTag().

Referenced by secureString().

     {
         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, array(
                         array("param" => "align", "value" => "left"),
                         array("param" => "align", "value" => "center"),
                         array("param" => "align", "value" => "justify"),
                         array("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	(	$a_str,
		$t,
		$fix_param = `""`
	)

static

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

References $t.

Referenced by maskSecureTags().

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

Here is the caller graph for this function:

◆ MB2Bytes()

static ilUtil::MB2Bytes ( $a_value )

static

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

Referenced by ilObjRoleGUI\loadRoleProperties(), ilObjUserGUI\saveObject(), and ilObjUserGUI\updateObject().

     {
         return  ((int) $a_value) * pow(self::_getSizeMagnitude(), 2);
     }

Here is the caller graph for this function:

◆ mergesort()

static ilUtil::mergesort	(	&	$array,
			$cmp_function = `'strcmp'`
	)

static

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

Referenced by stableSortArray().

     {
         // Arrays of size < 2 require no action.
         if (count($array) < 2) {
             return;
         }
 
         // Split the array in half
         $halfway = count($array) / 2;
         $array1 = array_slice($array, 0, $halfway);
         $array2 = array_slice($array, $halfway);
 
         // Recurse to sort the two halves
         ilUtil::mergesort($array1, $cmp_function);
         ilUtil::mergesort($array2, $cmp_function);
 
         // If all of $array1 is <= all of $array2, just append them.
         if (call_user_func($cmp_function, end($array1), $array2[0]) < 1) {
             $array = array_merge($array1, $array2);
             return;
         }
 
         // Merge the two sorted arrays into a single sorted array
         $array = array();
         $ptr1 = $ptr2 = 0;
         while ($ptr1 < count($array1) && $ptr2 < count($array2)) {
             if (call_user_func($cmp_function, $array1[$ptr1], $array2[$ptr2]) < 1) {
                 $array[] = $array1[$ptr1++];
             } else {
                 $array[] = $array2[$ptr2++];
             }
         }
 
         // Merge the remainder
         while ($ptr1 < count($array1)) {
             $array[] = $array1[$ptr1++];
         }
         while ($ptr2 < count($array2)) {
             $array[] = $array2[$ptr2++];
         }
 
         return;
     }

Here is the caller graph for this function:

◆ now()

static ilUtil::now ( )

static

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

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

Referenced by ilChangeEvent\_catchupWriteEvents(), ilHistory\_copyEntriesForObject(), ilHistory\_createEntry(), ilLMPageObject\_getPresentationTitle(), ilObjSCORMTracking\_insertTrackData(), ilLMTracker\_isNodeVisible(), ilPageObject\_lookupActive(), ilObjUser\_setUserInactive(), ilObjUser\_toggleActiveStatusOfUsers(), ilWikiContributor\_writeStatus(), ilLikeData\addExpression(), ilBasicSkill\addLevel(), ilDBUpdateNewObjectType\addNewType(), ilDBUpdateNewObjectType\addRBACTemplate(), ilExSubmission\addResourceObject(), ilObjUser\assignData(), ilRepositoryObjectPlugin\beforeActivation(), ilBlogPosting\create(), ilNote\create(), ilNewsItem\create(), ilPageObject\createFromXML(), ilPageActivationDBRepository\get(), ilCalendarHeaderNavigationGUI\getHTML(), ilNewsItem\getLastNewsIdForContext(), ilWikiUserHTMLExport\getProcess(), ilLMPresentationGUI\getSuccessorPage(), ilBasicSkill\hasRecentSelfEvaluation(), ilLMPresentationGUI\ilLMNavigation(), ilLMPresentationGUI\ilPage(), ilObjSCORM2004LearningModule\importSuccess(), ilObjSCORMLearningModule\importSuccess(), ilPreviewRenderer\render(), ilBasicSkill\resetUserSkillLevelStatus(), ilObjForum\saveData(), ilUserProfilePromptDataGateway\saveLastUserPrompt(), ilExAssignmentMemberStatus\setFeedback(), ilExAssignmentMemberStatus\setMark(), ilExAssignmentMemberStatus\setSent(), ilExAssignmentMemberStatus\setStatus(), ilUserProfileIncompleteRequestTargetAdjustmentCase\shouldAdjustRequest(), ilObjSCORMTracking\store(), ilObjSCORMTracking\storeJsApiCmi(), ilLMTracker\trackLastPageAccess(), ilNote\update(), ilNewsItem\update(), ilPageObject\update(), ilPageObject\updateFromXML(), ilStudyProgrammeAssignment\updateLastChange(), ilStudyProgramme\updateLastChange(), ilStudyProgrammeProgress\updateLastChange(), ilExPeerReview\updatePeerReview(), ilExPeerReview\updatePeerReviewTimestamp(), ilExSubmission\updateTextSubmission(), ilExSubmission\updateTutorDownloadTime(), ilExSubmission\uploadFile(), ilPageObject\writeRenderedContent(), and ilBasicSkill\writeUserSkillLevelStatus().

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

Here is the caller graph for this function:

◆ parseImportId()

static ilUtil::parseImportId ( $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'.

Parameters

string il_id

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

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

     {
         $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 caller graph for this function:

◆ period2String()

static ilUtil::period2String	(	ilDateTime	$a_from,
			$a_to = `null`
	)

static

Return a string of time period.

Parameters

ilDateTime	$a_from
ilDateTime	$a_to

Returns: string

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

References $DIC, $from, $key, $lng, ilDateTime\get(), IL_CAL_DATETIME, and IL_CAL_UNIX.

Referenced by ilObjExerciseAccess\_lookupRemainingWorkingTimeString(), ilExcAssMemberState\getRemainingTimePresentation(), and ilExAssignmentGUI\getTimeString().

     {
         global $DIC;
 
         $lng = $DIC->language();
         
         if (!$a_to) {
             $a_to = new ilDateTime(time(), IL_CAL_UNIX);
         }
         
         $from = new DateTime($a_from->get(IL_CAL_DATETIME));
         $to = new DateTime($a_to->get(IL_CAL_DATETIME));
         $diff = $to->diff($from);
         
         $periods = array();
         $periods["years"] = $diff->format("%y");
         $periods["months"] = $diff->format("%m");
         $periods["days"] = $diff->format("%d");
         $periods["hours"] = $diff->format("%h");
         $periods["minutes"] = $diff->format("%i");
         $periods["seconds"] = $diff->format("%s");
 
         if (!array_sum($periods)) {
             return;
         }
 
         foreach ($periods as $key => $value) {
             if ($value) {
                 $segment_name = ($value > 1)
                     ? $key
                     : substr($key, 0, -1);
                 $array[] = $value . ' ' . $lng->txt($segment_name);
             }
         }
         
         $len = sizeof($array);
         if ($len > 3) {
             $array = array_slice($array, 0, (3 - $len));
         }
 
         return implode(', ', $array);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ prepareDBString()

static ilUtil::prepareDBString ( $a_str )

static

prepare a string for db writing (insert/update)

Parameters

string $a_str string

Returns: string escaped string

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

     {
         return addslashes($a_str);
     }

Here is the caller graph for this function:

◆ prepareFormOutput()

static ilUtil::prepareFormOutput	(	$a_str,
		$a_strip = `false`
	)

static

prepares string output for html forms public

Parameters

string
boolean	true: strip slashes, if magic_quotes is enabled use this if $a_str comes from $_GET or $_POST var, use false, if $a_str comes from database

Returns: string

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

References stripSlashes().

     {
         if ($a_strip) {
             $a_str = ilUtil::stripSlashes($a_str);
         }
         $a_str = htmlspecialchars($a_str);
         // Added replacement of curly brackets to prevent
         // problems with PEAR templates, because {xyz} will
         // be removed as unused template variable
         $a_str = str_replace("{", "&#123;", $a_str);
         $a_str = str_replace("}", "&#125;", $a_str);
         // needed for LaTeX conversion \\ in LaTeX is a line break
         // but without this replacement, php changes \\ to \
         $a_str = str_replace("\\", "&#92;", $a_str);
         return $a_str;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ prepareTextareaOutput()

static ilUtil::prepareTextareaOutput	(	$txt_output,
		$prepare_for_latex_output = `false`,
		$omitNl2BrWhenTextArea = `false`
	)

static

Prepares a string for a text area output where latex code may be in it If the text is HTML-free, CHR(13) will be converted to a line break.

Parameters

string $txt_output String which should be prepared for output public

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

References $result, and ilMathJax\getInstance().

Referenced by ilAssQuestionHintsTableGUI\fillRow(), SurveyQuestion\prepareTextareaOutput(), assQuestion\prepareTextareaOutput(), ilObjSurvey\prepareTextareaOutput(), ilObjTest\prepareTextareaOutput(), ilAssQuestionHintRequestGUI\showHintCmd(), and ilAssQuestionHintsGUI\showHintCmd().

     {
         $result = $txt_output;
         $is_html = self::isHTML($result);
 
         // removed: did not work with magic_quotes_gpc = On
         if (!$is_html) {
             if (!$omitNl2BrWhenTextArea) {
                 // if the string does not contain HTML code, replace the newlines with HTML line breaks
                 $result = preg_replace("/[\n]/", "<br />", $result);
             }
         } else {
             // patch for problems with the <pre> tags in tinyMCE
             if (preg_match_all("/(<pre>.*?<\/pre>)/ims", $result, $matches)) {
                 foreach ($matches[0] as $found) {
                     $replacement = "";
                     if (strpos("\n", $found) === false) {
                         $replacement = "\n";
                     }
                     $removed = preg_replace("/<br\s*?\/>/ims", $replacement, $found);
                     $result = str_replace($found, $removed, $result);
                 }
             }
         }
         
         // since server side mathjax rendering does include svg-xml structures that indeed have linebreaks,
         // do latex conversion AFTER replacing linebreaks with <br>. <svg> tag MUST NOT contain any <br> tags.
         if ($prepare_for_latex_output) {
             include_once './Services/MathJax/classes/class.ilMathJax.php';
             $result = ilMathJax::getInstance()->insertLatexImages($result, "<span class\=\"latex\">", "<\/span>");
             $result = ilMathJax::getInstance()->insertLatexImages($result, "\[tex\]", "\[\/tex\]");
         }
 
         if ($prepare_for_latex_output) {
             // replace special characters to prevent problems with the ILIAS template system
             // eg. if someone uses {1} as an answer, nothing will be shown without the replacement
             $result = str_replace("{", "&#123;", $result);
             $result = str_replace("}", "&#125;", $result);
             $result = str_replace("\\", "&#92;", $result);
         }
         
         return $result;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ printBacktrace()

static ilUtil::printBacktrace ( $a_limit = 0 )

static

printBacktrace

Parameters

int $a_limit limit nr of lines

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

References $t.

     {
         $bt = debug_backtrace();
         $cnt = 0;
         foreach ($bt as $t) {
             if ($cnt != 0 && ($a_limit == 0 || $cnt <= $a_limit)) {
                 echo "<br>" . $t["file"] . ", " . $t["function"] . " [" . $t["line"] . "]";
             }
             $cnt++;
         }
         echo "<br>";
     }

◆ processConvertVersion()

static ilUtil::processConvertVersion ( $a_version )

staticprotected

Parse convert version string, e.g.

6.3.8-3, into integer

Parameters

string $a_version w.x.y-z

Returns: int

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

References $version.

     {
         if (preg_match("/([0-9]+)\.([0-9]+)\.([0-9]+)([\.|\-]([0-9]+))?/", $a_version, $match)) {
             $version = str_pad($match[1], 2, 0, STR_PAD_LEFT) .
                 str_pad($match[2], 2, 0, STR_PAD_LEFT) .
                 str_pad($match[3], 2, 0, STR_PAD_LEFT) .
                 str_pad($match[5], 2, 0, STR_PAD_LEFT);
             return (int) $version;
         }
     }

◆ processCSVRow()

static& ilUtil::processCSVRow	(	&	$row,
			$quoteAll = `false`,
			$separator = `";"`,
			$outUTF8 = `false`,
			$compatibleWithMSExcel = `true`
	)

static

Convertes an array for CSV usage.

Processes an array as a CSV row and converts the array values to correct CSV values. The "converted" array is returned

Author: Helmut Schottmüller hscho.nosp@m.ttm@.nosp@m.gmx.d.nosp@m.e

Parameters

array	$row	The array containing the values for a CSV row
string	$quoteAll	Indicates to quote every value (=TRUE) or only values containing quotes and separators (=FALSE, default)
string	$separator	The value separator in the CSV row (used for quoting) (; = default)

Returns: array The converted array ready for CSV use public

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

References $row.

Referenced by ilObjUserFolder\createCSVExport(), and ilObjAssessmentFolderGUI\exportLogObject().

     {
         $resultarray = array();
         foreach ($row as $rowindex => $entry) {
             $surround = false;
             if ($quoteAll) {
                 $surround = true;
             }
             if (strpos($entry, "\"") !== false) {
                 $entry = str_replace("\"", "\"\"", $entry);
                 $surround = true;
             }
             if (strpos($entry, $separator) !== false) {
                 $surround = true;
             }
             if ($compatibleWithMSExcel) {
                 // replace all CR LF with LF (for Excel for Windows compatibility
                 $entry = str_replace(chr(13) . chr(10), chr(10), $entry);
             }
             if ($surround) {
                 if ($outUTF8) {
                     $resultarray[$rowindex] = "\"" . $entry . "\"";
                 } else {
                     $resultarray[$rowindex] = utf8_decode("\"" . $entry . "\"");
                 }
             } else {
                 if ($outUTF8) {
                     $resultarray[$rowindex] = $entry;
                 } else {
                     $resultarray[$rowindex] = utf8_decode($entry);
                 }
             }
         }
         return $resultarray;
     }

Here is the caller graph for this function:

◆ quoteArray()

static ilUtil::quoteArray ( $a_array )

static

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

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

References $DIC, and $ilDB.

Referenced by ilNestedSetXML\_deleteAllChildMetaData(), ilObjGroup\_isMember(), _sortIds(), ilCourseObjectiveResult\_updateObjectiveStatus(), ilTree\getChildsByTypeFilter(), ilObjGroup\getGroupMemberData(), ilLearningSequenceRoles\getLearningSequenceMemberData(), and ilMDConvert().

     {
         global $DIC;
 
         $ilDB = $DIC->database();
 
 
         if (!is_array($a_array) or !count($a_array)) {
             return array("''");
         }
 
         foreach ($a_array as $k => $item) {
             $a_array[$k] = $ilDB->quote($item);
         }
 
         return $a_array;
     }

Here is the caller graph for this function:

◆ randomhash()

static ilUtil::randomhash ( )

static

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

     {
         $random = new \ilRandom();
         return md5($random->int(1, 9999999) + str_replace(" ", "", (string) microtime()));
     }

◆ rangeDownload()

ilUtil::rangeDownload ( $file )

Send a file via range request, see http://mobiforge.com/design-development/content-delivery-mobile-devices alternatives could be.

http://www.php.net/manual/en/function.http-send-file.php
http://stackoverflow.com/questions/157318/resumable-downloads-when-using-php-to-send-the-file
https://gist.github.com/codler/3906826
...
Parameters

string $file filename

Deprecated:
use ilFileDelivery Class

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

References $_SERVER, $end, $size, $start, and exit.

     {
         $fp = @fopen($file, 'rb');
 
         $size = filesize($file); // File size
         $length = $size;           // Content length
         $start = 0;               // Start byte
         $end = $size - 1;       // End byte
         // Now that we've gotten so far without errors we send the accept range header
         /* At the moment we only support single ranges.
          * Multiple ranges requires some more work to ensure it works correctly
          * and comply with the spesifications: http://www.w3.org/Protocols/rfc2616/rfc2616-sec19.html#sec19.2
          *
          * Multirange support annouces itself with:
          * header('Accept-Ranges: bytes');
          *
          * Multirange content must be sent with multipart/byteranges mediatype,
          * (mediatype = mimetype)
          * as well as a boundry header to indicate the various chunks of data.
          */
         header("Accept-Ranges: 0-$length");
         // header('Accept-Ranges: bytes');
         // multipart/byteranges
         // http://www.w3.org/Protocols/rfc2616/rfc2616-sec19.html#sec19.2
         if (isset($_SERVER['HTTP_RANGE'])) {
             $c_start = $start;
             $c_end = $end;
             // Extract the range string
             list(, $range) = explode('=', $_SERVER['HTTP_RANGE'], 2);
             // Make sure the client hasn't sent us a multibyte range
             if (strpos($range, ',') !== false) {
 
                 // (?) Shoud this be issued here, or should the first
                 // range be used? Or should the header be ignored and
                 // we output the whole content?
                 header('HTTP/1.1 416 Requested Range Not Satisfiable');
                 header("Content-Range: bytes $start-$end/$size");
                 // (?) Echo some info to the client?
                 exit;
             }
             // If the range starts with an '-' we start from the beginning
             // If not, we forward the file pointer
             // And make sure to get the end byte if spesified
             if ($range == '-') {
 
                 // The n-number of the last bytes is requested
                 $c_start = $size - substr($range, 1);
             } else {
                 $range = explode('-', $range);
                 $c_start = $range[0];
                 $c_end = (isset($range[1]) && is_numeric($range[1])) ? $range[1] : $size;
             }
             /* Check the range and make sure it's treated according to the specs.
              * http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html
              */
             // End bytes can not be larger than $end.
             $c_end = ($c_end > $end) ? $end : $c_end;
             // Validate the requested range and return an error if it's not correct.
             if ($c_start > $c_end || $c_start > $size - 1 || $c_end >= $size) {
                 header('HTTP/1.1 416 Requested Range Not Satisfiable');
                 header("Content-Range: bytes $start-$end/$size");
                 // (?) Echo some info to the client?
                 exit;
             }
             $start = $c_start;
             $end = $c_end;
             $length = $end - $start + 1; // Calculate new content length
             fseek($fp, $start);
             header('HTTP/1.1 206 Partial Content');
         }
         // Notify the client the byte range we'll be outputting
         header("Content-Range: bytes $start-$end/$size");
         header("Content-Length: $length");
 
         // Start buffered download
         $buffer = 1024 * 8;
         while (!feof($fp) && ($p = ftell($fp)) <= $end) {
             if ($p + $buffer > $end) {
 
                 // In case we're only outputtin a chunk, make sure we don't
                 // read past the length
                 $buffer = $end - $p + 1;
             }
             set_time_limit(0); // Reset time limit for big files
             echo fread($fp, $buffer);
             flush(); // Free up memory. Otherwise large files will trigger PHP's memory limit.
         }
 
         fclose($fp);
     }

◆ rCopy()

static ilUtil::rCopy	(	$a_sdir,
		$a_tdir,
		$preserveTimeAttributes = `false`
	)

static

Copies content of a directory $a_sdir recursively to a directory $a_tdir.

Parameters

string	$a_sdir	source directory
string	$a_tdir	target directory
boolean	$preserveTimeAttributes	if true, ctime will be kept.

Returns: boolean TRUE for sucess, FALSE otherwise

Exceptions

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

References $sourceDir, and GuzzleHttp\Psr7\$stream.

Referenced by ilFileSystemStorage5069\_copyDirectory(), ilFileSystemStorage\_copyDirectory(), ilDataSet\addRecordsXml(), assSingleChoice\afterSyncWithOriginal(), assMatchingQuestion\afterSyncWithOriginal(), ilExAssignment\cloneAssignmentsOfExercise(), ilSetup\cloneFromSource(), ilContObjParser\copyFileItems(), ilObjStyleSheet\copyImagesToDir(), ilContObjParser\copyMobFiles(), ilPlayerUtil\copyPlayerFilesToTargetDirectory(), ilPreview\copyPreviews(), ilObjStyleSheet\create(), ilFSStorageCourse\createArchiveOnlineVersion(), ilObjectTileImage\createFromImportDir(), ilObjectCustomIconImpl\createFromImportDir(), ilFileDataCourse\createOnlineVersion(), ilSCORM13Package\dbImportSco(), ilBookingObject\doClone(), ilObjFile\doCloneObject(), ilObjMediaObject\duplicate(), ilObjFile\export(), ilObjStyleSheet\export(), ilObjMediaObject\exportFiles(), ilObjFileBasedLMGUI\exportHTML(), ilObjContentObject\exportHTML(), ilCOPageHTMLExport\exportHTMLMOB(), ilObjGlossary\exportHTMLMOB(), ilObjContentObject\exportHTMLMOB(), ilObjSCORM2004LearningModule\exportScorm(), ilStyleExporter\getXmlRepresentation(), ilObjStyleSheet\import(), ilHTMLLearningModuleDataSet\importRecord(), ilPortfolioDataSet\importRecord(), ilPollDataSet\importRecord(), ilBlogDataSet\importRecord(), ilMediaObjectDataSet\importRecord(), ilStyleDataSet\importRecord(), ilExerciseDataSet\importRecord(), ilStyleImporter\importXmlRepresentation(), ilObjFileBasedLM\populateByDirectoy(), ilObjSAHSLearningModule\populateByDirectoy(), and ilFileDataCourse\rCopy().

     {
         $sourceFS = LegacyPathHelper::deriveFilesystemFrom($a_sdir);
         $targetFS = LegacyPathHelper::deriveFilesystemFrom($a_tdir);
 
         $sourceDir = LegacyPathHelper::createRelativePath($a_sdir);
         $targetDir = LegacyPathHelper::createRelativePath($a_tdir);
 
         // check if arguments are directories
         if (!$sourceFS->hasDir($sourceDir)) {
             return false;
         }
 
         $sourceList = $sourceFS->listContents($sourceDir, true);
 
         foreach ($sourceList as $item) {
             if ($item->isDir()) {
                 continue;
             }
             try {
                 $itemPath = $targetDir . '/' . substr($item->getPath(), strlen($sourceDir));
                 $stream = $sourceFS->readStream($item->getPath());
                 $targetFS->writeStream($itemPath, $stream);
             } catch (\ILIAS\Filesystem\Exception\FileAlreadyExistsException $e) {
                 // Do nothing with that type of exception
             }
         }
 
         return true;
     }

Here is the caller graph for this function:

◆ readFile()

static ilUtil::readFile ( $a_file )

static

there are some known problems with the original readfile method, which sometimes truncates delivered files regardless of php.ini setting (see http://de.php.net/manual/en/function.readfile.php) use this method to avoid these problems.

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

     {
         $chunksize = 1 * (1024 * 1024); // how many bytes per chunk
         $buffer = '';
         $handle = fopen($a_file, 'rb');
         if ($handle === false) {
             return false;
         }
         while (!feof($handle)) {
             $buffer = fread($handle, $chunksize);
             print $buffer;
         }
         return fclose($handle);
     }

◆ redirect()

static ilUtil::redirect ( $a_script )

static

Parameters

$a_script

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

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

References $DIC.

     {
         global $DIC;
 
         if (!isset($DIC['ilCtrl']) || !$DIC['ilCtrl'] instanceof ilCtrl) {
             $ctrl = new ilCtrl();
         } else {
             $ctrl = $DIC->ctrl();
         }
         $ctrl->redirectToURL($a_script);
     }

Here is the caller graph for this function:

◆ removeItemFromDesktops()

static ilUtil::removeItemFromDesktops ( $a_id )

static

removes object from all user's desktops public

Parameters

integer ref_id

Returns: array user_ids of all affected users

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

References ilObjUser\_removeItemFromDesktops().

Referenced by ilObject\countReferences(), ilSoapCourseAdministration\deleteCourse(), ilSoapObjectAdministration\deleteObject(), and ilRepUtil\deleteObjects().

     {
         return ilObjUser::_removeItemFromDesktops($a_id);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ removeTrailingPathSeparators()

static ilUtil::removeTrailingPathSeparators ( $path )

static

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

References $path.

Referenced by SurveyQuestion\_getInternalLinkHref(), ilInitialisation\buildHTTPPath(), ilSoapFunctions\buildHTTPPath(), ilTestSubmissionReviewGUI\buildPdfFilename(), assQuestion\fixUnavailableSkinImageSources(), ilObjCertificateSettingsAccess\getBackgroundImagePathWeb(), ilObjCertificateSettings\getBackgroundImagePathWeb(), ilCertificate\getBackgroundImagePathWeb(), ilObjCertificateSettings\getBackgroundImageThumbPathWeb(), ilObjCertificateSettingsAccess\getBackgroundImageThumbPathWeb(), ilCertificate\getBackgroundImageThumbPathWeb(), ilPreview\getFilePathFormat(), assFileUpload\getFileUploadPathWeb(), assQuestion\getFlashPathWeb(), ilBaseViewGUI\getHttpPath(), SurveyQuestion\getImagePathWeb(), assQuestion\getImagePathWeb(), ilObjTest\getImagePathWeb(), assQuestion\getJavaPathWeb(), SurveyQuestion\getMaterialsPathWeb(), assFileUpload\getPreviewFileUploadPathWeb(), ilFSStorageMail\getRelativePathExMailDirectory(), assFlashQuestionGUI\getSolutionOutput(), assQuestion\getSuggestedSolutionPathWeb(), assFlashQuestionGUI\getTestOutput(), assJavaAppletGUI\getTestOutput(), ilFSStorageExc5242\init(), ilFileSystemStorage5069\init(), and ilFileSystemStorage\init().

     {
         $path = preg_replace("/[\/\\\]+$/", "", $path);
         return $path;
     }

Here is the caller graph for this function:

◆ renameExecutables()

static ilUtil::renameExecutables ( $a_dir )

static

Rename uploaded executables for security reasons.

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

References $def, and rRenameSuffix().

Referenced by ilPCInteractiveImageGUI\create(), ilObjMediaPoolGUI\createMediaFromUploadDir(), ilSCORM13Package\dbImportSco(), ilScorm2004DataSet\importRecord(), ilSCORM2004ScoGUI\importSave(), ilScormAiccImporter\importXmlRepresentation(), ilObjSCORMLearningModuleGUI\newModuleVersionUpload(), ilDclMobRecordFieldModel\parseValue(), ilObjFileBasedLM\populateByDirectoy(), ilObjSAHSLearningModule\populateByDirectoy(), ilObjSCORM2004LearningModuleGUI\preview(), ilObjMediaObject\renameExecutables(), ilFileSystemGUI\renameFile(), assQuestionGUI\suggestedsolution(), ilFileSystemGUI\unzipFile(), ilObjMediaCastGUI\updateMediaItem(), ilFileSystemGUI\uploadFile(), and ilObjSAHSLearningModuleGUI\uploadObject().

     {
         $def_arr = explode(",", SUFFIX_REPL_DEFAULT);
         foreach ($def_arr as $def) {
             ilUtil::rRenameSuffix($a_dir, trim($def), "sec");
         }
 
         $def_arr = explode(",", SUFFIX_REPL_ADDITIONAL);
         foreach ($def_arr as $def) {
             ilUtil::rRenameSuffix($a_dir, trim($def), "sec");
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ replaceLinkProperties()

static ilUtil::replaceLinkProperties ( $matches )

static

replaces target _blank with _self and the link text with the according object title.

Parameters

string $matches $matches[0] contains complete link $matches[1] contains href attribute $matches[2] contains id of goto link

Returns: link containg a _self target, same href and new text content

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

References $title, ilObject\_lookupObjId(), and ilObject\_lookupTitle().

     {
         $link = $matches[0];
         $ref_id = $matches[2];
 
         if ($ref_id > 0) {
             $obj_id = ilObject::_lookupObjId($ref_id);
             if ($obj_id > 0) {
                 $title = ilObject::_lookupTitle($obj_id);
                 $link = "<a href=" . $matches[1] . " target=\"_self\">" . $title . "</a>";
             }
         }
         return $link;
     }

Here is the call graph for this function:

◆ replaceUrlParameterString()

static ilUtil::replaceUrlParameterString	(	$url,
		$parametersArray
	)

static

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

References $url, and KT_replaceParam().

     {
         foreach ($parametersArray as $paramName => $paramValue) {
             $url = ilUtil::KT_replaceParam($url, $paramName, $paramValue);
         }
         return $url;
     }

Here is the call graph for this function:

◆ resizeImage()

static ilUtil::resizeImage	(	$a_from,
		$a_to,
		$a_width,
		$a_height,
		$a_constrain_prop = `false`
	)

static

resize image

Parameters

string	$a_from	source file
string	$a_to	target file
string	$a_width	target width
string	$a_height	target height

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

References $size, escapeShellArg(), and execConvert().

Referenced by ilObjMediaObject\_resizeImage(), and ilObjStyleSheet\uploadImage().

     {
         if ($a_constrain_prop) {
             $size = " -geometry " . $a_width . "x" . $a_height . " ";
         } else {
             $size = " -resize " . $a_width . "x" . $a_height . "! ";
         }
         $convert_cmd = ilUtil::escapeShellArg($a_from) . " " . $size . ilUtil::escapeShellArg($a_to);
 
         ilUtil::execConvert($convert_cmd);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ rRenameSuffix()

static ilUtil::rRenameSuffix	(	$a_dir,
		$a_old_suffix,
		$a_new_suffix
	)

static

Renames all files with certain suffix and gives them a new suffix.

This words recursively through a directory.

Parameters

string	$a_dir	directory
string	$a_old_suffix	old suffix
string	$a_new_suffix	new suffix

public

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

Referenced by ilObjMediaObject\renameExecutables(), and renameExecutables().

     {
         if ($a_dir == "/" || $a_dir == "" || is_int(strpos($a_dir, ".."))
             || trim($a_old_suffix) == "") {
             return false;
         }
 
         // check if argument is directory
         if (!@is_dir($a_dir)) {
             return false;
         }
 
         // read a_dir
         $dir = opendir($a_dir);
 
         while ($file = readdir($dir)) {
             if ($file != "." and
             $file != "..") {
                 // directories
                 if (@is_dir($a_dir . "/" . $file)) {
                     ilUtil::rRenameSuffix($a_dir . "/" . $file, $a_old_suffix, $a_new_suffix);
                 }
 
                 // files
                 if (@is_file($a_dir . "/" . $file)) {
                     // first check for files with trailing dot
                     if (strrpos($file, '.') == (strlen($file) - 1)) {
                         rename($a_dir . '/' . $file, substr($a_dir . '/' . $file, 0, -1));
                         $file = substr($file, 0, -1);
                     }
 
                     $path_info = pathinfo($a_dir . "/" . $file);
 
                     if (strtolower($path_info["extension"]) ==
                     strtolower($a_old_suffix)) {
                         $pos = strrpos($a_dir . "/" . $file, ".");
                         $new_name = substr($a_dir . "/" . $file, 0, $pos) . "." . $a_new_suffix;
                         rename($a_dir . "/" . $file, $new_name);
                     }
                 }
             }
         }
         return true;
     }

Here is the caller graph for this function:

◆ sanitateTargetPath()

static ilUtil::sanitateTargetPath ( $a_target )

staticprotected

Parameters

$a_target

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

References ILIAS\FileUpload\Location\CUSTOMIZING, ILIAS\FileUpload\Location\STORAGE, ILIAS\FileUpload\Location\TEMPORARY, and ILIAS\FileUpload\Location\WEB.

     {
         switch (true) {
             case strpos($a_target, ILIAS_WEB_DIR . '/' . CLIENT_ID) === 0:
             case strpos($a_target, './' . ILIAS_WEB_DIR . '/' . CLIENT_ID) === 0:
             case strpos($a_target, CLIENT_WEB_DIR) === 0:
                 $targetFilesystem = \ILIAS\FileUpload\Location::WEB;
                 break;
             case strpos($a_target, CLIENT_DATA_DIR . "/temp") === 0:
                 $targetFilesystem = \ILIAS\FileUpload\Location::TEMPORARY;
                 break;
             case strpos($a_target, CLIENT_DATA_DIR) === 0:
                 $targetFilesystem = \ILIAS\FileUpload\Location::STORAGE;
                 break;
             case strpos($a_target, ILIAS_ABSOLUTE_PATH . '/Customizing') === 0:
                 $targetFilesystem = \ILIAS\FileUpload\Location::CUSTOMIZING;
                 break;
             default:
                 throw new InvalidArgumentException("Can not move files to \"$a_target\" because path can not be mapped to web, storage or customizing location.");
         }
 
         $absTargetDir = dirname($a_target);
         $targetDir = LegacyPathHelper::createRelativePath($absTargetDir);
 
         return array( $targetFilesystem, $targetDir );
     }

◆ secureLink()

static ilUtil::secureLink ( $a_str )

static

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

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

     {
         $a_str = str_ireplace("javascript", "jvscrpt", $a_str);
         $a_str = str_ireplace(array("%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 ( $a_str )

static

Remove unsecure characters from a plain text string.

This function currently returns the string without doing any changes.

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

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

     {
         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	(	$a_str,
		$a_strip_html = `true`,
		$a_allow = `""`
	)

static

Remove unsecure tags.

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

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

Referenced by assKprimChoiceGUI\handleAnswerTextsSubmit(), ilUserDataSet\importRecord(), ilExternalFeedItem\secureString(), ilAssSelfAssessmentQuestionFormatter\stripHtmlExceptSelfAssessmentTags(), stripSlashes(), assSingleChoiceGUI\writeAnswerSpecificPostData(), and assMultipleChoiceGUI\writeAnswerSpecificPostData().

     {
         // check whether all allowed tags can be made secure
         $only_secure = true;
         $allow_tags = explode(">", $a_allow);
         $sec_tags = ilUtil::getSecureTags();
         $allow_array = 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 = 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 ( $url )

static

Prepare secure href attribute.

Parameters

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

References $url.

Referenced by ilTemplate\addILIASFooter(), ilBookmarkAdministrationTableGUI\fillRow(), ilGroupedListGUI\getHTML(), ilObjMediaObject\getXML(), ilExternalFeedItem\secureString(), and ilExternalFeedItem\setMagpieItem().

     {
         // 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 "";
         }
         $url = htmlspecialchars($url, ENT_QUOTES);
         return $url;
     }

Here is the caller graph for this function:

◆ sendFailure()

static ilUtil::sendFailure	(	$a_info = `""`,
		$a_keep = `false`
	)

static

Send Failure Message to Screen.

Parameters

string	message
boolean	if true message is kept in session

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

References $DIC, and $tpl.

     {
         global $DIC;
 
         if (isset($DIC["tpl"])) {
             $tpl = $DIC["tpl"];
             $tpl->setMessage("failure", $a_info, $a_keep);
         }
     }

Here is the caller graph for this function:

◆ sendInfo()

static ilUtil::sendInfo	(	$a_info = `""`,
		$a_keep = `false`
	)

static

Send Info Message to Screen.

Parameters

string	message
boolean	if true message is kept in session

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

References $DIC, and $tpl.

     {
         global $DIC;
 
         $tpl = $DIC["tpl"];
         $tpl->setMessage("info", $a_info, $a_keep);
     }

Here is the caller graph for this function:

◆ sendQuestion()

static ilUtil::sendQuestion	(	$a_info = `""`,
		$a_keep = `false`
	)

static

Send Question to Screen.

Parameters

string	message
boolean	if true message is kept in session

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

References $DIC, and $tpl.

Referenced by ilRegistrationGUI\addCommandButtons(), ilCourseObjectivesGUI\askDeleteObjective(), ilObjCourseGUI\askResetObject(), ilGlossaryTermGUI\confirmDefinitionDeletion(), ilSCORM2004ScoGUI\confirmDeleteExportFile(), ilObjSCORM2004LearningModuleGUI\confirmDeleteExportFile(), ilObjSurveyQuestionPoolGUI\confirmDeleteExportFileObject(), ilObjRoleGUI\confirmDeleteRoleObject(), ilObjSurveyGUI\confirmResetTemplateObject(), ilAdministrationCommandGUI\delete(), arGUI\delete(), ilSurveyPageGUI\deleteBlock(), ilSurveyPhrasesGUI\deletePhrase(), ilObjQuestionPoolGUI\deleteQuestionsObject(), ilSurveyParticipantsGUI\deleteSingleUserResultsObject(), ilFileVersionsGUI\deleteVersions(), ilDidacticTemplateSettingsGUI\exportTemplate(), ilSystemStyleDeleteGUI\getDeleteStyleFormHTML(), ilConfirmationGUI\getHTML(), ilObjCourseGUI\redirectLocToTestConfirmation(), ilSurveyEditorGUI\removeQuestionsObject(), ilObjBookingPoolGUI\rsvConfirmCancelAggregationObject(), and ilObjGroupGUI\updateObject().

     {
         global $DIC;
 
         $tpl = $DIC["tpl"];
         $tpl->setMessage("question", $a_info, $a_keep);
     }

Here is the caller graph for this function:

◆ setCookie()

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

static

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

References $_COOKIE, $expire, and IL_COOKIE_PATH.

Referenced by ilStartUpGUI\_checkGoto(), ilInitialisation\determineClient(), ilInitialisation\initClientIniFile(), ilLTIViewGUI\logout(), ilSessionControl\removeSessionCookie(), ilStartUpGUI\showLogin(), and ilStartUpGUI\showLogout().

     {
         /*
         if(!(bool)$a_set_cookie_invalid) $expire = IL_COOKIE_EXPIRE;
         else $expire = time() - (365*24*60*60);
         */
         // Temporary fix for feed.php
         if (!(bool) $a_set_cookie_invalid) {
             $expire = 0;
         } else {
             $expire = time() - (365 * 24 * 60 * 60);
         }
         /* We MUST NOT set the global constant here, because this affects the session_set_cookie_params() call as well
         if(!defined('IL_COOKIE_SECURE'))
         {
             define('IL_COOKIE_SECURE', false);
         }
         */
         $secure = false;
         if (defined('IL_COOKIE_SECURE')) {
             $secure = IL_COOKIE_SECURE;
         }
 
         setcookie(
             $a_cookie_name,
             $a_cookie_value,
             $expire,
             IL_COOKIE_PATH,
             IL_COOKIE_DOMAIN,
             $secure,
             IL_COOKIE_HTTPONLY
         );
                     
         if ((bool) $a_also_set_super_global) {
             $_COOKIE[$a_cookie_name] = $a_cookie_value;
         }
     }

Here is the caller graph for this function:

◆ setPathStr()

static ilUtil::setPathStr ( $a_path )

static

??? public

Parameters

string

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

     {
         if ("" != $a_path && "/" != substr($a_path, -1)) {
             $a_path .= "/";
             //$a_path = substr($a_path,1);
         }
 
         //return getcwd().$a_path;
         return $a_path;
     }

◆ shortenText()

static ilUtil::shortenText	(	$a_str,
		$a_len,
		$a_dots = `false`,
		$a_next_blank = `false`,
		$a_keep_extension = `false`
	)

static

shorten a string to given length.

Adds 3 dots at the end of string (optional) TODO: do not cut within words (->wordwrap function) public

Parameters

string	string to be shortened
integer	string length in chars
boolean	adding 3 dots (true) or not (false, default)
truncate	at first blank after $a_len characters

Returns: string shortended string

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

References ilStr\strLen(), ilStr\strPos(), and ilStr\subStr().

Referenced by ilObjSystemFolder\_getHeaderTitleDescription(), ilObject\_writeDescription(), ilExcel\addSheet(), ilObject\create(), ilObjSystemFolder\delete(), ilBookmarkAdministrationGUI\delete(), ilObjWikiGUI\editImportantPagesObject(), ilTree\fetchNodeData(), ilLDAPRoleMappingTableGUI\fillRow(), ilNewsForContextTableGUI\fillRow(), ilAssignmentsTableGUI\fillRow(), ilAdminSubItemsTableGUI\fillRow(), ilPresentationListTableGUI\fillRow(), ilTermListTableGUI\fillRow(), ilECSNodeMappingCmsExplorer\formatObject(), ilECSNodeMappingLocalExplorer\formatObject(), ilWorkspaceExplorer\formatObject(), ilPasteIntoMultipleItemsExplorer\formatObject(), ilExplorer\formatObject(), SurveyMatrixQuestionEvaluation\getChart(), ilContainer\getCompleteDescriptions(), ilObjLinkResourceListGUI\getDescription(), ilPDNotesBlockGUI\getListRowData(), ilLTIViewGUI\getNavEntries(), ilMailNotification\getObjectTitle(), ilCalendarEntry\getPresentationTitle(), ilRepositoryGlobalScreenProvider\getStaticSubItems(), ilLMPresentationGUI\ilLMNavigation(), ilLMPresentationGUI\ilLocator(), ilObjWikiGUI\initSettingsForm(), ilSCORMExplorer\insertObject(), ilWikiPageTemplateGUI\listTemplates(), ilChartDataSpider\parseGlobalOptions(), ilMembershipCronNotifications\parseNewsItem(), ilBenchmark\save(), ilObject\setDescription(), ilObject\setTitle(), and ilGlossaryDefinition\shortenShortText().

       {
         include_once("./Services/Utilities/classes/class.ilStr.php");
         if (ilStr::strLen($a_str) > $a_len) {
             if ($a_next_blank) {
                 $len = ilStr::strPos($a_str, " ", $a_len);
             } else {
                 $len = $a_len;
             }
             // BEGIN WebDAV
             //             - Shorten names in the middle, before the filename extension
             //             Workaround for Windows WebDAV Client:
             //             Use the unicode ellipsis symbol for shortening instead of
             //             three full stop characters.
             if ($a_keep_extension) {
                 $p = strrpos($a_str, '.');      // this messes up normal shortening, see bug #6190
             }
             if ($p === false || $p == 0 || strlen($a_str) - $p > $a_len) {
                 $a_str = ilStr::subStr($a_str, 0, $len);
                 if ($a_dots) {
                     $a_str .= "\xe2\x80\xa6"; // UTF-8 encoding for Unicode ellipsis character.
                 }
             } else {
                 if ($a_dots) {
                     $a_str = ilStr::subStr($a_str, 0, $len - (strlen($a_str) - $p + 1)) . "\xe2\x80\xa6" . substr($a_str, $p);
                 } else {
                     $a_str = ilStr::subStr($a_str, 0, $len - (strlen($a_str) - $p + 1)) . substr($a_str, $p);
                 }
             }
         }
 
         return $a_str;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ shortenWords()

static ilUtil::shortenWords	(	$a_str,
		$a_len = `30`,
		$a_dots = `true`
	)

static

Ensure that the maximum word lenght within a text is not longer than $a_len.

Parameters

string	$a_str	input string
integer	$a_len	max. word length
boolean	$a_dots	append "..." to shortened words

Returns: string

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

References $i, ilStr\strLen(), and ilStr\subStr().

Referenced by ilNewsForContextBlockGUI\fillRow(), and ilCalendarEntry\getPresentationTitle().

     {
         include_once("./Services/Utilities/classes/class.ilStr.php");
         $str_arr = explode(" ", $a_str);
         
         for ($i = 0; $i < count($str_arr); $i++) {
             if (ilStr::strLen($str_arr[$i]) > $a_len) {
                 $str_arr[$i] = ilStr::subStr($str_arr[$i], 0, $a_len);
                 if ($a_dots) {
                     $str_arr[$i] .= "...";
                 }
             }
         }
         return implode(' ', $str_arr);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ sort_func()

static ilUtil::sort_func	(	$a,
		$b
	)

static

sub-function to sort an array

Parameters

array	$a
array	$b

Returns: boolean true on success / false on error

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

References ilStr\strCmp(), and ilStr\strToUpper().

     {
         global $array_sortby,$array_sortorder;
 
         if (!isset($array_sortby)) {
             // occured in: setup -> new client -> install languages -> sorting of languages
             $array_sortby = 0;
         }
         
         // this comparison should give optimal results if
         // locale is provided and mb string functions are supported
         if ($array_sortorder == "asc") {
             return ilStr::strCmp($a[$array_sortby], $b[$array_sortby]);
         }
 
         if ($array_sortorder == "desc") {
             return !ilStr::strCmp($a[$array_sortby], $b[$array_sortby]);
             return strcoll(ilStr::strToUpper($b[$array_sortby]), ilStr::strToUpper($a[$array_sortby]));
         }
     }

Here is the call graph for this function:

◆ sort_func_numeric()

static ilUtil::sort_func_numeric	(	$a,
		$b
	)

static

sub-function to sort an array

Parameters

array	$a
array	$b

Returns: boolean true on success / false on error

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

     {
         global $array_sortby,$array_sortorder;
 
         if ($array_sortorder == "asc") {
             return $a["$array_sortby"] > $b["$array_sortby"];
         }
 
         if ($array_sortorder == "desc") {
             return $a["$array_sortby"] < $b["$array_sortby"];
         }
     }

◆ sortArray()

static ilUtil::sortArray	(	$array,
		$a_array_sortby,
		$a_array_sortorder = `0`,
		$a_numeric = `false`,
		$a_keep_keys = `false`
	)

static

sortArray

Parameters

array	array to sort
string	sort_column
string	sort_order (ASC or DESC)
bool	sort numeric?

Returns: array sorted array

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

Referenced by ilBenchmarkTableGUI\__construct(), ilTaxonomyTableGUI\__construct(), ilSkillCatTableGUI\__construct(), ilUserDefinedFields\__read(), ilContainerSessionsContentGUI\__showMaterials(), ilCourseObjectiveMaterials\_getAssignableMaterials(), ilExport\_getLastExportFileDate(), ilExport\_getLastExportFileInformation(), ilNewsItem\_getNewsItemsOfUser(), ilObjRole\_removeObjectId(), ilTemplate\addILIASFooter(), ilInfoScreenGUI\addPreconditions(), ilCalendarSchedule\calculate(), ilColumnGUI\determineBlocks(), ilLMTracker\determineProgressStatus(), ilObjTypeDefinitionGUI\editObject(), ilTable2GUI\exportData(), ilObjExercise\exportGradesExcel(), ilPollBlockGUI\fillRow(), ilClassificationBlockGUI\filterContainer(), ilTaxonomyNode\fixOrderNumbers(), ilExAssignmentTeam\getAdoptableTeamAssignments(), ilNewsItem\getAggregatedChildNewsData(), ilNewsItem\getAggregatedNewsData(), ilObjSurvey\getAllRelations(), ilItemGroupItems\getAssignableItems(), ilCalendarSelectionBlockGUI\getCalendars(), ilPersonalSkillExplorerGUI\getChildsOfNode(), ilModulesTableGUI\getComponents(), ilAwarenessData\getData(), ilBenchmarkTableGUI\getDataByFirstTable(), ilSessionMaterialsTableGUI\getDataFromDb(), ilLearningHistoryEntryCollector\getEntries(), ilLikeData\getExpressionEntries(), ilLikeData\getExpressionEntriesForObject(), ilFSWebStorageExercise\getFiles(), ilFSStorageExc5242\getFiles(), ilFSStorageExercise5069\getFiles(), ilFSStorageExercise\getFiles(), ilObjectDefinition\getGroupedRepositoryObjectTypes(), ilExAssignmentTeam\getGroupMembersMap(), ilNewItemGroupTableGUI\getGroups(), ilDclNReferenceFieldGUI\getHTML(), ilCalendarAgendaListGUI\getHTML(), ilTable2GUI\getHTML(), ilTestManScoringParticipantsTableGUI\getInternalyOrderedDataValues(), ilPCImageMapTableGUI\getItems(), ilUserRoleStartingPointTableGUI\getItems(), ilClipboardTableGUI\getItems(), ilPCIIMTriggerTableGUI\getItems(), ilObjBlogGUI\getKeywords(), ilObjAssessmentFolderGUI\getLogDataOutputForm(), ilItemGroupItemsTableGUI\getMaterials(), ilAwarenessData\getOnlineUserData(), ilCourseMembershipGUI\getPrintMemberData(), ilPageObject\getRecentChanges(), ilObjMediaCast\getSortedItemsArray(), ilObjCourse\getSubItems(), ilObjectDefinition\getSubObjects(), ilObjectDefinition\getSubObjectsRecursively(), ilTagging\getTagsForUser(), ilObjectActivation\getTimingsAdministrationItems(), ilObjUserTrackingGUI\initLPDefaultsForm(), ilPCQuestionGUI\insert(), ilObjectListGUI\insertPreconditions(), ilPCParagraph\linkTermsInDom(), ilBadgeProfileGUI\listBadges(), ilSCORMTrackingUsersTableGUI\parse(), ilLearningSequenceParticipantsTableGUI\parse(), ilGroupParticipantsTableGUI\parse(), ilCourseParticipantsTableGUI\parse(), ilObjectAddNewItemGUI\parsePersonalWorkspace(), ilObjectAddNewItemGUI\parseRepository(), ilTreeExplorerGUI\preloadChilds(), ilContentStyleSettings\read(), ilPortfolioPageGUI\renderMyCourses(), ilContainerContentGUI\renderPageEmbeddedBlocks(), ilSkillTreeNode\saveChildsOrder(), ilObjStyleSheet\saveMediaQueryOrder(), ilObjWiki\saveOrderingAndIndentation(), ilWikiPageGUI\searchWikiLinkAC(), ilExerciseManagementGUI\showParticipantObject(), ilLMPresentationGUI\showPrintView(), ilTableGUI\sortData(), ilContainerSorting\sortItems(), ilLinkResourceItems\sortItems(), ilExplorer\sortNodes(), ilContainerSorting\sortOrderDefault(), ilCourseObjectiveQuestionAssignmentTableGUI\sortQuestions(), ilContainerSorting\sortSubItems(), ilAdvancedMDSettingsGUI\updateSubstitutions(), and ilObjTypeDefinitionGUI\viewObject().

       {
         include_once("./Services/Utilities/classes/class.ilStr.php");
         
         // BEGIN WebDAV: Provide a 'stable' sort algorithm
         if (!$a_keep_keys) {
             return self::stableSortArray($array, $a_array_sortby, $a_array_sortorder, $a_numeric, $a_keep_keys);
         }
         // END WebDAV Provide a 'stable' sort algorithm
 
         global $array_sortby,$array_sortorder;
         $array_sortby = $a_array_sortby;
 
         if ($a_array_sortorder == "desc") {
             $array_sortorder = "desc";
         } else {
             $array_sortorder = "asc";
         }
         if ($a_numeric) {
             if ($a_keep_keys) {
                 uasort($array, array("ilUtil", "sort_func_numeric"));
             } else {
                 usort($array, array("ilUtil", "sort_func_numeric"));
             }
         } else {
             if ($a_keep_keys) {
                 uasort($array, array("ilUtil", "sort_func"));
             } else {
                 usort($array, array("ilUtil", "sort_func"));
             }
         }
         //usort($array,"ilUtil::sort_func");
 
         return $array;
     }

Here is the caller graph for this function:

◆ stableSortArray()

static ilUtil::stableSortArray	(	$array,
		$a_array_sortby,
		$a_array_sortorder = `0`,
		$a_numeric = `false`
	)

static

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

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

Parameters

array	array to sort
string	sort_column
string	sort_order (ASC or DESC)
bool	sort numeric?

Returns: array sorted array

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

References mergesort().

Referenced by ilLanguageTableGUI\getItems(), ilSCORMTrackingItemsTableGUI\getItems(), ilSCORM2004TrackingItemsTableGUI\getItems(), and ilTrQuery\getUserDataForObject().

     {
         global $array_sortby,$array_sortorder;
 
         $array_sortby = $a_array_sortby;
 
         if ($a_array_sortorder == "desc") {
             $array_sortorder = "desc";
         } else {
             $array_sortorder = "asc";
         }
 
         // Create a copy of the array values for sorting
         $sort_array = array_values($array);
 
         if ($a_numeric) {
             ilUtil::mergesort($sort_array, array("ilUtil", "sort_func_numeric"));
         } else {
             ilUtil::mergesort($sort_array, array("ilUtil", "sort_func"));
         }
 
         return $sort_array;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ stripOnlySlashes()

static ilUtil::stripOnlySlashes ( $a_str )

static

strip slashes if magic qoutes is enabled

Parameters

string string

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

Referenced by ilTextAreaInputGUI\checkInput(), assFormulaQuestionGUI\writePostData(), and assQuestionGUI\writeQuestionGenericPostData().

     {
         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	(	$a_str,
		$a_allow = `""`,
		$a_rm_js = `true`
	)

static

strip only html tags (4.0) from text $allowed contains tags to be allowed, in format tags a and b are allowed todo: needs to be optimized-> not very efficient

Parameters

string	$a_str	input string
string	$a_allow	allowed tags, if an empty string is passed a default set of tags is allowed
boolean	$a_rm_js	remove javascript attributes (onclick...)

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

Referenced by ilTemplate\fillHeader(), ilTemplate\fillWindowTitle(), secureString(), ilTemplate\setHeaderPageTitle(), ilTemplate\setTitle(), and ilFramesetGUI\show().

     {
         //$a_str = strip_tags($a_str, $a_allow);
 
         $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	(	$a_str,
		$a_strip_html = `true`,
		$a_allow = `""`
	)

static

strip slashes if magic qoutes is enabled

Parameters

boolean strip also html tags

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

References secureString().

     {
         if (ini_get("magic_quotes_gpc")) {
             $a_str = stripslashes($a_str);
         }
         //echo "<br><br>-".$a_strip_html."-".htmlentities($a_str);
         //echo "<br>-".htmlentities(ilUtil::secureString($a_str, $a_strip_html, $a_allow));
         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:

◆ stripSlashesArray()

static ilUtil::stripSlashesArray	(	$a_arr,
		$a_strip_html = `true`,
		$a_allow = `""`
	)

static

Strip slashes from array.

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

References stripSlashes().

Referenced by ilSkillTreeNodeGUI\copyItems(), ilStructureObjectGUI\copyItems(), ilSCORM2004NodeGUI\copyItems(), ilObjSCORM2004LearningModuleGUI\copyItems(), ilObjContentObjectGUI\copyItems(), ilObjContentObjectGUI\copyPage(), ilObjGlossaryGUI\copyTerms(), ilSkillTreeNodeGUI\cutItems(), ilStructureObjectGUI\cutItems(), ilSCORM2004NodeGUI\cutItems(), ilObjSCORM2004LearningModuleGUI\cutItems(), ilObjContentObjectGUI\cutItems(), ilObjContentObjectGUI\movePage(), ilObjGlossaryGUI\referenceTerms(), ilObjAccessibilitySettingsGUI\saveAccessKeys(), ilStructureObjectGUI\saveAllTitles(), ilObjContentObjectGUI\saveAllTitles(), ilPCGridGUI\saveCellData(), ilPCGridGUI\saveCells(), ilObjItemGroupGUI\saveItemAssignment(), ilPCInteractiveImageGUI\savePopups(), ilAdvancedMDRecordGUI\saveSelection(), ilPCTabsGUI\saveTabs(), ilBasicSkillGUI\updateLevelOrder(), ilExerciseManagementGUI\uploadMultiFeedbackObject(), ilMobMultiSrtUploadGUI\uploadMultipleSubtitleFile(), and ilObjMediaObjectGUI\uploadMultipleSubtitleFileObject().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ stripSlashesRecursive()

static ilUtil::stripSlashesRecursive	(	$a_data,
		$a_strip_html = `true`,
		$a_allow = `""`
	)

static

Strip slashes from array and sub-arrays.

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

References stripSlashes().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ switchColor()

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

static

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

public

Parameters

integer	$a_num	the counter
string	$a_css1	name of stylesheet 1
string	$a_css2	name of stylesheet 2

Returns: string $a_css1 or $a_css2

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

Referenced by ilCourseContentGUI\__renderItem(), ilCourseContentGUI\__renderUserItem(), ilObjCategoryGUI\_importCategoriesForm(), ilCourseObjectivesGUI\askDeleteObjective(), ilObjObjectFolderGUI\displayList(), ilObjTypeDefinitionGUI\displayList(), ilRegistrationSettingsGUI\editEmailAssignments(), ilObjMediaObjectGUI\editFilesObject(), ilObjTypeDefinitionGUI\editObject(), ilRegistrationSettingsGUI\editRoleAccessLimitations(), ilRegistrationSettingsGUI\editRoles(), ilCourseContentGUI\editTimings(), ilObjSessionGUI\eventsListObject(), ilObjUserFolderGUI\exportObject(), ilCourseObjectiveQuestionsTableGUI\fillRow(), ilTableGUI\render(), ilObjForumGUI\renderPostContent(), ilForumExportGUI\renderPostHtml(), ilSCORM2004ScoGUI\sahs_questions(), ilSCORM2004ScoGUI\sco_resources(), ilGlossaryPresentationGUI\showDownloadList(), ilStructureObjectGUI\subchap(), and ilObjFileAccessSettingsGUI\viewDiskQuotaReport().

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

Here is the caller graph for this function:

◆ tf2yn()

static ilUtil::tf2yn ( $a_tf )

static

convert true/false to "y"/"n"

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

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

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

Here is the caller graph for this function:

◆ unique_multi_array()

static ilUtil::unique_multi_array	(	$array,
		$sub_key
	)

static

Make a multi-dimensional array to have only DISTINCT values for a certain "column".

It's like using the DISTINCT parameter on a SELECT sql statement.

Parameters

array	your multi-dimensional array
string	'column' to filter

Returns: array filtered array

Author: Unknown tru@a.nosp@m.scri.nosp@m.bedat.nosp@m.a.co.nosp@m.m (found in PHP annotated manual)

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

References $key, and $target.

     {
         $target = array();
         $existing_sub_key_values = array();
 
         foreach ($array as $key => $sub_array) {
             if (!in_array($sub_array[$sub_key], $existing_sub_key_values)) {
                 $existing_sub_key_values[] = $sub_array[$sub_key];
                 $target[$key] = $sub_array;
             }
         }
 
         return $target;
     }

◆ unmaskAttributeTag()

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

static

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

References $DIC, $ilLog, $tag, and secureLink().

Referenced by unmaskSecureTags().

     {
         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	(	$a_str,
		$allow_array
	)

static

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

References $t, unmaskAttributeTag(), and unmaskTag().

Referenced by secureString().

     {
         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, array(
                         array("param" => "align", "value" => "left"),
                         array("param" => "align", "value" => "center"),
                         array("param" => "align", "value" => "justify"),
                         array("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	(	$a_str,
		$t,
		$fix_param = `""`
	)

static

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

References $t.

Referenced by unmaskSecureTags().

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

Here is the caller graph for this function:

◆ unserializeSession()

static ilUtil::unserializeSession ( $data )

static

Returns the unserialized ILIAS session data.

Parameters

array $data The serialized ILIAS session data from database

Returns: array

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

References $data, $i, and $result.

     {
         $vars = preg_split(
             '/([a-zA-Z_\x7f-\xff][a-zA-Z0-9_\x7f-\xff^|]*)\|/',
             $data,
             -1,
             PREG_SPLIT_NO_EMPTY | PREG_SPLIT_DELIM_CAPTURE
         );
 
         $result = array();
 
         for ($i = 0; $vars[$i]; $i++) {
             $result[$vars[$i++]] = unserialize($vars[$i]);
         }
 
         return $result;
     }

◆ unzip()

static ilUtil::unzip	(	$a_file,
		$overwrite = `false`,
		$a_flat = `false`
	)

static

unzip file

Parameters

string	$a_file	full path/filename
boolean	$overwrite	pass true to overwrite existing files

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

References $DIC, $f, $log, $name, $target, delDir(), escapeShellArg(), execQuoted(), ilTempnam(), makeDir(), and ilFileUtils\recursive_dirscan().

Referenced by ilObjCategoryGUI\_importCategories(), ilExportContainer\addSubitems(), ilExSubmission\downloadAllAssignmentFiles(), ilSurveyExporter\getXmlRepresentation(), ilSystemStyleSkinContainer\import(), ilObjStyleSheet\import(), ilObjContentObject\importFromZipFile(), ilImport\importObject(), ilObjSurveyQuestionPool\importObject(), ilObjSurvey\importObject(), ilScorm2004DataSet\importRecord(), ilSCORM2004ScoGUI\importSave(), ilObjUserFolderGUI\importUserRoleAssignmentObject(), ilScormAiccImporter\importXmlRepresentation(), ilObjSCORMLearningModuleGUI\newModuleVersionUpload(), ilObjSCORM2004LearningModuleGUI\preview(), ilFileUtils\processZipFile(), ilFileDataCourse\unpackImportFile(), ilCertificateUtilHelper\unzip(), ilFileDataImportMail\unzip(), ilFileSystemGUI\unzipFile(), ilExAssignment\uploadMultiFeedbackFile(), ilMobMultiSrtUpload\uploadMultipleSubtitleFile(), ilObjMediaObject\uploadMultipleSubtitleFile(), ilObjSAHSLearningModuleGUI\uploadObject(), ilObjQuestionPoolGUI\uploadQplObject(), and ilObjTestGUI\uploadTstObject().

     {
         global $DIC;
 
         $log = $DIC->logger()->root();
 
         if (!is_file($a_file)) {
             return;
         }
         
         // if flat, move file to temp directory first
         if ($a_flat) {
             $tmpdir = ilUtil::ilTempnam();
             ilUtil::makeDir($tmpdir);
             copy($a_file, $tmpdir . DIRECTORY_SEPARATOR . basename($a_file));
             $orig_file = $a_file;
             $a_file = $tmpdir . DIRECTORY_SEPARATOR . basename($a_file);
             $origpathinfo = pathinfo($orig_file);
         }
         
         $pathinfo = pathinfo($a_file);
         $dir = $pathinfo["dirname"];
         $file = $pathinfo["basename"];
 
         // unzip
         $cdir = getcwd();
         chdir($dir);
         $unzip = PATH_TO_UNZIP;
 
         // the following workaround has been removed due to bug
         // http://www.ilias.de/mantis/view.php?id=7578
         // since the workaround is quite old, it may not be necessary
         // anymore, alex 9 Oct 2012
         /*
                 // workaround for unzip problem (unzip of subdirectories fails, so
                 // we create the subdirectories ourselves first)
                 // get list
                 $unzipcmd = "-Z -1 ".ilUtil::escapeShellArg($file);
                 $arr = ilUtil::execQuoted($unzip, $unzipcmd);
                 $zdirs = array();
 
                 foreach($arr as $line)
                 {
                     if(is_int(strpos($line, "/")))
                     {
                         $zdir = substr($line, 0, strrpos($line, "/"));
                         $nr = substr_count($zdir, "/");
                         //echo $zdir." ".$nr."<br>";
                         while ($zdir != "")
                         {
                             $nr = substr_count($zdir, "/");
                             $zdirs[$zdir] = $nr;                                // collect directories
                             //echo $dir." ".$nr."<br>";
                             $zdir = substr($zdir, 0, strrpos($zdir, "/"));
                         }
                     }
                 }
 
                 asort($zdirs);
 
                 foreach($zdirs as $zdir => $nr)                         // create directories
                 {
                     ilUtil::createDirectory($zdir);
                 }
         */
 
         // real unzip
         if (!$overwrite) {
             $unzipcmd = ilUtil::escapeShellArg($file);
         } else {
             $unzipcmd = "-o " . ilUtil::escapeShellArg($file);
         }
         ilUtil::execQuoted($unzip, $unzipcmd);
 
         chdir($cdir);
 
         // remove all sym links
         clearstatcache();                       // prevent is_link from using cache
         $dir_realpath = realpath($dir);
         foreach (new RecursiveIteratorIterator(new RecursiveDirectoryIterator($dir)) as $name => $f) {
             if (is_link($name)) {
                 $target = readlink($name);
                 if (substr($target, 0, strlen($dir_realpath)) != $dir_realpath) {
                     unlink($name);
                     $log->info("Removed symlink " . $name);
                 }
             }
         }
 
         // if flat, get all files and move them to original directory
         if ($a_flat) {
             include_once("./Services/Utilities/classes/class.ilFileUtils.php");
             $filearray = array();
             ilFileUtils::recursive_dirscan($tmpdir, $filearray);
             if (is_array($filearray["file"])) {
                 foreach ($filearray["file"] as $k => $f) {
                     if (substr($f, 0, 1) != "." && $f != basename($orig_file)) {
                         copy($filearray["path"][$k] . $f, $origpathinfo["dirname"] . DIRECTORY_SEPARATOR . $f);
                     }
                 }
             }
             ilUtil::delDir($tmpdir);
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ virusHandling()

static ilUtil::virusHandling	(	$a_file,
		$a_orig_name = `""`,
		$a_clean = `true`
	)

static

scan file for viruses and clean files if possible

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

References $DIC, $lng, ilVirusScannerFactory\_getInstance(), ilFileUtils\getValidFilename(), and sendFailure().

     {
         global $DIC;
 
         $lng = $DIC->language();
 
         if (IL_VIRUS_SCANNER != "None") {
             require_once("./Services/VirusScanner/classes/class.ilVirusScannerFactory.php");
             $vs = ilVirusScannerFactory::_getInstance();
             if (($vs_txt = $vs->scanFile($a_file, $a_orig_name)) != "") {
                 if ($a_clean && (IL_VIRUS_CLEAN_COMMAND != "")) {
                     $clean_txt = $vs->cleanFile($a_file, $a_orig_name);
                     if ($vs->fileCleaned()) {
                         $vs_txt .= "<br />" . $lng->txt("cleaned_file") .
                             "<br />" . $clean_txt;
                         $vs_txt .= "<br />" . $lng->txt("repeat_scan");
                         if (($vs2_txt = $vs->scanFile($a_file, $a_orig_name)) != "") {
                             return array(false, nl2br($vs_txt) . "<br />" . $lng->txt("repeat_scan_failed") .
                                 "<br />" . nl2br($vs2_txt));
                         } else {
                             return array(true, nl2br($vs_txt) . "<br />" . $lng->txt("repeat_scan_succeded"));
                         }
                     } else {
                         return array(false, nl2br($vs_txt) . "<br />" . $lng->txt("cleaning_failed"));
                     }
                 } else {
                     return array(false, nl2br($vs_txt));
                 }
             }
         }
 
         return array(true,"");
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ yn2tf()

static ilUtil::yn2tf ( $a_yn )

static

convert "y"/"n" to true/false

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

Referenced by ilLMObject\_isPagePublic(), ilObjSAHSLearningModuleAccess\_lookupOfflineModeAvailable(), ilObjGlossaryAccess\_lookupOnline(), ilObjGlossary\_lookupOnline(), ilSCORM2004Tracking\_syncReadEvent(), ilChatUserActionProvider\acceptsMessages(), ilLMMenuItemsTableGUI\fillRow(), ilMailSearchCoursesMembersTableGUI\fillRow(), ilObjSAHSLearningModule\getAutoReview(), ilBuddySystemLinkButton\getHtml(), ilOnScreenChatMenuGUI\getMainMenuHTML(), ilObjUserGUI\getValues(), ilOnScreenChatAppEventListener\handleEvent(), ilContObjParser\handlerBeginTag(), ilLearningModuleDataSet\importRecord(), ilRbacReview\isProtected(), ilObjSAHSLearningModule\read(), ilObjGlossary\read(), ilObjContentObject\readProperties(), ilBuddySystemGUI\requestCommand(), ilObjSCORMLearningModuleGUI\saveProperties(), ilObjGlossaryGUI\saveProperties(), ilObjSCORM2004LearningModuleGUI\saveProperties(), ilPersonalChatSettingsFormGUI\showChatOptions(), ilSCORMOfflineMode\sop2il(), ilBuddySystemGUI\transitionAsyncCommand(), and ilObjSCORM2004LearningModule\updateSequencingSettings().

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

Here is the caller graph for this function:

◆ zip()

static ilUtil::zip	(	$a_dir,
		$a_file,
		$compress_content = `false`
	)

static

zips given directory/file into given zip.file

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

References $name, $source, escapeShellArg(), and execQuoted().

     {
         $cdir = getcwd();
 
         if ($compress_content) {
             $a_dir .= "/*";
             $pathinfo = pathinfo($a_dir);
             chdir($pathinfo["dirname"]);
         }
         
         $pathinfo = pathinfo($a_file);
         $dir = $pathinfo["dirname"];
         $file = $pathinfo["basename"];
 
         if (!$compress_content) {
             chdir($dir);
         }
 
         $zip = PATH_TO_ZIP;
         
         if (!$zip) {
             chdir($cdir);
             return false;
         }
 
         if (is_array($a_dir)) {
             $source = "";
             foreach ($a_dir as $dir) {
                 $name = basename($dir);
                 $source .= " " . ilUtil::escapeShellArg($name);
             }
         } else {
             $name = basename($a_dir);
             if (trim($name) != "*") {
                 $source = ilUtil::escapeShellArg($name);
             } else {
                 $source = $name;
             }
         }
 
         $zipcmd = "-r " . ilUtil::escapeShellArg($a_file) . " " . $source;
         ilUtil::execQuoted($zip, $zipcmd);
         chdir($cdir);
         return true;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ $db_supports_distinct_umlauts

ilUtil::$db_supports_distinct_umlauts

staticprotected

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

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

Services/Utilities/classes/class.ilUtil.php

Public Member Functions

Static Public Member Functions

Static Protected Member Functions

Static Protected Attributes

Detailed Description

Member Function Documentation

◆ __extractId()

◆ __extractRefId()

◆ _getHttpPath()

◆ _getObjectsByOperations()

◆ _getSizeMagnitude()

◆ _sanitizeFilemame()

◆ _sortIds()

◆ appendUrlParameterString()

◆ array_php2js()

◆ assembleParameterString()

◆ attribsToArray()

◆ buildLatexImages()

◆ Bytes2MB()

◆ checkFormEmpty()

◆ checkInput()

◆ convertImage()

◆ convertPhpIniSizeValueToBytes()

◆ createDirectory()

◆ CreateIsoFromFolder()

◆ date_mysql2time()

◆ dbSupportsDisctinctUmlauts()

◆ deducibleSize()

◆ delDir()

◆ deliverData()

◆ deliverFile()

◆ dirsize()

◆ dumpString()

◆ dumpVar()

◆ escapeShellArg()

◆ escapeShellCmd()

◆ excelTime()

◆ execConvert()

◆ execQuoted()

◆ extractParameterString()

◆ fmtFloat()

◆ formatBytes()

◆ formatSize()

◆ formCheckbox()

◆ formDisabledRadioButton()

◆ formInput()

◆ formRadioButton()

◆ formSelect()

◆ generatePasswords()

◆ getASCIIFilename()

◆ getClientIdByString()

◆ getConvertCmd()

◆ getDataDir()

◆ getDir()

◆ getFileSizeInfo()

◆ getGDSupportedImageType()

◆ getHtmlPath()

◆ getImagePath()

◆ getImageTagByType()

◆ getJavaPath()

◆ getJSLocation()

◆ getMemString()

◆ getMySQLTimestamp()

◆ getNewContentStyleSheetLocation()

◆ getP3PLocation()

◆ getPasswordRequirementsInfo()

◆ getPasswordValidChars()

◆ getSafeFilename()

◆ getSecureTags()

◆ getSelectName()

◆ getStyleSheetLocation()

◆ getTypeIconPath()

◆ getUploadSizeLimitBytes()

◆ getUsersOnline()

◆ getWebspaceDir()

◆ groupNameExists()

◆ htmlencodePlainString()

◆ htmlentitiesOutsideHTMLTags()

◆ ilTempnam()

◆ img()