ILIAS
trunk Revision v11.0_alpha-3011-gc6b235a2e85
|
Class ilObjUserFolder. More...
Public Member Functions | |
__construct (int $a_id, bool $a_call_by_reference=true) | |
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... | |
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... | |
![]() | |
getObjectProperties () | |
flushObjectProperties () | |
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 $description) | |
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, int $new_obj_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 | _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 | _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 | getIconForType (string $type) |
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' |
![]() | |
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 () | |
createCSVExport (array $settings, array $data, string $filename) | |
createExcelExport (array $settings, array $data, string $filename) | |
createExportDirectory () | |
creates data directory for export files More... | |
![]() | |
doMDUpdateListener (string $a_element) | |
beforeMDUpdateListener (string $a_element) | |
doCreateMetaData () | |
beforeCreateMetaData () | |
doUpdateMetaData () | |
beforeUpdateMetaData () | |
doDeleteMetaData () | |
beforeDeleteMetaData () | |
handleAutoRating () | |
hasAutoRating () | |
Private Member Functions | |
processCSVRow (array $row) | |
Private Attributes | |
Profile | $profile |
Additional Inherited Members | |
![]() | |
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 |
LOMServices | $lom_services |
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 = "" |
string | $desc = "" |
string | $long_desc = "" |
int | $owner = 0 |
string | $create_date = "" |
string | $last_update = "" |
string | $import_id = "" |
bool | $register = false |
Class ilObjUserFolder.
Definition at line 33 of file class.ilObjUserFolder.php.
ilObjUserFolder::__construct | ( | int | $a_id, |
bool | $a_call_by_reference = true |
||
) |
Definition at line 42 of file class.ilObjUserFolder.php.
References ILIAS\GlobalScreen\Provider\__construct(), and ILIAS\Repository\profile().
|
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 482 of file class.ilObjUserFolder.php.
Referenced by ilObjCategory\delete(), and ilObjOrgUnit\delete().
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 347 of file class.ilObjUserFolder.php.
References ilFileUtils\ilTempnam().
|
protected |
Definition at line 158 of file class.ilObjUserFolder.php.
|
protected |
Definition at line 200 of file class.ilObjUserFolder.php.
|
protected |
creates data directory for export files
Definition at line 445 of file class.ilObjUserFolder.php.
References ilFileUtils\getDataDir(), and ilFileUtils\makeDir().
|
protected |
Definition at line 132 of file class.ilObjUserFolder.php.
References $filename.
ilObjUserFolder::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!!
Reimplemented from ilObject.
Definition at line 53 of file class.ilObjUserFolder.php.
|
protected |
Definition at line 127 of file class.ilObjUserFolder.php.
ilObjUserFolder::getExportDirectory | ( | ) |
Definition at line 80 of file class.ilObjUserFolder.php.
References ilFileUtils\getDataDir().
ilObjUserFolder::getExportFilename | ( | string | $a_mode = self::FILE_TYPE_EXCEL | ) |
Definition at line 58 of file class.ilObjUserFolder.php.
ilObjUserFolder::getExportFiles | ( | ) |
Get a list of the already exported files in the export directory.
Definition at line 91 of file class.ilObjUserFolder.php.
References ILIAS\UI\examples\Symbol\Glyph\Sort\sort().
|
static |
Definition at line 292 of file class.ilObjUserFolder.php.
References $DIC, $ilDB, and ilDBConstants\FETCHMODE_ASSOC.
Referenced by ilUserXMLWriter\__handleUser().
|
static |
Get profile fields.
Definition at line 469 of file class.ilObjUserFolder.php.
|
protected |
Definition at line 147 of file class.ilObjUserFolder.php.
|
private |
Definition at line 428 of file class.ilObjUserFolder.php.
|
private |
Definition at line 40 of file class.ilObjUserFolder.php.
const ilObjUserFolder::FILE_TYPE_CSV = 'userfolder_export_csv' |
Definition at line 37 of file class.ilObjUserFolder.php.
Referenced by ilObjUserFolderGUI\usrExportCsvObject().
const ilObjUserFolder::FILE_TYPE_EXCEL = 'userfolder_export_excel_x86' |
Definition at line 36 of file class.ilObjUserFolder.php.
Referenced by ilObjUserFolderGUI\usrExportX86Object().
const ilObjUserFolder::FILE_TYPE_XML = 'userfolder_export_xml' |
Definition at line 38 of file class.ilObjUserFolder.php.
Referenced by ilObjUserFolderGUI\usrExportXmlObject().
const ilObjUserFolder::ORG_OP_EDIT_USER_ACCOUNTS = 'edit_user_accounts' |
Definition at line 35 of file class.ilObjUserFolder.php.
Referenced by ilLocalUser\_getFolderIds(), ilObjUserGUI\checkAccessToRolesTab(), ilObjUserFolderGUI\checkUserManipulationAccessBool(), ilObjUserGUI\checkUserWritePermission(), ilObjUserFolderGUI\deleteUsersObject(), ILIAS\User\Presentation\AdminTabs\editSettingsAccessGranted(), ilObjUserFolderGUI\executeCommand(), ilObjUserFolderGUI\filterUserIdsByRbacOrPositionOfCurrentUser(), ilObjUserFolderGUI\getActionUserIds(), ilObjUserFolderGUI\raiseErrorOnMissingWrite(), ILIAS\User\Presentation\AdminTabs\readAccessToAccountsGranted(), and ilObjUserFolderGUI\searchUserAccessFilterCallable().