ilObjFolder Class Reference
Class ilObjFolder. More...
Inheritance diagram for ilObjFolder:
Collaboration diagram for ilObjFolder:
Public Member Functions | |
| __construct ($a_id=0, $a_call_by_reference=true) | |
| Constructor public. More... | |
| setFolderTree ($a_tree) | |
| cloneObject ($a_target_id, $a_copy_id=0, $a_omit_tree=false) | |
| Clone folder. More... | |
| putInTree ($a_parent) | |
| insert folder into grp_tree More... | |
| cloneDependencies ($a_target_id, $a_copy_id) | |
| Clone object dependencies (crs items, preconditions) More... | |
| downloadFolder () | |
| getViewMode () | |
| Get container view mode. More... | |
| addAdditionalSubItemInformation (&$a_item_data) | |
| Add additional information to sub item, e.g. More... | |
| read () | |
| Overwritten read method. 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... | |
| 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 () | |
| cloneObject ($a_target_id, $a_copy_id=0, $a_omit_tree=false) | |
| Clone object permissions, put in tree ... More... | |
| 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... | |
| Public Member Functions inherited from ilContainer | |
| __construct ($a_id=0, $a_reference=true) | |
| createContainerDirectory () | |
| Create directory for the container. More... | |
| getContainerDirectory () | |
| Get the container directory. More... | |
| getBigIconPath () | |
| Get path for big icon. More... | |
| getSmallIconPath () | |
| Get path for small icon. More... | |
| getTinyIconPath () | |
| Get path for tiny icon. More... | |
| getCustomIconPath () | |
| Get path for custom icon. More... | |
| setHiddenFilesFound ($a_hiddenfilesfound) | |
| Set Found hidden files (set by getSubItems). More... | |
| getHiddenFilesFound () | |
| Get Found hidden files (set by getSubItems). More... | |
| getStyleSheetId () | |
| get ID of assigned style sheet object More... | |
| setStyleSheetId ($a_style_id) | |
| set ID of assigned style sheet object More... | |
| setNewsTimeline ($a_val) | |
| Set news timeline. More... | |
| getNewsTimeline () | |
| Get news timeline. More... | |
| setNewsTimelineAutoEntries ($a_val) | |
| Set news timeline auto entries. More... | |
| getNewsTimelineAutoEntries () | |
| Get news timeline auto entries. More... | |
| setNewsTimelineLandingPage ($a_val) | |
| Set news timline is landing page. More... | |
| getNewsTimelineLandingPage () | |
| Get news timline is landing page. More... | |
| isNewsTimelineEffective () | |
| Is news timeline effective? More... | |
| isNewsTimelineLandingPageEffective () | |
| Is news timeline landing page effective? More... | |
| setNewsBlockActivated ($a_val) | |
| Set news block activated. More... | |
| getNewsBlockActivated () | |
| Get news block activated. More... | |
| setUseNews ($a_val) | |
| Set use news. More... | |
| getUseNews () | |
| Get use news. More... | |
| saveIcons ($a_custom_icon) | |
| save container icons More... | |
| removeCustomIcon () | |
| remove small icon More... | |
| cloneObject ($a_target_id, $a_copy_id=0, $a_omit_tree=false) | |
| Clone container settings. More... | |
| cloneDependencies ($a_target_id, $a_copy_id) | |
| Clone object dependencies (container sorting) More... | |
| cloneAllObject ($session_id, $client_id, $new_type, $ref_id, $clone_source, $options, $soap_call=false, $a_submode=1) | |
| clone all objects according to this container More... | |
| getViewMode () | |
| Get container view mode. More... | |
| getOrderType () | |
| Get order type default implementation. More... | |
| setOrderType ($a_value) | |
| getSubItems ($a_admin_panel_enabled=false, $a_include_side_block=false, $a_get_single=0) | |
| Get subitems of container. More... | |
| gotItems () | |
| Check whether we got any items. More... | |
| addAdditionalSubItemInformation (&$object) | |
| Add additional information to sub item, e.g. More... | |
| getGroupedObjTypes () | |
| Get grouped repository object types. More... | |
| enablePageEditing () | |
| Check whether page editing is allowed for container. More... | |
| create () | |
| Create. More... | |
| update () | |
| Update. More... | |
| read () | |
| read More... | |
| readContainerSettings () | |
| Read container settings. More... | |
Data Fields | |
| $folder_tree | |
| Data Fields inherited from ilObject | |
| const | TITLE_LENGTH = 255 |
| max length of object title More... | |
| const | DESC_LENGTH = 128 |
| $ilias | |
| $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 | |
| Data Fields inherited from ilContainer | |
| const | VIEW_SESSIONS = 0 |
| const | VIEW_OBJECTIVE = 1 |
| const | VIEW_TIMING = 2 |
| const | VIEW_ARCHIVE = 3 |
| const | VIEW_SIMPLE = 4 |
| const | VIEW_BY_TYPE = 5 |
| const | VIEW_INHERIT = 6 |
| const | VIEW_DEFAULT = self::VIEW_BY_TYPE |
| const | SORT_TITLE = 0 |
| const | SORT_MANUAL = 1 |
| const | SORT_ACTIVATION = 2 |
| const | SORT_INHERIT = 3 |
| const | SORT_CREATION = 4 |
| const | SORT_DIRECTION_ASC = 0 |
| const | SORT_DIRECTION_DESC = 1 |
| const | SORT_NEW_ITEMS_POSITION_TOP = 0 |
| const | SORT_NEW_ITEMS_POSITION_BOTTOM = 1 |
| const | SORT_NEW_ITEMS_ORDER_TITLE = 0 |
| const | SORT_NEW_ITEMS_ORDER_CREATION = 1 |
| const | SORT_NEW_ITEMS_ORDER_ACTIVATION = 2 |
Static Private Member Functions | |
| static | recurseFolder ($refid, $title, $tmpdir) |
| private functions which iterates through all folders and files and create an according file structure in a temporary directory. More... | |
Additional Inherited Members | |
| 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 | _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) |
| only called in ilTree::saveSubTree More... | |
| static | setDeletedDates ($a_ref_ids) |
| Set deleted date type $ilDB. 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... | |
| Static Public Member Functions inherited from ilContainer | |
| static | _getContainerDirectory ($a_id) |
| Get the container directory. More... | |
| static | _lookupContainerSetting ($a_id, $a_keyword, $a_default_value=NULL) |
| Lookup a container setting. More... | |
| static | _writeContainerSetting ($a_id, $a_keyword, $a_value) |
| static | _getContainerSettings ($a_id) |
| static | _deleteContainerSettings ($a_id, $a_keyword=null, $a_keyword_like=false) |
| static | _exportContainerSettings (ilXmlWriter $a_xml, $a_obj_id) |
| static | _lookupIconPath ($a_id, $a_size="big") |
| lookup icon path More... | |
| static | getCompleteDescriptions (array $objects) |
| overwrites description fields to long or short description in an assoc array keys needed (obj_id and description) More... | |
| Static Public Attributes inherited from ilContainer | |
| static | $data_preloaded = false |
| Static Protected Member Functions inherited from ilContainer | |
| static | fixInternalLinksAfterCopy ($a_target_id, $a_copy_id, $a_source_ref_id) |
| Fix internal links after copy process. More... | |
| Protected Attributes inherited from ilContainer | |
| $order_type = 0 | |
| $hiddenfilesfound = false | |
| $news_timeline = false | |
| $news_timeline_auto_entries = false | |
| $setting | |
Detailed Description
Class ilObjFolder.
- Version
- Id
- class.ilObjFolder.php 40448 2013-03-08 10:02:02Z jluetzen
Definition at line 34 of file class.ilObjFolder.php.
Constructor & Destructor Documentation
◆ __construct()
| ilObjFolder::__construct | ( | $a_id = 0, |
|
$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 44 of file class.ilObjFolder.php.
Member Function Documentation
◆ addAdditionalSubItemInformation()
| ilObjFolder::addAdditionalSubItemInformation | ( | & | $a_item_data | ) |
Add additional information to sub item, e.g.
used in courses for timings information etc.
Definition at line 230 of file class.ilObjFolder.php.
References ilObjectActivation\addAdditionalSubItemInformation().
static addAdditionalSubItemInformation(array &$a_item)
Parse item data for list entries.
Definition: class.ilObjectActivation.php:340
Here is the call graph for this function:
◆ cloneDependencies()
| ilObjFolder::cloneDependencies | ( | $a_target_id, | |
| $a_copy_id | |||
| ) |
Clone object dependencies (crs items, preconditions)
public
- Parameters
-
int target ref id of new course int copy id
Definition at line 110 of file class.ilObjFolder.php.
References ilObjectActivation\cloneDependencies(), and ilObject\getRefId().
static cloneDependencies($a_ref_id, $a_target_id, $a_copy_id)
Clone dependencies.
Definition: class.ilObjectActivation.php:559
Here is the call graph for this function:
◆ cloneObject()
| ilObjFolder::cloneObject | ( | $a_target_id, | |
$a_copy_id = 0, |
|||
$a_omit_tree = false |
|||
| ) |
Clone folder.
public
- Parameters
-
int target id int copy id
Definition at line 64 of file class.ilObjFolder.php.
References ilObject\getId().
Definition: class.ilLPObjSettings.php:14
Here is the call graph for this function:
◆ downloadFolder()
| ilObjFolder::downloadFolder | ( | ) |
Definition at line 163 of file class.ilObjFolder.php.
References ilObject\$lng, ilObject\_isInTrash(), ilUtil\delDir(), ilUtil\deliverFile(), ilObject\getRefId(), ilObject\getTitle(), ilUtil\ilTempnam(), ilUtil\makeDir(), recurseFolder(), ilUtil\sendInfo(), and ilUtil\zip().
169 $this->ilErr->raiseError(get_class($this)."::downloadFolder(): missing read permission!",$this->ilErr->WARNING);
173 $this->ilErr->raiseError(get_class($this)."::downloadFolder(): object is trashed!",$this->ilErr->WARNING);
static sendInfo($a_info="", $a_keep=false)
Send Info Message to Screen.
Definition: class.ilUtil.php:4757
static recurseFolder($refid, $title, $tmpdir)
private functions which iterates through all folders and files and create an according file structure...
Definition: class.ilObjFolder.php:128
static deliverFile($a_file, $a_filename, $a_mime='', $isInline=false, $removeAfterDelivery=false, $a_exit_after=true)
deliver file for download via browser.
Definition: class.ilUtil.php:2178
static zip($a_dir, $a_file, $compress_content=false)
zips given directory/file into given zip.file
Definition: class.ilUtil.php:1870
static makeDir($a_dir)
creates a new directory and inherits all filesystem permissions of the parent directory You may pass ...
Definition: class.ilUtil.php:2394
static ilTempnam($a_temp_path=null)
Create a temporary file in an ILIAS writable directory.
Definition: class.ilUtil.php:1696
static delDir($a_dir, $a_clean_only=false)
removes a dir and all its content (subdirs and files) recursively
Definition: class.ilUtil.php:2501
Here is the call graph for this function:
◆ getViewMode()
| ilObjFolder::getViewMode | ( | ) |
Get container view mode.
Definition at line 198 of file class.ilObjFolder.php.
References ilObject\_lookupObjId(), ilObjCourseAccess\_lookupViewMode(), ilContainer\VIEW_BY_TYPE, ilContainer\VIEW_SESSIONS, and ilContainer\VIEW_SIMPLE.
Here is the call graph for this function:
◆ putInTree()
| ilObjFolder::putInTree | ( | $a_parent | ) |
insert folder into grp_tree
Definition at line 81 of file class.ilObjFolder.php.
References ilObject\getId(), ilObject\getRefId(), and ilObject\withReferences().
withReferences()
determines wehter objects are referenced or not (got ref ids or not)
Definition: class.ilObject.php:144
Here is the call graph for this function:
◆ read()
| ilObjFolder::read | ( | ) |
Overwritten read method.
public
- Parameters
-
Definition at line 243 of file class.ilObjFolder.php.
References ilContainerSortingSettings\_lookupSortMode(), ilObject\getId(), and ilContainer\setOrderType().
static _lookupSortMode($a_obj_id)
lookup sort mode
Definition: class.ilContainerSortingSettings.php:170
Here is the call graph for this function:
◆ recurseFolder()
|
staticprivate |
private functions which iterates through all folders and files and create an according file structure in a temporary directory.
This function works recursive.
- Parameters
-
integer $refid reference it tmpdictory $tmpdir
- Returns
- returns first created directory
Definition at line 128 of file class.ilObjFolder.php.
References ilObject\$title, ilObject\_isInTrash(), ilObjFile\_lookupAbsolutePath(), array, and ilUtil\makeDir().
Referenced by ilObjWorkspaceFolder\downloadFolder(), downloadFolder(), and ilObjWorkspaceFolder\recurseFolder().
static recurseFolder($refid, $title, $tmpdir)
private functions which iterates through all folders and files and create an according file structure...
Definition: class.ilObjFolder.php:128
static makeDir($a_dir)
creates a new directory and inherits all filesystem permissions of the parent directory You may pass ...
Definition: class.ilUtil.php:2394
static _lookupAbsolutePath($obj_id, $a_version=null)
return absolute path for version
Definition: class.ilObjFile.php:1123
Here is the call graph for this function:
Here is the caller graph for this function:
◆ setFolderTree()
| ilObjFolder::setFolderTree | ( | $a_tree | ) |
Definition at line 51 of file class.ilObjFolder.php.
Field Documentation
◆ $folder_tree
| ilObjFolder::$folder_tree |
Definition at line 36 of file class.ilObjFolder.php.
The documentation for this class was generated from the following file:
- Modules/Folder/classes/class.ilObjFolder.php
