Inheritance diagram for ilObjFileAccessSettings:

Collaboration diagram for ilObjFileAccessSettings:

Public Member Functions
	ilObjFileAccessSettings ($a_id=0, $a_call_by_reference=true)
	Constructor.
	setWebdavEnabled ($newValue)
	Sets the webdavEnabled property.
	isWebdavEnabled ()
	Gets the webdavEnabled property.
	setWebdavActionsVisible ($newValue)
	Sets the webdavActionsVisible property.
	isWebdavActionsVisible ()
	Gets the webdavActionsVisible property.
	setCustomWebfolderInstructions ($newValue)
	Sets the customWebfolderInstructions property.
	getCustomWebfolderInstructions ()
	Gets the customWebfolderInstructions property.
	getDefaultWebfolderInstructions ()
	Gets the defaultWebfolderInstructions property.
	isCustomWebfolderInstructionsEnabled ()
	Gets the customWebfolderInstructionsEnabled property.
	setCustomWebfolderInstructionsEnabled ($newValue)
	Sets the customWebfolderInstructionsEnabled property.
	setInlineFileExtensions ($newValue)
	Sets the inlineFileExtensions property.
	getInlineFileExtensions ()
	Gets the inlineFileExtensions property.
	setDownloadWithUploadedFilename ($newValue)
	Sets the downloadWithUploadedFilename property.
	isDownloadWithUploadedFilename ()
	Gets the downloadWithUploadedFilename property.
	create ()
	create
	update ()
	update object in db
	read ($a_force_db=false)
	read object data from db into object
Public Member Functions inherited from ilObject
	ilObject ($a_id=0, $a_reference=true)
	Constructor public.
	withReferences ()
	determines wehter objects are referenced or not (got ref ids or not)
	getId ()
	get object id public
	setId ($a_id)
	set object id public
	setRefId ($a_id)
	set reference id public
	getRefId ()
	get reference id public
	getType ()
	get object type public
	setType ($a_type)
	set object type public
	getPresentationTitle ()
	get presentation title Normally same as title Overwritten for sessions
	getTitle ()
	get object title public
	getUntranslatedTitle ()
	get untranslated object title public
	setTitle ($a_title)
	set object title
	getDescription ()
	get object description
	setDescription ($a_desc)
	set object description
	getLongDescription ()
	get object long description (stored in object_description)
	getImportId ()
	get import id
	setImportId ($a_import_id)
	set import id
	getOwner ()
	get object owner
	getOwnerName ()
	_lookupOwnerName ($a_owner_id)
	lookup owner name for owner id
	setOwner ($a_owner)
	set object owner
	getCreateDate ()
	get create date public
	getLastUpdateDate ()
	get last update date public
	getDiskUsage ()
	Gets the disk usage of the object in bytes.
	setObjDataRecord ($a_record)
	set object_data record (note: this method should only be called from the ilObjectFactory class)
	MDUpdateListener ($a_element)
	Meta data update listener.
	createMetaData ()
	create meta data entry
	updateMetaData ()
	update meta data entry
	deleteMetaData ()
	delete meta data entry
	updateOwner ()
	update owner of object in db
	_getIdForImportId ($a_import_id)
	get current object id for import id (static)
	_lookupOwner ($a_id)
	lookup object owner
	_lookupLastUpdate ($a_id, $a_as_string=false)
	lookup last update
	_getLastUpdateOfObjects ($a_objs)
	Get last update for a set of media objects.
	_setDeletedDate ($a_ref_id)
	only called in ilTree::saveSubTree
	_resetDeletedDate ($a_ref_id)
	only called in ilObjectGUI::insertSavedNodes
	_lookupDeletedDate ($a_ref_id)
	only called in ilObjectGUI::insertSavedNodes
	_writeTitle ($a_obj_id, $a_title)
	write title to db (static)
	_writeDescription ($a_obj_id, $a_desc)
	write description to db (static)
	_writeImportId ($a_obj_id, $a_import_id)
	write import id to db (static)
	_isInTrash ($a_ref_id)
	checks wether object is in trash
	_hasUntrashedReference ($a_obj_id)
	checks wether an object has at least one reference that is not in trash
	_lookupObjectId ($a_ref_id)
	lookup object id
	_getObjectsDataForType ($a_type, $a_omit_trash=false)
	get all objects of a certain type
	putInTree ($a_parent_ref)
	maybe this method should be in tree object!?
	setPermissions ($a_parent_ref)
	set permissions of object
	createReference ()
	creates reference for object
	countReferences ()
	count references of object
	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!!
	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
	createRoleFolder ()
	creates a local role folder
	applyDidacticTemplate ($a_tpl_id)
	Apply template.
	notify ($a_event, $a_ref_id, $a_parent_non_rbac_id, $a_node_id, $a_params=0)
	notifys an object about an event occured Based on the event passed, each object may decide how it reacts.
	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 ...
	appendCopyInfo ($a_target_id, $a_copy_id)
	Prepend Copy info if object with same name exists in that container.
	cloneDependencies ($a_target_id, $a_copy_id)
	Clone object dependencies.
	cloneMetaData ($target_obj)
	Copy meta data.

Private Member Functions
	write ()
	write object data into db

Private Attributes
	$webdavEnabled
	Boolean property.
	$webdavActionsVisible
	Boolean property.
	$customWebfolderInstructionsEnabled
	Boolean property.
	$customWebfolderInstructions
	String property.
	$inlineFileExtensions
	String property.
	$downloadWithUploadedFilename
	Boolean property.

Additional Inherited Members
Static Public Member Functions inherited from ilObject
static	_lookupObjIdByImportId ($a_import_id)
static	_getAllReferences ($a_id)
	get all reference ids of object
static	_lookupTitle ($a_id)
	lookup object title
static	_getIdsForTitle ($title, $type= '', $partialmatch=false)
static	_lookupDescription ($a_id)
	lookup object description
static	_lookupObjId ($a_id)
static	_lookupType ($a_id, $a_reference=false)
	lookup object type
	_exists ($a_id, $a_reference=false)
	checks if an object exists in object_data
static	_getObjectsByType ($a_obj_type="", $a_owner="")
	Get objects by type.
static	_prepareCloneSelection ($a_ref_ids, $new_type, $show_path=true)
	Prepare copy wizard object selection.
static	_getIcon ($a_obj_id="", $a_size="big", $a_type="", $a_offline=false)
	Get icon for repository item.
static	collectDeletionDependencies (&$deps, $a_ref_id, $a_obj_id, $a_type, $a_depth=0)
	Collect deletion dependencies.
static	getDeletionDependencies ($a_obj_id)
	Get deletion dependencies.
Data Fields inherited from ilObject
const	TITLE_LENGTH = 128
	max length of object title
	$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
	$obj_data_record
	object_data record

Detailed Description

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

Member Function Documentation

ilObjFileAccessSettings::create ( )

create

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

Returns: integer object id

Reimplemented from ilObject.

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

References write().

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

Here is the call graph for this function:

ilObjFileAccessSettings::getCustomWebfolderInstructions ( )

Gets the customWebfolderInstructions property.

Returns: boolean value

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

References $customWebfolderInstructions, and ilDAVServer\_getDefaultWebfolderInstructions().

        {
                if (strlen($this->customWebfolderInstructions) == 0) 
                {
                        require_once 'Services/WebDAV/classes/class.ilDAVServer.php';
                        $this->customWebfolderInstructions = ilDAVServer::_getDefaultWebfolderInstructions();
                }
                return $this->customWebfolderInstructions;
        }

Here is the call graph for this function:

ilObjFileAccessSettings::getDefaultWebfolderInstructions ( )

Gets the defaultWebfolderInstructions property.

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

Returns: String value

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

References ilDAVServer\_getDefaultWebfolderInstructions().

        {
                return ilDAVServer::_getDefaultWebfolderInstructions();
        }

Here is the call graph for this function:

ilObjFileAccessSettings::getInlineFileExtensions ( )

Gets the inlineFileExtensions property.

Returns: boolean value

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

References $inlineFileExtensions.

        {
                return $this->inlineFileExtensions;
        }

ilObjFileAccessSettings::ilObjFileAccessSettings	(	$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 87 of file class.ilObjFileAccessSettings.php.

References ilObject\ilObject().

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

Here is the call graph for this function:

ilObjFileAccessSettings::isCustomWebfolderInstructionsEnabled ( )

Gets the customWebfolderInstructionsEnabled property.

Returns: boolean value

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

References $customWebfolderInstructionsEnabled.

        {
                return $this->customWebfolderInstructionsEnabled;
        }

ilObjFileAccessSettings::isDownloadWithUploadedFilename ( )

Gets the downloadWithUploadedFilename property.

Returns: boolean value

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

References $downloadWithUploadedFilename.

        {
                return $this->downloadWithUploadedFilename;
        }

ilObjFileAccessSettings::isWebdavActionsVisible ( )

Gets the webdavActionsVisible property.

Returns: boolean value

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

References $webdavActionsVisible.

        {
                return $this->webdavActionsVisible;
        }

ilObjFileAccessSettings::isWebdavEnabled ( )

Gets the webdavEnabled property.

Returns: boolean value

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

References $webdavEnabled.

        {
                return $this->webdavEnabled;
        }

ilObjFileAccessSettings::read ( $a_force_db = false )

read object data from db into object

Parameters

boolean

Reimplemented from ilObject.

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

        {
                parent::read($a_force_db);
                global $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->customWebfolderInstructions = $settings->get('custom_webfolder_instructions', '');
        }

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 143 of file class.ilObjFileAccessSettings.php.

        {
                $this->customWebfolderInstructions = $newValue;
        }

ilObjFileAccessSettings::setCustomWebfolderInstructionsEnabled ( $newValue )

Sets the customWebfolderInstructionsEnabled property.

Parameters

boolean new value.

Returns: void

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

        {
                $this->customWebfolderInstructionsEnabled = $newValue;
        }

ilObjFileAccessSettings::setDownloadWithUploadedFilename ( $newValue )

Sets the downloadWithUploadedFilename property.

Parameters

boolean

Returns: void

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

        {
                $this->downloadWithUploadedFilename = $newValue;
        }

ilObjFileAccessSettings::setInlineFileExtensions ( $newValue )

Sets the inlineFileExtensions property.

Parameters

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

Returns: void

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

        {
                $this->inlineFileExtensions = $newValue;
        }

ilObjFileAccessSettings::setWebdavActionsVisible ( $newValue )

Sets the webdavActionsVisible property.

Parameters

boolean new value

Returns: void

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

        {
                $this->webdavActionsVisible = $newValue;
        }

ilObjFileAccessSettings::setWebdavEnabled ( $newValue )

Sets the webdavEnabled property.

Parameters

boolean new value

Returns: void

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

        {
                $this->webdavEnabled = $newValue;
        }

ilObjFileAccessSettings::update ( )

update object in db

Returns: boolean true on success

Reimplemented from ilObject.

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

References write().

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

Here is the call graph for this function:

ilObjFileAccessSettings::write ( )

private

write object data into db

Parameters

boolean

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

References $ilErr.

Referenced by create(), and update().

        {
                global $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 $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

ilObjFileAccessSettings::$customWebfolderInstructions

private

String property.

Customized mount instructions for WebDAV access to files.

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

Referenced by getCustomWebfolderInstructions().

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 57 of file class.ilObjFileAccessSettings.php.

Referenced by isCustomWebfolderInstructionsEnabled().

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 79 of file class.ilObjFileAccessSettings.php.

Referenced by isDownloadWithUploadedFilename().

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 69 of file class.ilObjFileAccessSettings.php.

Referenced by getInlineFileExtensions().

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().

ilObjFileAccessSettings::$webdavEnabled

private

Boolean property.

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