ilObjUserFolder Class Reference

Inheritance diagram for ilObjUserFolder:

Collaboration diagram for ilObjUserFolder:

Public Member Functions
	__construct ($a_id, $a_call_by_reference=true)
	Constructor public. More...
	delete ()
	delete userfolder and all related data DISABLED public More...
	getExportFilename ($a_mode=self::FILE_TYPE_EXCEL)
	getExportDirectory ()
	Get the location of the export directory for the user accounts. More...
	getExportFiles ()
	Get a list of the already exported files in the export directory. More...
	buildExportFile ($a_mode=self::FILE_TYPE_EXCEL, $user_data_filter=false, $use_temp_dir=false)
	build xml export file More...
Public Member Functions inherited from ilObject
	__construct ($a_id=0, $a_reference=true)
	Constructor public. More...
	withReferences ()
	determines wehter objects are referenced or not (got ref ids or not) More...
	read ()
	read object data from db into object More...
	getId ()
	get object id public More...
	setId ($a_id)
	set object id public More...
	setRefId ($a_id)
	set reference id public More...
	getRefId ()
	get reference id public More...
	getType ()
	get object type public More...
	setType ($a_type)
	set object type public More...
	getPresentationTitle ()
	get presentation title Normally same as title Overwritten for sessions More...
	getTitle ()
	get object title public More...
	getUntranslatedTitle ()
	get untranslated object title public More...
	setTitle ($a_title)
	set object title More...
	getDescription ()
	get object description More...
	setDescription ($a_desc)
	set object description More...
	getLongDescription ()
	get object long description (stored in object_description) More...
	getImportId ()
	get import id More...
	setImportId ($a_import_id)
	set import id More...
	setOfflineStatus ($a_status)
	Set offline status. More...
	getOfflineStatus ()
	Get offline status. More...
	supportsOfflineHandling ()
	Check whether object supports offline handling. More...
	getOwner ()
	get object owner More...
	getOwnerName ()
	setOwner ($a_owner)
	set object owner More...
	getCreateDate ()
	get create date public More...
	getLastUpdateDate ()
	get last update date public More...
	getDiskUsage ()
	Gets the disk usage of the object in bytes. More...
	create ()
	create More...
	update ()
	update object in db More...
	MDUpdateListener ($a_element)
	Meta data update listener. More...
	createMetaData ()
	create meta data entry More...
	updateMetaData ()
	update meta data entry More...
	deleteMetaData ()
	delete meta data entry More...
	updateOwner ()
	update owner of object in db More...
	putInTree ($a_parent_ref)
	maybe this method should be in tree object!? More...
	setPermissions ($a_parent_ref)
	set permissions of object More...
	setParentRolePermissions ($a_parent_ref)
	Initialize the permissions of parent roles (local roles of categories, global roles...) This method is overwritten in e.g courses, groups for building permission intersections with non_member templates. More...
	createReference ()
	creates reference for object More...
	countReferences ()
	count references of object More...
	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 If you want to setup default local roles you MUST overwrite this method in derived object classes (see ilObjForum for an example) public More...
	applyDidacticTemplate ($a_tpl_id)
	Apply template. More...
	setRegisterMode ($a_bool)
	isUserRegistered ($a_user_id=0)
	requireRegistration ()
	getXMLZip ()
	getHTMLDirectory ()
	appendCopyInfo ($a_target_id, $a_copy_id)
	Prepend Copy info if object with same name exists in that container. More...
	cloneDependencies ($a_target_id, $a_copy_id)
	Clone object dependencies. More...
	cloneMetaData ($target_obj)
	Copy meta data. More...
	getPossibleSubObjects ($a_filter=true)
	get all possible subobjects of this type the object can decide which types of subobjects are possible jut in time overwrite if the decision distinguish from standard model More...

Static Public Member Functions
static	getExportSettings ()
	getExport Settings More...
static &	getProfileFields ()
	Get profile fields (DEPRECATED, use ilUserProfile() instead) More...
static	_writeNewAccountMail ($a_lang, $a_subject, $a_sal_g, $a_sal_f, $a_sal_m, $a_body)
static	_updateAccountMailAttachment ($a_lang, $a_tmp_name, $a_name)
	Update account mail attachment. More...
static	_deleteAccountMailAttachment ($a_lang)
	Delete account mail attachment. More...
static	_lookupNewAccountMail ($a_lang)
static	_updateUserFolderAssignment ($a_old_id, $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 ($a_import_id)
static	_lookupImportId ($a_obj_id)
static	_lookupOwnerName ($a_owner_id)
	lookup owner name for owner id More...
static	_getIdForImportId ($a_import_id)
	get current object id for import id (static) More...
static	_getAllReferences ($a_id)
	get all reference ids of object More...
static	_lookupTitle ($a_id)
	lookup object title More...
static	lookupOfflineStatus ($a_obj_id)
	Lookup offline status using objectDataCache. More...
static	_lookupOwner ($a_id)
	lookup object owner More...
static	_getIdsForTitle ($title, $type='', $partialmatch=false)
static	_lookupDescription ($a_id)
	lookup object description More...
static	_lookupLastUpdate ($a_id, $a_as_string=false)
	lookup last update More...
static	_getLastUpdateOfObjects ($a_objs)
	Get last update for a set of media objects. More...
static	_lookupObjId ($a_id)
static	_setDeletedDate ($a_ref_id, $a_deleted_by)
static	setDeletedDates ($a_ref_ids, $a_user_id)
	Set deleted date. More...
static	_resetDeletedDate ($a_ref_id)
	only called in ilObjectGUI::insertSavedNodes More...
static	_lookupDeletedDate ($a_ref_id)
	only called in ilObjectGUI::insertSavedNodes More...
static	_writeTitle ($a_obj_id, $a_title)
	write title to db (static) More...
static	_writeDescription ($a_obj_id, $a_desc)
	write description to db (static) More...
static	_writeImportId ($a_obj_id, $a_import_id)
	write import id to db (static) More...
static	_lookupType ($a_id, $a_reference=false)
	lookup object type More...
static	_isInTrash ($a_ref_id)
	checks wether object is in trash More...
static	_hasUntrashedReference ($a_obj_id)
	checks wether an object has at least one reference that is not in trash More...
static	_lookupObjectId ($a_ref_id)
	lookup object id More...
static	_getObjectsDataForType ($a_type, $a_omit_trash=false)
	get all objects of a certain type More...
static	_exists ($a_id, $a_reference=false, $a_type=null)
	checks if an object exists in object_data More...
static	_getObjectsByType ($a_obj_type="", $a_owner="")
	Get objects by type. More...
static	_prepareCloneSelection ($a_ref_ids, $new_type, $show_path=true)
	Prepare copy wizard object selection. More...
static	_getIcon ( $a_obj_id="", $a_size="big", $a_type="", $a_offline=false)
	Get icon for repository item. More...
static	collectDeletionDependencies (&$deps, $a_ref_id, $a_obj_id, $a_type, $a_depth=0)
	Collect deletion dependencies. More...
static	getDeletionDependencies ($a_obj_id)
	Get deletion dependencies. More...
static	getLongDescriptions (array $a_obj_ids)
	Get long description data. More...
static	getAllOwnedRepositoryObjects ($a_user_id)
	Get all ids of objects user owns. More...
static	fixMissingTitles ($a_type, array &$a_obj_title_map)
	Try to fix missing object titles. More...
static	_lookupCreationDate ($a_id)
	Lookup creation date. More...
static	hasAutoRating ($a_type, $a_ref_id)
	Check if auto rating is active for parent group/course. More...

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
	max length of object title More...
const	DESC_LENGTH = 128
	$lng
	$id
	$ref_id
	$type
	$title
	$untranslatedTitle
	$desc
	$long_desc
	$owner
	$create_date
	$last_update
	$import_id
	$register = false
	$referenced
	$objectList
	$max_title
	$max_desc
	$add_dots

Protected Member Functions
	escapeXML ($value)
	createXMLExport (&$settings, &$data, $filename)
	getUserDefinedExportFields ()
	Get all exportable user defined fields. More...
	createCSVExport (&$settings, &$data, $filename)
	createExcelExport (&$settings, &$data, $filename)
	createExportDirectory ()
	creates data directory for export files (data_dir/usrf_data/export, depending on data directory that is set in ILIAS setup/ini) More...

Additional Inherited Members
Protected Attributes inherited from ilObject
	$objDefinition
	$db
	$log
	$error
	$tree
	$app_event_handler
	$rbacadmin
	$rbacreview

Detailed Description

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

Constructor & Destructor Documentation

__construct()

ilObjUserFolder::__construct	(		$a_id,
			$a_call_by_reference = true
	)

Constructor public.

Parameters

integer	reference_id or object_id
boolean	treat the id as reference_id (true) or object_id (false)

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 (   $a_lang )

static

Delete account mail attachment.

Parameters

$a_lang

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

References $DIC, $ilDB, and USER_FOLDER_ID.

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];
        
        include_once "Services/User/classes/class.ilFSStorageUserFolder.php";
        $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'))
        );
    }

_lookupNewAccountMail()

static ilObjUserFolder::_lookupNewAccountMail (   $a_lang )

static

Parameters

string

$a_lang

Returns

array

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

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

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

    {
        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 array();
    }

Here is the caller graph for this function:

_updateAccountMailAttachment()

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

static

Update account mail attachment.

Parameters

$a_lang
$a_tmp_name
$a_name

Exceptions

ilException

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

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

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];
        
        include_once "Services/User/classes/class.ilFSStorageUserFolder.php";
        $fs = new ilFSStorageUserFolder(USER_FOLDER_ID);
        $fs->create();
        $path = $fs->getAbsolutePath() . "/";

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

_updateUserFolderAssignment()

static ilObjUserFolder::_updateUserFolderAssignment (   $a_old_id,   $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.

public

Parameters

int	old_id
int	new id

Returns

bool

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

References $DIC, $ilDB, and $query.

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

    {
        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);
        
        return true;
    }

Here is the caller graph for this function:

_writeNewAccountMail()

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

static

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

References $DIC, and $ilDB.

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

buildExportFile()

ilObjUserFolder::buildExportFile	(		$a_mode = self::FILE_TYPE_EXCEL,
			$user_data_filter = false,
			$use_temp_dir = false
	)

build xml export file

Parameters

string	$a_mode
bool	$user_data_filter
bool	$use_temp_dir

Returns

string

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

References $data, $DIC, $ilBench, $ilDB, ilObject\$lng, ilObject\$log, $query, $res, $result, createCSVExport(), createExcelExport(), createExportDirectory(), createXMLExport(), ilDBConstants\FETCHMODE_ASSOC, getExportDirectory(), getExportFilename(), getExportSettings(), and ilUtil\ilTempnam().

    {
        global $DIC;

        $ilBench = $DIC['ilBench'];
        global $DIC;

        $log = $DIC['log'];
        global $DIC;

        $ilDB = $DIC['ilDB'];
        global $DIC;

        $ilias = $DIC['ilias'];
        global $DIC;

        $lng = $DIC['lng'];

        if ($use_temp_dir) {
            $expDir = ilUtil::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 = &$this->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)) {
                    array_push($data, $row);
                }
            } else {
                array_push($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;
        }
        //$expLog->write(date("[y-m-d H:i:s] ")."Finished export of user data");

        return $fullname;
    }

Here is the call graph for this function:

createCSVExport()

ilObjUserFolder::createCSVExport ( &  $settings, &  $data,   $filename  )

protected

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

References $data, Vendor\Package\$f, $filename, getUserDefinedExportFields(), and ilUtil\processCSVRow().

Referenced by buildExportFile().

    {

        // header
        $headerrow = array();
        $udf_ex_fields = $this->getUserDefinedExportFields();
        foreach ($settings as $value) { // standard fields
            array_push($headerrow, $this->lng->txt($value));
        }
        foreach ($udf_ex_fields as $f) {        // custom fields
            array_push($headerrow, $f["name"]);
        }

        $separator = ";";
        $file = fopen($filename, "w");
        $formattedrow = &ilUtil::processCSVRow($headerrow, true, $separator);
        fwrite($file, join($separator, $formattedrow) . "\n");
        foreach ($data as $row) {
            $csvrow = array();
            foreach ($settings as $header) {    // standard fields
                // multi-text
                if (is_array($row[$header])) {
                    $row[$header] = implode(", ", $row[$header]);
                }
                
                array_push($csvrow, $row[$header]);
            }

            // custom fields
            reset($udf_ex_fields);
            if (count($udf_ex_fields) > 0) {
                include_once("./Services/User/classes/class.ilUserDefinedData.php");
                $udf = new ilUserDefinedData($row["usr_id"]);
                foreach ($udf_ex_fields as $f) {        // custom fields
                    array_push($csvrow, $udf->get("f_" . $f["id"]));
                }
            }

            $formattedrow = &ilUtil::processCSVRow($csvrow, true, $separator);
            fwrite($file, join($separator, $formattedrow) . "\n");
        }
        fclose($file);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

createExcelExport()

ilObjUserFolder::createExcelExport ( &  $settings, &  $data,   $filename  )

protected

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

References $data, Vendor\Package\$f, $filename, $index, getUserDefinedExportFields(), IL_CAL_DATETIME, and IL_CAL_UNIX.

Referenced by buildExportFile().

    {
        include_once "./Services/Excel/classes/class.ilExcel.php";
        $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) && sizeof($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) {
                include_once("./Services/User/classes/class.ilUserDefinedData.php");
                $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 (data_dir/usrf_data/export, depending on data directory that is set in ILIAS setup/ini)

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

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

Referenced by buildExportFile().

    {
        if (!@is_dir($this->getExportDirectory())) {
            $usrf_data_dir = ilUtil::getDataDir() . "/usrf_data";
            ilUtil::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";
            ilUtil::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 ( &  $settings, &  $data,   $filename  )

protected

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

References $data, $DIC, $filename, $ilDB, ilObject\$log, and ilObject\$rbacreview.

Referenced by buildExportFile().

    {
        include_once './Services/User/classes/class.ilUserDefinedData.php';
        include_once './Services/User/classes/class.ilObjUser.php';

        global $DIC;

        $rbacreview = $DIC['rbacreview'];
        global $DIC;

        $ilDB = $DIC['ilDB'];
        global $DIC;

        $log = $DIC['log'];

        $file = fopen($filename, "w");

        if (is_array($data)) {
            include_once './Services/User/classes/class.ilUserXMLWriter.php';

            $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

(

)

delete userfolder and all related data DISABLED public

Returns

boolean true if all object data were removed; false if only a references were removed

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

    {
        // DISABLED
        return false;

        // always call parent delete function first!!
        if (!parent::delete()) {
            return false;
        }
        // put here userfolder specific stuff

        // always call parent delete function at the end!!
        return true;
    }

escapeXML()

ilObjUserFolder::escapeXML (   $value )

protected

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

    {
        $value = str_replace("&", "&", $value);
        $value = str_replace("<", "&lt;", $value);
        $value = str_replace(">", "&gt;", $value);
        return $value;
    }

getExportDirectory()

ilObjUserFolder::getExportDirectory

(

)

Get the location of the export directory for the user accounts.

Get the location of the export directory for the user accounts

public

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

References ilUtil\getDataDir().

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

    {
        $export_dir = ilUtil::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

(

$a_mode = self::FILE_TYPE_EXCEL

)

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

References $filename, and IL_INST_ID.

Referenced by buildExportFile().

    {
        $filename = "";
        //$settings = $this->ilias->getAllSettings();
        //$this->inst_id = $settings["inst_id"];
        $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.

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

Returns

array A list of file names public

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

References getExportDirectory().

    {
        $dir = $this->getExportDirectory();

        // quit if export dir not available
        if (!@is_dir($dir) or
            !is_writeable($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);
                array_push($file, $filearray);
            }
        }

        // close import directory
        $dir->close();

        // sort files
        sort($file);
        reset($file);

        return $file;
    }

Here is the call graph for this function:

getExportSettings()

static ilObjUserFolder::getExportSettings ( )

static

getExport Settings

Returns

array of exportable fields

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

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

Referenced by ilUserXMLWriter\__handleUser(), and buildExportFile().

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];

        $db_settings = array();
        
        include_once("./Services/User/classes/class.ilUserProfile.php");
        $up = new ilUserProfile();
        $up->skipField("roles");
        $profile_fields = $up->getStandardFields();

        /*$profile_fields =& ilObjUserFolder::getProfileFields();
        $profile_fields[] = "preferences";*/

        $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)) {
                    array_push($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 {
                    array_push($export_settings, $key);
                }
            }
        }
        array_push($export_settings, "usr_id");
        array_push($export_settings, "login");
        array_push($export_settings, "last_login");
        array_push($export_settings, "last_update");
        array_push($export_settings, "create_date");
        array_push($export_settings, "time_limit_owner");
        array_push($export_settings, "time_limit_unlimited");
        array_push($export_settings, "time_limit_from");
        array_push($export_settings, "time_limit_until");
        array_push($export_settings, "time_limit_message");
        array_push($export_settings, "active");
        array_push($export_settings, "approve_date");
        array_push($export_settings, "agree_date");
        array_push($export_settings, "client_ip");
        array_push($export_settings, "auth_mode");
        array_push($export_settings, "ext_account");
        array_push($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)

Returns

array of fieldnames

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

References Vendor\Package\$f.

    {
        include_once("./Services/User/classes/class.ilUserProfile.php");
        $up = new ilUserProfile();
        $up->skipField("username");
        $up->skipField("roles");
        $up->skipGroup("preferences");
        $fds = $up->getStandardFields();
        foreach ($fds as $k => $f) {
            $profile_fields[] = $k;
        }

        return $profile_fields;
    }

getUserDefinedExportFields()

ilObjUserFolder::getUserDefinedExportFields ( )

protected

Get all exportable user defined fields.

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

References ilUserDefinedFields\_getInstance().

Referenced by createCSVExport(), and createExcelExport().

    {
        include_once './Services/User/classes/class.ilUserDefinedFields.php';
        $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 23 of file class.ilObjUserFolder.php.

Referenced by ilObjUserFolderGUI\usrExportCsvObject().

FILE_TYPE_EXCEL

const ilObjUserFolder::FILE_TYPE_EXCEL = 'userfolder_export_excel_x86'

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

Referenced by ilObjUserFolderGUI\usrExportX86Object().

FILE_TYPE_XML

const ilObjUserFolder::FILE_TYPE_XML = 'userfolder_export_xml'

Definition at line 24 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 20 of file class.ilObjUserFolder.php.

Referenced by ilLocalUser\_getFolderIds(), ilObjUserFolderGUI\checkUserManipulationAccessBool(), ilObjUserFolderGUI\executeCommand(), ilObjUserFolderGUI\filterUserIdsByRbacOrPositionOfCurrentUser(), ilObjUserFolderGUI\getActionUserIds(), ilObjUserFolderGUI\getTabs(), ilObjUserGUI\saveObject(), ilObjUserFolderGUI\searchUserAccessFilterCallable(), ilObjUserGUI\updateObject(), and ilObjUserFolderGUI\viewObject().

---

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

• Services/User/classes/class.ilObjUserFolder.php