Inheritance diagram for ilObjFileAccessSettings:

Collaboration diagram for ilObjFileAccessSettings:

Public Member Functions
	__construct ($a_id=0, $a_call_by_reference=true)
	Constructor. More...

	setWebdavEnabled ($newValue)
	Sets the webdavEnabled property. More...

	isWebdavEnabled ()
	Gets the webdavEnabled property. More...

	setWebdavActionsVisible ($newValue)
	Sets the webdavActionsVisible property. More...

	isWebdavActionsVisible ()
	Gets the webdavActionsVisible property. More...

	setCustomWebfolderInstructions ($newValue)
	Sets the customWebfolderInstructions property. More...

	getCustomWebfolderInstructions ()
	Gets the customWebfolderInstructions property. More...

	getDefaultWebfolderInstructions ()
	Gets the defaultWebfolderInstructions property. More...

	isCustomWebfolderInstructionsEnabled ()
	Gets the customWebfolderInstructionsEnabled property. More...

	setCustomWebfolderInstructionsEnabled ($newValue)
	Sets the customWebfolderInstructionsEnabled property. More...

	setInlineFileExtensions ($newValue)
	Sets the inlineFileExtensions property. More...

	getInlineFileExtensions ()
	Gets the inlineFileExtensions property. More...

	setDownloadWithUploadedFilename ($newValue)
	Sets the downloadWithUploadedFilename property. More...

	isDownloadWithUploadedFilename ()
	Gets the downloadWithUploadedFilename property. More...

	create ()
	create More...

	update ()
	update object in db More...

	read ()
	read object data from db into object 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...

	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	_getDefaultWebfolderInstructions ()
	TODO: Check if needed and refactor. 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)
	only called in ilTree::saveSubTree More...

static	setDeletedDates ($a_ref_ids)
	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	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...

Private Member Functions
	write ()
	write object data into db More...

	getUploadMaxFilesize ()
	TODO: Check if needed and refactor. More...

Private Attributes
	$webdavEnabled
	Boolean property. More...

	$webdavActionsVisible
	Boolean property. More...

	$customWebfolderInstructionsEnabled
	Boolean property. More...

	$customWebfolderInstructions
	String property. More...

	$inlineFileExtensions
	String property. More...

	$downloadWithUploadedFilename
	Boolean property. More...

Additional Inherited Members
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 Attributes inherited from ilObject
	$objDefinition

	$db

	$log

	$error

	$tree

	$app_event_handler

	$rbacadmin

	$rbacreview

Detailed Description

Definition at line 41 of file class.ilObjFileAccessSettings.php.

Constructor & Destructor Documentation

◆ __construct()

ilObjFileAccessSettings::__construct	(	$a_id = `0`,
		$a_call_by_reference = `true`
	)

Constructor.

Parameters

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

Definition at line 84 of file class.ilObjFileAccessSettings.php.

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

Member Function Documentation

◆ _getDefaultWebfolderInstructions()

static ilObjFileAccessSettings::_getDefaultWebfolderInstructions ( )

static

TODO: Check if needed and refactor.

Gets instructions for the usage of webfolders.

The instructions consist of HTML text with placeholders. See _getWebfolderInstructionsFor for a description of the supported placeholders.

Returns: String HTML text with placeholders.

Definition at line 350 of file class.ilObjFileAccessSettings.php.

References ilObject\$lng.

     {
         global $lng;
 
         return $lng->txt('webfolder_instructions_text');
     }

◆ create()

ilObjFileAccessSettings::create ( )

create

note: title, description and type should be set when this function is called

Returns: integer object id

Definition at line 262 of file class.ilObjFileAccessSettings.php.

References write().

     {
         parent::create();
         $this->write();
     }

Here is the call graph for this function:

◆ getCustomWebfolderInstructions()

ilObjFileAccessSettings::getCustomWebfolderInstructions ( )

Gets the customWebfolderInstructions property.

Returns: boolean value

Definition at line 161 of file class.ilObjFileAccessSettings.php.

References $customWebfolderInstructions.

     {
         if (strlen($this->customWebfolderInstructions) == 0) {
             $this->customWebfolderInstructions = self::_getDefaultWebfolderInstructions();
         }
 
         return $this->customWebfolderInstructions;
     }

◆ getDefaultWebfolderInstructions()

ilObjFileAccessSettings::getDefaultWebfolderInstructions ( )

Gets the defaultWebfolderInstructions property.

This is a read only property. The text is retrieved from $lng.

Returns: String value

Definition at line 177 of file class.ilObjFileAccessSettings.php.

     {
         return self::_getDefaultWebfolderInstructions();
     }

◆ getInlineFileExtensions()

ilObjFileAccessSettings::getInlineFileExtensions ( )

Gets the inlineFileExtensions property.

Returns: boolean value

Definition at line 225 of file class.ilObjFileAccessSettings.php.

References $inlineFileExtensions.

     {
         return $this->inlineFileExtensions;
     }

◆ getUploadMaxFilesize()

ilObjFileAccessSettings::getUploadMaxFilesize ( )

private

TODO: Check if needed and refactor.

Gets the maximum permitted upload filesize from php.ini in bytes.

Returns: int Upload Max Filesize in bytes.

Definition at line 365 of file class.ilObjFileAccessSettings.php.

     {
         $val = ini_get('upload_max_filesize');
 
         $val = trim($val);
         $last = strtolower($val[strlen($val) - 1]);
         switch ($last) {
             // The 'G' modifier is available since PHP 5.1.0
             case 'g':
                 $val *= 1024;
                 // no break
             case 'm':
                 $val *= 1024;
                 // no break
             case 'k':
                 $val *= 1024;
         }
 
         return $val;
     }

◆ isCustomWebfolderInstructionsEnabled()

ilObjFileAccessSettings::isCustomWebfolderInstructionsEnabled ( )

Gets the customWebfolderInstructionsEnabled property.

Returns: boolean value

Definition at line 188 of file class.ilObjFileAccessSettings.php.

References $customWebfolderInstructionsEnabled.

     {
         return $this->customWebfolderInstructionsEnabled;
     }

◆ isDownloadWithUploadedFilename()

ilObjFileAccessSettings::isDownloadWithUploadedFilename ( )

Gets the downloadWithUploadedFilename property.

Returns: boolean value

Definition at line 249 of file class.ilObjFileAccessSettings.php.

References $downloadWithUploadedFilename.

     {
         return $this->downloadWithUploadedFilename;
     }

◆ isWebdavActionsVisible()

ilObjFileAccessSettings::isWebdavActionsVisible ( )

Gets the webdavActionsVisible property.

Returns: boolean value

Definition at line 133 of file class.ilObjFileAccessSettings.php.

References $webdavActionsVisible.

     {
         return $this->webdavActionsVisible;
     }

◆ isWebdavEnabled()

ilObjFileAccessSettings::isWebdavEnabled ( )

Gets the webdavEnabled property.

Returns: boolean value

Definition at line 109 of file class.ilObjFileAccessSettings.php.

References $webdavEnabled.

     {
         return $this->webdavEnabled;
     }

◆ read()

ilObjFileAccessSettings::read ( )

read object data from db into object

Definition at line 319 of file class.ilObjFileAccessSettings.php.

References $DIC.

     {
         parent::read();
 
         global $DIC;
         $ilClientIniFile = $DIC['ilClientIniFile'];
         $this->webdavEnabled = $ilClientIniFile->readVariable('file_access', 'webdav_enabled') == '1';
         $this->webdavActionsVisible = $ilClientIniFile->readVariable('file_access', 'webdav_actions_visible') == '1';
         $this->downloadWithUploadedFilename = $ilClientIniFile->readVariable('file_access', 'download_with_uploaded_filename') == '1';
         $ilClientIniFile->ERROR = false;
 
         require_once 'Services/Administration/classes/class.ilSetting.php';
         $settings = new ilSetting('file_access');
         $this->inlineFileExtensions = $settings->get('inline_file_extensions', '');
         $this->customWebfolderInstructionsEnabled = $settings->get('custom_webfolder_instructions_enabled', '0') == '1';
         //$this->webdavSpecialCharsHandling = $settings->get('');
         $this->customWebfolderInstructions = $settings->get('custom_webfolder_instructions', '');
     }

◆ setCustomWebfolderInstructions()

ilObjFileAccessSettings::setCustomWebfolderInstructions ( $newValue )

Sets the customWebfolderInstructions property.

The webfolder instructions consist of HTML text, with placeholders. See ilDAVServer::_getWebfolderInstructionsFor for a description of the supported placeholders.

Parameters

string HTML text with placeholders.

Returns: void

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

     {
         $this->customWebfolderInstructions = $newValue;
     }

◆ setCustomWebfolderInstructionsEnabled()

ilObjFileAccessSettings::setCustomWebfolderInstructionsEnabled ( $newValue )

Sets the customWebfolderInstructionsEnabled property.

Parameters

boolean new value.

Returns: void

Definition at line 201 of file class.ilObjFileAccessSettings.php.

     {
         $this->customWebfolderInstructionsEnabled = $newValue;
     }

◆ setDownloadWithUploadedFilename()

ilObjFileAccessSettings::setDownloadWithUploadedFilename ( $newValue )

Sets the downloadWithUploadedFilename property.

Parameters

boolean

Returns: void

Definition at line 238 of file class.ilObjFileAccessSettings.php.

     {
         $this->downloadWithUploadedFilename = $newValue;
     }

◆ setInlineFileExtensions()

ilObjFileAccessSettings::setInlineFileExtensions ( $newValue )

Sets the inlineFileExtensions property.

Parameters

string new value, a space separated list of filename extensions.

Returns: void

Definition at line 214 of file class.ilObjFileAccessSettings.php.

     {
         $this->inlineFileExtensions = $newValue;
     }

◆ setWebdavActionsVisible()

ilObjFileAccessSettings::setWebdavActionsVisible ( $newValue )

Sets the webdavActionsVisible property.

Parameters

boolean new value

Returns: void

Definition at line 122 of file class.ilObjFileAccessSettings.php.

     {
         $this->webdavActionsVisible = $newValue;
     }

◆ setWebdavEnabled()

ilObjFileAccessSettings::setWebdavEnabled ( $newValue )

Sets the webdavEnabled property.

Parameters

boolean new value

Returns: void

Definition at line 98 of file class.ilObjFileAccessSettings.php.

     {
         $this->webdavEnabled = $newValue;
     }

◆ update()

ilObjFileAccessSettings::update ( )

update object in db

Returns: boolean true on success

Definition at line 274 of file class.ilObjFileAccessSettings.php.

References League\Flysystem\Adapter\Polyfill\update(), and write().

     {
         parent::update();
         $this->write();
     }

Here is the call graph for this function:

◆ write()

ilObjFileAccessSettings::write ( )

private

write object data into db

Parameters

boolean

Definition at line 286 of file class.ilObjFileAccessSettings.php.

References $DIC, and $ilErr.

Referenced by create(), and update().

     {
         global $DIC;
         $ilClientIniFile = $DIC['ilClientIniFile'];
 
         // Clear any old error messages
         $ilClientIniFile->error(null);
 
         if (!$ilClientIniFile->groupExists('file_access')) {
             $ilClientIniFile->addGroup('file_access');
         }
         $ilClientIniFile->setVariable('file_access', 'webdav_enabled', $this->webdavEnabled ? '1' : '0');
         $ilClientIniFile->setVariable('file_access', 'webdav_actions_visible', $this->webdavActionsVisible ? '1' : '0');
         $ilClientIniFile->setVariable('file_access', 'download_with_uploaded_filename', $this->downloadWithUploadedFilename ? '1' : '0');
         $ilClientIniFile->write();
 
         if ($ilClientIniFile->getError()) {
             global $DIC;
             $ilErr = $DIC['ilErr'];
             $ilErr->raiseError($ilClientIniFile->getError(), $ilErr->WARNING);
         }
 
         require_once 'Services/Administration/classes/class.ilSetting.php';
         $settings = new ilSetting('file_access');
         $settings->set('inline_file_extensions', $this->inlineFileExtensions);
         $settings->set('custom_webfolder_instructions_enabled', $this->customWebfolderInstructionsEnabled ? '1' : '0');
         $settings->set('custom_webfolder_instructions', $this->customWebfolderInstructions);
     }

Here is the caller graph for this function:

Field Documentation

◆ $customWebfolderInstructions

ilObjFileAccessSettings::$customWebfolderInstructions

private

String property.

Customized mount instructions for WebDAV access to files.

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

Referenced by getCustomWebfolderInstructions().

◆ $customWebfolderInstructionsEnabled

ilObjFileAccessSettings::$customWebfolderInstructionsEnabled

private

Boolean property.

Set this to true, to use customized mount instructions. If the value is false, the default mount instructions are used.

Definition at line 56 of file class.ilObjFileAccessSettings.php.

Referenced by isCustomWebfolderInstructionsEnabled().

◆ $downloadWithUploadedFilename

ilObjFileAccessSettings::$downloadWithUploadedFilename

private

Boolean property.

If this variable is true, the filename of downloaded files is the same as the filename of the uploaded file.

If this variable is false, the filename of downloaded files is the title of the file object.

Definition at line 75 of file class.ilObjFileAccessSettings.php.

Referenced by isDownloadWithUploadedFilename().

◆ $inlineFileExtensions

ilObjFileAccessSettings::$inlineFileExtensions

private

String property.

Contains a list of file extensions separated by space. Files with a matching extension are displayed inline in the browser. Non-matching files are offered for download to the user.

Definition at line 66 of file class.ilObjFileAccessSettings.php.

Referenced by getInlineFileExtensions().

◆ $webdavActionsVisible

ilObjFileAccessSettings::$webdavActionsVisible

private

Boolean property.

Set this to true, to make WebDAV item actions visible for repository items.

Definition at line 51 of file class.ilObjFileAccessSettings.php.

Referenced by isWebdavActionsVisible().

◆ $webdavEnabled

ilObjFileAccessSettings::$webdavEnabled

private

Boolean property.

Set this to true, to enable WebDAV access to files.

Definition at line 47 of file class.ilObjFileAccessSettings.php.

Referenced by isWebdavEnabled().

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

Modules/File/classes/class.ilObjFileAccessSettings.php

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _getDefaultWebfolderInstructions()

◆ create()

◆ getCustomWebfolderInstructions()

◆ getDefaultWebfolderInstructions()

◆ getInlineFileExtensions()

◆ getUploadMaxFilesize()

◆ isCustomWebfolderInstructionsEnabled()

◆ isDownloadWithUploadedFilename()

◆ isWebdavActionsVisible()

◆ isWebdavEnabled()

◆ read()

◆ setCustomWebfolderInstructions()

◆ setCustomWebfolderInstructionsEnabled()

◆ setDownloadWithUploadedFilename()

◆ setInlineFileExtensions()

◆ setWebdavActionsVisible()

◆ setWebdavEnabled()

◆ update()

◆ write()

Field Documentation

◆ $customWebfolderInstructions

◆ $customWebfolderInstructionsEnabled

◆ $downloadWithUploadedFilename

◆ $inlineFileExtensions

◆ $webdavActionsVisible

◆ $webdavEnabled