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

Inheritance diagram for ilObjUserFolder:

Collaboration diagram for ilObjUserFolder:

Public Member Functions
	__construct (int $a_id, bool $a_call_by_reference=true)

	delete ()

	getExportFilename (string $a_mode=self::FILE_TYPE_EXCEL)

	getExportDirectory ()

	getExportFiles ()
	Get a list of the already exported files in the export directory. More...

	buildExportFile (string $a_mode=self::FILE_TYPE_EXCEL, ?array $user_data_filter=null, bool $use_temp_dir=false)
	build xml export file More...

Public Member Functions inherited from ilObject
	__construct (int $id=0, bool $reference=true)

	withReferences ()
	determines whether objects are referenced or not (got ref ids or not) More...

	processAutoRating ()

	read ()

	getId ()

	setId (int $id)

	setRefId (int $ref_id)

	getRefId ()

	getType ()

	setType (string $type)

	getPresentationTitle ()
	get presentation title Normally same as title Overwritten for sessions More...

	getTitle ()

	getUntranslatedTitle ()
	Get untranslated object title WebDAV needs to access the untranslated title of an object. More...

	setTitle (string $title)

	getDescription ()

	setDescription (string $desc)

	getLongDescription ()
	get object long description (stored in object_description) More...

	getImportId ()

	setImportId (string $import_id)

	setOfflineStatus (bool $status)

	getOfflineStatus ()

	supportsOfflineHandling ()

	getOwner ()

	getOwnerName ()
	get full name of object owner More...

	setOwner (int $usr_id)

	getCreateDate ()
	Get create date in YYYY-MM-DD HH-MM-SS format. More...

	getLastUpdateDate ()
	Get last update date in YYYY-MM-DD HH-MM-SS format. More...

	create ()
	note: title, description and type should be set when this function is called More...

	update ()

	MDUpdateListener (string $element)
	Metadata update listener. More...

	createMetaData ()

	updateMetaData ()

	deleteMetaData ()

	updateOwner ()
	update owner of object in db More...

	putInTree (int $parent_ref_id)
	maybe this method should be in tree object!? More...

	setPermissions (int $parent_ref_id)

	setParentRolePermissions (int $parent_ref_id)
	Initialize the permissions of parent roles (local roles of categories, global roles...) This method is overwritten in e.g. More...

	createReference ()
	creates reference for object More...

	countReferences ()

	delete ()
	delete object or referenced object (in the case of a referenced object, object data is only deleted if last reference is deleted) This function removes an object entirely from system!! More...

	initDefaultRoles ()
	init default roles settings Purpose of this function is to create a local role folder and local roles, that are needed depending on the object type. More...

	applyDidacticTemplate (int $tpl_id)

	getXMLZip ()

	getHTMLDirectory ()

	appendCopyInfo (int $target_id, int $copy_id)
	Prepend Copy info if object with same name exists in that container. More...

	cloneDependencies (int $target_id, int $copy_id)
	Clone object dependencies. More...

	cloneMetaData (ilObject $target_obj)
	Copy meta data. More...

	selfOrParentWithRatingEnabled ()

	getPossibleSubObjects (bool $filter=true)
	get all possible sub objects of this type the object can decide which types of sub objects are possible jut in time overwrite if the decision distinguish from standard model More...

Static Public Member Functions
static	getExportSettings ()

static	getProfileFields ()
	Get profile fields. More...

static	_writeNewAccountMail (string $a_lang, string $a_subject, string $a_sal_g, string $a_sal_f, string $a_sal_m, string $a_body)

static	_updateAccountMailAttachment (string $a_lang, string $a_tmp_name, string $a_name)
	Update account mail attachment. More...

static	_deleteAccountMailAttachment (string $a_lang)
	Delete account mail attachment. More...

static	_lookupNewAccountMail (string $a_lang)

static	_updateUserFolderAssignment (int $a_old_id, int $a_new_id)
	Update user folder assignment Typically called after deleting a category with local user accounts. More...

Static Public Member Functions inherited from ilObject
static	_lookupObjIdByImportId (string $import_id)
	Get (latest) object id for an import id. More...

static	_lookupImportId (int $obj_id)

static	_lookupOwnerName (int $owner_id)
	Lookup owner name for owner id. More...

static	_getIdForImportId (string $import_id)

static	_getAllReferences (int $id)
	get all reference ids for object ID More...

static	_lookupTitle (int $obj_id)

static	lookupOfflineStatus (int $obj_id)
	Lookup offline status using objectDataCache. More...

static	_lookupOwner (int $obj_id)
	Lookup owner user ID for object ID. More...

static	_getIdsForTitle (string $title, string $type='', bool $partial_match=false)

static	_lookupDescription (int $obj_id)

static	_lookupLastUpdate (int $obj_id, bool $formatted=false)

static	_getLastUpdateOfObjects (array $obj_ids)

static	_lookupObjId (int $ref_id)

static	_setDeletedDate (int $ref_id, int $deleted_by)

static	setDeletedDates (array $ref_ids, int $user_id)

static	_resetDeletedDate (int $ref_id)

static	_lookupDeletedDate (int $ref_id)

static	_writeTitle (int $obj_id, string $title)
	write title to db (static) More...

static	_writeDescription (int $obj_id, string $desc)
	write description to db (static) More...

static	_writeImportId (int $obj_id, string $import_id)
	write import id to db (static) More...

static	_lookupType (int $id, bool $reference=false)

static	_isInTrash (int $ref_id)

static	_hasUntrashedReference (int $obj_id)
	checks whether an object has at least one reference that is not in trash More...

static	_lookupObjectId (int $ref_id)

static	_getObjectsDataForType (string $type, bool $omit_trash=false)
	get all objects of a certain type More...

static	_exists (int $id, bool $reference=false, ?string $type=null)
	checks if an object exists in object_data More...

static	_getObjectsByType (string $obj_type="", int $owner=null)

static	_prepareCloneSelection (array $ref_ids, string $new_type, bool $show_path=true)
	Prepare copy wizard object selection. More...

static	_getIcon (int $obj_id=0, string $size="big", string $type="", bool $offline=false)
	Get icon for repository item. More...

static	collectDeletionDependencies (array &$deps, int $ref_id, int $obj_id, string $type, int $depth=0)
	Collect deletion dependencies. More...

static	getDeletionDependencies (int $obj_id)
	Get deletion dependencies. More...

static	getLongDescriptions (array $obj_ids)

static	getAllOwnedRepositoryObjects (int $user_id)

static	fixMissingTitles ($type, array &$obj_title_map)
	Try to fix missing object titles. More...

static	_lookupCreationDate (int $obj_id)

static	_getObjectTypeIdByTitle (string $type, \ilDBInterface $ilDB=null)

Data Fields
const	ORG_OP_EDIT_USER_ACCOUNTS = 'edit_user_accounts'

const	FILE_TYPE_EXCEL = 'userfolder_export_excel_x86'

const	FILE_TYPE_CSV = 'userfolder_export_csv'

const	FILE_TYPE_XML = 'userfolder_export_xml'

Data Fields inherited from ilObject
const	TITLE_LENGTH = 255

const	DESC_LENGTH = 128

const	LONG_DESC_LENGTH = 4000

const	TABLE_OBJECT_DATA = "object_data"

array	$objectList

string	$untranslatedTitle

Protected Member Functions
	escapeXML (string $value)

	createXMLExport (array $settings, array $data, string $filename)

	getUserDefinedExportFields ()
	Get all exportable user defined fields. More...

	createCSVExport (array $settings, array $data, string $filename)

	createExcelExport (array $settings, array $data, string $filename)

	createExportDirectory ()
	creates data directory for export files More...

Protected Member Functions inherited from ilObject
	doMDUpdateListener (string $a_element)

	beforeMDUpdateListener (string $a_element)

	doCreateMetaData ()

	beforeCreateMetaData ()

	doUpdateMetaData ()

	beforeUpdateMetaData ()

	doDeleteMetaData ()

	beforeDeleteMetaData ()

	handleAutoRating ()

	hasAutoRating ()

Additional Inherited Members
Protected Attributes inherited from ilObject
ilLogger	$obj_log

ILIAS	$ilias

ilObjectDefinition	$obj_definition

ilDBInterface	$db

ilLogger	$log

ilErrorHandling	$error

ilTree	$tree

ilAppEventHandler	$app_event_handler

ilRbacAdmin	$rbac_admin

ilRbacReview	$rbac_review

ilObjUser	$user

ilLanguage	$lng

int	$id

bool	$referenced

bool	$call_by_reference

int	$max_title = self::TITLE_LENGTH

int	$max_desc = self::DESC_LENGTH

bool	$add_dots = true

int	$ref_id = null

string	$type = ""

string	$title = ""

bool	$offline = false

string	$desc = ""

string	$long_desc = ""

int	$owner = 0

string	$create_date = ""

string	$last_update = ""

string	$import_id = ""

bool	$register = false

Detailed Description

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

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

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning Class ilObjUserFolder

Author: Stefan Meyer meyer.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

Definition at line 24 of file class.ilObjUserFolder.php.

Constructor & Destructor Documentation

◆ __construct()

ilObjUserFolder::__construct	(	int	$a_id,
		bool	$a_call_by_reference = `true`
	)

Definition at line 31 of file class.ilObjUserFolder.php.

References ILIAS\GlobalScreen\Provider\__construct().

       {
         $this->type = "usrf";
         parent::__construct($a_id, $a_call_by_reference);
     }

Here is the call graph for this function:

Member Function Documentation

◆ _deleteAccountMailAttachment()

static ilObjUserFolder::_deleteAccountMailAttachment ( string $a_lang )

static

Delete account mail attachment.

Definition at line 550 of file class.ilObjUserFolder.php.

References $DIC, $ilDB, $path, and USER_FOLDER_ID.

Referenced by ilObjUserFolderGUI\saveNewAccountMailObject().

      : void {
         global $DIC;
 
         $ilDB = $DIC['ilDB'];
 
         $fs = new ilFSStorageUserFolder(USER_FOLDER_ID);
         $path = $fs->getAbsolutePath() . "/";
 
         if (file_exists($path . $a_lang)) {
             unlink($path . $a_lang);
         }
 
         $ilDB->update(
             'mail_template',
             array('att_file' => array('text', '')),
             array('lang' => array('text',$a_lang), 'type' => array('text','nacc'))
         );
     }

Here is the caller graph for this function:

◆ _lookupNewAccountMail()

static ilObjUserFolder::_lookupNewAccountMail ( string $a_lang )

static

Parameters

string $a_lang

Returns: array{lang: string, subject: string|null, body: string|null, salf_m: string|null sal_f: string|null, sal_g: string|null, type: string, att_file: string|null}

Definition at line 575 of file class.ilObjUserFolder.php.

References $DIC, $ilDB, and ilDBConstants\FETCHMODE_ASSOC.

Referenced by ilObjUserFolderGUI\initNewAccountMailForm(), ilObjUserFolderGUI\initUserRoleAssignmentForm(), ilAccountMail\readAccountMail(), and ilAccountRegistrationMail\trySendingUserDefinedAccountMail().

                                                                 : array
     {
         global $DIC;
 
         $ilDB = $DIC['ilDB'];
 
         $set = $ilDB->query("SELECT * FROM mail_template " .
             " WHERE type='nacc' AND lang = " . $ilDB->quote($a_lang, 'text'));
 
         if ($rec = $set->fetchRow(ilDBConstants::FETCHMODE_ASSOC)) {
             return $rec;
         }
 
         return [];
     }

Here is the caller graph for this function:

◆ _updateAccountMailAttachment()

static ilObjUserFolder::_updateAccountMailAttachment	(	string	$a_lang,
		string	$a_tmp_name,
		string	$a_name
	)

static

Update account mail attachment.

Exceptions

ilException

Definition at line 525 of file class.ilObjUserFolder.php.

References $DIC, $ilDB, $path, ilFileUtils\moveUploadedFile(), and USER_FOLDER_ID.

Referenced by ilObjUserFolderGUI\saveNewAccountMailObject().

      : void {
         global $DIC;
 
         $ilDB = $DIC['ilDB'];
 
         $fs = new ilFSStorageUserFolder(USER_FOLDER_ID);
         $fs->create();
         $path = $fs->getAbsolutePath() . "/";
 
         ilFileUtils::moveUploadedFile($a_tmp_name, $a_lang, $path . $a_lang);
 
         $ilDB->update(
             'mail_template',
             array('att_file' => array('text', $a_name)),
             array('lang' => array('text',$a_lang), 'type' => array('text','nacc'))
         );
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _updateUserFolderAssignment()

static ilObjUserFolder::_updateUserFolderAssignment	(	int	$a_old_id,
		int	$a_new_id
	)

static

Update user folder assignment Typically called after deleting a category with local user accounts.

These users will be assigned to the global user folder.

Definition at line 596 of file class.ilObjUserFolder.php.

References $DIC, $ilDB, and $query.

Referenced by ilObjCategory\delete(), and ilObjOrgUnit\delete().

      : void {
         global $DIC;
 
         $ilDB = $DIC['ilDB'];
 
         $query = "UPDATE usr_data SET time_limit_owner = " . $ilDB->quote($a_new_id, "integer") . " " .
             "WHERE time_limit_owner = " . $ilDB->quote($a_old_id, "integer") . " ";
         $ilDB->manipulate($query);
     }

Here is the caller graph for this function:

◆ _writeNewAccountMail()

static ilObjUserFolder::_writeNewAccountMail	(	string	$a_lang,
		string	$a_subject,
		string	$a_sal_g,
		string	$a_sal_f,
		string	$a_sal_m,
		string	$a_body
	)

static

Definition at line 482 of file class.ilObjUserFolder.php.

References $DIC, and $ilDB.

Referenced by ilObjUserFolderGUI\saveNewAccountMailObject().

      : void {
         global $DIC;
 
         $ilDB = $DIC['ilDB'];
 
         if (self::_lookupNewAccountMail($a_lang)) {
             $values = array(
                 'subject' => array('text',$a_subject),
                 'body' => array('clob',$a_body),
                 'sal_g' => array('text',$a_sal_g),
                 'sal_f' => array('text',$a_sal_f),
                 'sal_m' => array('text',$a_sal_m)
                 );
             $ilDB->update(
                 'mail_template',
                 $values,
                 array('lang' => array('text',$a_lang), 'type' => array('text','nacc'))
             );
         } else {
             $values = array(
                 'subject' => array('text',$a_subject),
                 'body' => array('clob',$a_body),
                 'sal_g' => array('text',$a_sal_g),
                 'sal_f' => array('text',$a_sal_f),
                 'sal_m' => array('text',$a_sal_m),
                 'lang' => array('text',$a_lang),
                 'type' => array('text','nacc')
                 );
             $ilDB->insert('mail_template', $values);
         }
     }

Here is the caller graph for this function:

◆ buildExportFile()

ilObjUserFolder::buildExportFile	(	string	$a_mode = `self::FILE_TYPE_EXCEL`,
		?array	$user_data_filter = `null`,
		bool	$use_temp_dir = `false`
	)

build xml export file

Definition at line 358 of file class.ilObjUserFolder.php.

References $data, $DIC, $ilDB, ilObject\$lng, $query, $res, ILIAS\LTI\ToolProvider\$settings, createCSVExport(), createExcelExport(), createExportDirectory(), createXMLExport(), ilDBConstants\FETCHMODE_ASSOC, ilLanguage\getDefaultLanguage(), getExportDirectory(), getExportFilename(), and ilFileUtils\ilTempnam().

      : string {
         global $DIC;
 
         $ilDB = $DIC['ilDB'];
         $lng = $DIC['lng'];
 
         if ($use_temp_dir) {
             $expDir = ilFileUtils::ilTempnam();
             $fullname = $expDir;
         } else {
             $expDir = $this->getExportDirectory();
             // create export directory if needed
             $this->createExportDirectory();
             $fullname = $expDir . "/" . $this->getExportFilename($a_mode);
         }
 
         //get data
         //$expLog->write(date("[y-m-d H:i:s] ")."User data export: build an array of all user data entries");
         $settings = self::getExportSettings();
 
         // user languages
         $query = "SELECT * FROM usr_pref WHERE keyword = " . $ilDB->quote('language', 'text');
         $res = $ilDB->query($query);
         $languages = array();
         while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_ASSOC)) {
             $languages[$row['usr_id']] = $row['value'];
         }
 
         // multi-text
         $multi = array();
         $set = $ilDB->query("SELECT * FROM usr_data_multi");
         while ($row = $ilDB->fetchAssoc($set)) {
             if (!is_array($user_data_filter) ||
                 in_array($row["usr_id"], $user_data_filter)) {
                 $multi[$row["usr_id"]][$row["field_id"]][] = $row["value"];
             }
         }
 
         $data = array();
         $query = "SELECT usr_data.* FROM usr_data  " .
             " ORDER BY usr_data.lastname, usr_data.firstname";
         $result = $ilDB->query($query);
         while ($row = $ilDB->fetchAssoc($result)) {
             if (isset($languages[$row['usr_id']])) {
                 $row['language'] = $languages[$row['usr_id']];
             } else {
                 $row['language'] = $lng->getDefaultLanguage();
             }
 
             if (isset($multi[$row["usr_id"]])) {
                 $row = array_merge($row, $multi[$row["usr_id"]]);
             }
 
             if (is_array($user_data_filter)) {
                 if (in_array($row["usr_id"], $user_data_filter)) {
                     $data[] = $row;
                 }
             } else {
                 $data[] = $row;
             }
         }
         //$expLog->write(date("[y-m-d H:i:s] ")."User data export: build an array of all user data entries");
 
         switch ($a_mode) {
             case self::FILE_TYPE_EXCEL:
                 $this->createExcelExport($settings, $data, $fullname);
                 break;
             case self::FILE_TYPE_CSV:
                 $this->createCSVExport($settings, $data, $fullname);
                 break;
             case self::FILE_TYPE_XML:
                 $this->createXMLExport($settings, $data, $fullname);
                 break;
         }
         return $fullname;
     }

Here is the call graph for this function:

◆ createCSVExport()

ilObjUserFolder::createCSVExport	(	array	$settings,
		array	$data,
		string	$filename
	)

protected

Definition at line 164 of file class.ilObjUserFolder.php.

References Vendor\Package\$f, getUserDefinedExportFields(), ILIAS\Repository\lng(), and ilCSVUtil\processCSVRow().

Referenced by buildExportFile().

      : void {
 
         // header
         $headerrow = array();
         $udf_ex_fields = $this->getUserDefinedExportFields();
         foreach ($settings as $value) { // standard fields
             $headerrow[] = $this->lng->txt($value);
         }
         foreach ($udf_ex_fields as $f) {        // custom fields
             $headerrow[] = $f["name"];
         }
 
         $separator = ";";
         $file = fopen($filename, 'wb');
         $formattedrow = &ilCSVUtil::processCSVRow($headerrow, true, $separator);
         fwrite($file, implode($separator, $formattedrow) . "\n");
         foreach ($data as $row) {
             $csvrow = array();
             foreach ($settings as $header) {    // standard fields
                 // multi-text
                 if (isset($row[$header]) && is_array($row[$header])) {
                     $row[$header] = implode(", ", $row[$header]);
                 }
 
                 $csvrow[] = $row[$header] ?? '';
             }
 
             // custom fields
             reset($udf_ex_fields);
             if (count($udf_ex_fields) > 0) {
                 $udf = new ilUserDefinedData($row["usr_id"]);
                 foreach ($udf_ex_fields as $f) {        // custom fields
                     $csvrow[] = $udf->get("f_" . $f["id"]);
                 }
             }
 
             $formattedrow = &ilCSVUtil::processCSVRow($csvrow, true, $separator);
             fwrite($file, implode($separator, $formattedrow) . "\n");
         }
         fclose($file);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ createExcelExport()

ilObjUserFolder::createExcelExport	(	array	$settings,
		array	$data,
		string	$filename
	)

protected

Definition at line 210 of file class.ilObjUserFolder.php.

References Vendor\Package\$f, $index, getUserDefinedExportFields(), IL_CAL_DATETIME, IL_CAL_UNIX, and ILIAS\Repository\lng().

Referenced by buildExportFile().

      : void {
         $worksheet = new ilExcel();
         $worksheet->addSheet($this->lng->txt("users"));
 
         $row = 1;
         $col = 0;
 
         $udf_ex_fields = $this->getUserDefinedExportFields();
 
         // title row
         foreach ($settings as $value) { // standard fields
             if ($value == 'ext_account') {
                 $value = 'user_ext_account';
             }
             $worksheet->setCell($row, $col, $this->lng->txt($value));
             $col++;
         }
         foreach ($udf_ex_fields as $f) {        // custom fields
             $worksheet->setCell($row, $col, $f["name"]);
             $col++;
         }
         $worksheet->setBold("A1:" . $worksheet->getColumnCoord($col - 1) . "1");
 
         $this->lng->loadLanguageModule("meta");
         foreach ($data as $index => $rowdata) {
             $row++;
             $col = 0;
 
             // standard fields
             foreach ($settings as $fieldname) {
                 $value = $rowdata[$fieldname] ?? "";
                 switch ($fieldname) {
                     case "language":
                         $worksheet->setCell($row, $col, $this->lng->txt("meta_l_" . $value));
                         break;
                     case "time_limit_from":
                     case "time_limit_until":
                         $value = $value
                             ? new ilDateTime($value, IL_CAL_UNIX)
                             : null;
                         $worksheet->setCell($row, $col, $value);
                         break;
                     case "last_login":
                     case "last_update":
                     case "create_date":
                     case "approve_date":
                     case "agree_date":
                         $value = $value
                             ? new ilDateTime($value, IL_CAL_DATETIME)
                             : null;
                         $worksheet->setCell($row, $col, $value);
                         break;
 
                     case "interests_general":
                     case "interests_help_offered":
                     case "interests_help_looking":
                         if (is_array($value) && count($value)) {
                             $value = implode(", ", $value);
                         } else {
                             $value = null;
                         }
                         // fallthrough
 
                         // no break
                     default:
                         $worksheet->setCell($row, $col, $value);
                         break;
                 }
                 $col++;
             }
 
             // custom fields
             reset($udf_ex_fields);
             if (count($udf_ex_fields) > 0) {
                 $udf = new ilUserDefinedData($rowdata["usr_id"]);
                 foreach ($udf_ex_fields as $f) {        // custom fields
                     $worksheet->setCell($row, $col, $udf->get("f_" . $f["id"]));
                     $col++;
                 }
             }
         }
 
         $worksheet->writeToFile($filename);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ createExportDirectory()

ilObjUserFolder::createExportDirectory ( )

protected

creates data directory for export files

Definition at line 443 of file class.ilObjUserFolder.php.

References ilFileUtils\getDataDir(), getExportDirectory(), and ilFileUtils\makeDir().

Referenced by buildExportFile().

                                               : void
     {
         if (!is_dir($this->getExportDirectory())) {
             $usrf_data_dir = ilFileUtils::getDataDir() . "/usrf_data";
             ilFileUtils::makeDir($usrf_data_dir);
             if (!is_writable($usrf_data_dir)) {
                 $this->ilias->raiseError("Userfolder data directory (" . $usrf_data_dir
                     . ") not writeable.", $this->ilias->error_obj->MESSAGE);
             }
 
             // create Export subdirectory (data_dir/lm_data/lm_<id>/Export)
             $export_dir = $usrf_data_dir . "/export";
             ilFileUtils::makeDir($export_dir);
             if (!is_dir($export_dir)) {
                 $this->ilias->raiseError("Creation of Userfolder Export Directory failed.", $this->ilias->error_obj->MESSAGE);
             }
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ createXMLExport()

ilObjUserFolder::createXMLExport	(	array	$settings,
		array	$data,
		string	$filename
	)

protected

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

References $DIC, $ilDB, and ilObject\$log.

Referenced by buildExportFile().

      : void {
         global $DIC;
 
         $rbacreview = $DIC['rbacreview'];
         $ilDB = $DIC['ilDB'];
         $log = $DIC['log'];
 
         $file = fopen($filename, 'wb');
 
         if (is_array($data)) {
             $xmlWriter = new ilUserXMLWriter();
             $xmlWriter->setObjects($data);
             $xmlWriter->setSettings($settings);
             $xmlWriter->setAttachRoles(true);
 
             if ($xmlWriter->start()) {
                 fwrite($file, $xmlWriter->getXML());
             }
         }
     }

Here is the caller graph for this function:

◆ delete()

ilObjUserFolder::delete ( )

Definition at line 40 of file class.ilObjUserFolder.php.

                             : bool
     {
         return false;
     }

◆ escapeXML()

ilObjUserFolder::escapeXML ( string $value )

protected

Definition at line 114 of file class.ilObjUserFolder.php.

                                                : string
     {
         $value = str_replace(["&", "<", ">"], ["&amp;", "&lt;", "&gt;"], $value);
         return $value;
     }

◆ getExportDirectory()

ilObjUserFolder::getExportDirectory ( )

Definition at line 67 of file class.ilObjUserFolder.php.

References ilFileUtils\getDataDir().

Referenced by buildExportFile(), createExportDirectory(), and getExportFiles().

                                         : string
     {
         $export_dir = ilFileUtils::getDataDir() . "/usrf_data/export";
 
         return $export_dir;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getExportFilename()

ilObjUserFolder::getExportFilename ( string $a_mode = self::FILE_TYPE_EXCEL )

Definition at line 45 of file class.ilObjUserFolder.php.

References $filename, and IL_INST_ID.

Referenced by buildExportFile().

      : string {
         $filename = "";
         $inst_id = IL_INST_ID;
 
         $date = time();
 
         switch ($a_mode) {
             case self::FILE_TYPE_EXCEL:
                 $filename = $date . "__" . $inst_id . "__xls_usrf";
                 break;
             case self::FILE_TYPE_CSV:
                 $filename = $date . "__" . $inst_id . "__csv_usrf.csv";
                 break;
             case self::FILE_TYPE_XML:
                 $filename = $date . "__" . $inst_id . "__xml_usrf.xml";
                 break;
         }
         return $filename;
     }

Here is the caller graph for this function:

◆ getExportFiles()

ilObjUserFolder::getExportFiles ( )

Get a list of the already exported files in the export directory.

Returns: array<string,string>[]

Definition at line 78 of file class.ilObjUserFolder.php.

References getExportDirectory().

                                     : array
     {
         $dir = $this->getExportDirectory();
 
         // quit if export dir not available
         if (!is_dir($dir) or
             !is_writable($dir)) {
             return array();
         }
 
         // open directory
         $dir = dir($dir);
 
         // initialize array
         $file = array();
 
         // get files and save the in the array
         while ($entry = $dir->read()) {
             if ($entry != "." and
                 $entry != ".." and
                 preg_match("/^[0-9]{10}_{2}[0-9]+_{2}([a-z0-9]{3})_usrf\.[a-z]{1,4}\$/", $entry, $matches)) {
                 $filearray["filename"] = $entry;
                 $filearray["filesize"] = filesize($this->getExportDirectory() . "/" . $entry);
                 $file[] = $filearray;
             }
         }
 
         // close import directory
         $dir->close();
 
         // sort files
         sort($file);
 
         return $file;
     }

Here is the call graph for this function:

◆ getExportSettings()

static ilObjUserFolder::getExportSettings ( )

static

Returns: array of exportable fields

Definition at line 302 of file class.ilObjUserFolder.php.

References $DIC, $ilDB, ILIAS\LTI\ToolProvider\$key, $query, and ilDBConstants\FETCHMODE_ASSOC.

Referenced by ilUserXMLWriter\__handleUser().

                                               : array // Missing array type.
     {
         global $DIC;
 
         $ilDB = $DIC['ilDB'];
 
         $db_settings = array();
 
         $up = new ilUserProfile();
         $up->skipField("roles");
         $profile_fields = $up->getStandardFields();
 
         $query = "SELECT * FROM settings WHERE " .
             $ilDB->like("keyword", "text", '%usr_settings_export_%');
         $result = $ilDB->query($query);
         while ($row = $result->fetchRow(ilDBConstants::FETCHMODE_ASSOC)) {
             if ($row["value"] == "1") {
                 if (preg_match("/usr_settings_export_(.*)/", $row["keyword"], $setting)) {
                     $db_settings[] = $setting[1];
                 }
             }
         }
         $export_settings = array();
         foreach ($profile_fields as $key => $value) {
             if (in_array($key, $db_settings)) {
                 if (strcmp($key, "password") == 0) {
                     // we do not support password export with ILIAS >= 4.5.x
                     continue;
                 } else {
                     $export_settings[] = $key;
                 }
             }
         }
         $export_settings[] = "usr_id";
         $export_settings[] = "login";
         $export_settings[] = "last_login";
         $export_settings[] = "last_update";
         $export_settings[] = "create_date";
         $export_settings[] = "time_limit_owner";
         $export_settings[] = "time_limit_unlimited";
         $export_settings[] = "time_limit_from";
         $export_settings[] = "time_limit_until";
         $export_settings[] = "time_limit_message";
         $export_settings[] = "active";
         $export_settings[] = "approve_date";
         $export_settings[] = "agree_date";
         $export_settings[] = "client_ip";
         $export_settings[] = "auth_mode";
         $export_settings[] = "ext_account";
         $export_settings[] = "feedhash";
         return $export_settings;
     }

Here is the caller graph for this function:

◆ getProfileFields()

static ilObjUserFolder::getProfileFields ( )

static

Get profile fields.

Deprecated:: use ilUserProfile() instead

Definition at line 467 of file class.ilObjUserFolder.php.

References Vendor\Package\$f.

                                              : array // Missing array type.
     {
         $up = new ilUserProfile();
         $up->skipField("username");
         $up->skipField("roles");
         $up->skipGroup("preferences");
         $fds = $up->getStandardFields();
         $profile_fields = [];
         foreach ($fds as $k => $f) {
             $profile_fields[] = $k;
         }
 
         return $profile_fields;
     }

◆ getUserDefinedExportFields()

ilObjUserFolder::getUserDefinedExportFields ( )

protected

Get all exportable user defined fields.

Definition at line 149 of file class.ilObjUserFolder.php.

References ilUserDefinedFields\_getInstance().

Referenced by createCSVExport(), and createExcelExport().

                                                    : array // Missing array type.
     {
         $udf_obj = ilUserDefinedFields::_getInstance();
 
         $udf_ex_fields = array();
         foreach ($udf_obj->getDefinitions() as $definition) {
             if ($definition["export"] != false) {
                 $udf_ex_fields[] = array("name" => $definition["field_name"],
                     "id" => $definition["field_id"]);
             }
         }
 
         return $udf_ex_fields;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ FILE_TYPE_CSV

const ilObjUserFolder::FILE_TYPE_CSV = 'userfolder_export_csv'

Definition at line 28 of file class.ilObjUserFolder.php.

Referenced by ilObjUserFolderGUI\usrExportCsvObject().

◆ FILE_TYPE_EXCEL

const ilObjUserFolder::FILE_TYPE_EXCEL = 'userfolder_export_excel_x86'

Definition at line 27 of file class.ilObjUserFolder.php.

Referenced by ilObjUserFolderGUI\usrExportX86Object().

◆ FILE_TYPE_XML

const ilObjUserFolder::FILE_TYPE_XML = 'userfolder_export_xml'

Definition at line 29 of file class.ilObjUserFolder.php.

Referenced by ilObjUserFolderGUI\usrExportXmlObject().

◆ ORG_OP_EDIT_USER_ACCOUNTS

const ilObjUserFolder::ORG_OP_EDIT_USER_ACCOUNTS = 'edit_user_accounts'

Definition at line 26 of file class.ilObjUserFolder.php.

Referenced by ilLocalUser\_getFolderIds(), ilObjUserFolderGUI\checkUserManipulationAccessBool(), ilObjUserGUI\checkUserWriteRight(), ilObjUserFolderGUI\deleteUsersObject(), ilObjUserFolderGUI\executeCommand(), ilObjUserFolderGUI\filterUserIdsByRbacOrPositionOfCurrentUser(), ilObjUserFolderGUI\getActionUserIds(), ilObjUserFolderGUI\getTabs(), ilObjUserFolderGUI\raiseErrorOnMissingWrite(), ilObjUserFolderGUI\searchUserAccessFilterCallable(), and ilObjUserFolderGUI\viewObject().

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

Services/User/classes/class.ilObjUserFolder.php

Public Member Functions

Static Public Member Functions

Data Fields

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _deleteAccountMailAttachment()

◆ _lookupNewAccountMail()

◆ _updateAccountMailAttachment()

◆ _updateUserFolderAssignment()

◆ _writeNewAccountMail()

◆ buildExportFile()

◆ createCSVExport()

◆ createExcelExport()

◆ createExportDirectory()

◆ createXMLExport()

◆ delete()

◆ escapeXML()

◆ getExportDirectory()

◆ getExportFilename()

◆ getExportFiles()

◆ getExportSettings()

◆ getProfileFields()

◆ getUserDefinedExportFields()

Field Documentation

◆ FILE_TYPE_CSV

◆ FILE_TYPE_EXCEL

◆ FILE_TYPE_XML

◆ ORG_OP_EDIT_USER_ACCOUNTS