ilFMSettings Class Reference

File Manager settings. More...

Collaboration diagram for ilFMSettings:

Public Member Functions
	enable ($a_status)
	Enable file manager. More...
	isEnabled ()
	check if enabled More...
	enableLocalFS ($a_stat)
	Enable local file system frame. More...
	isLocalFSEnabled ()
	Check if local file system frame is enabled by default. More...
	setMaxFileSize ($a_size)
	getMaxFileSize ()
	update ()
	Update settings. More...

Static Public Member Functions
static	getInstance ()
	Get singleton instance. More...

Protected Member Functions
	getStorage ()
	Get storage. More...
	read ()
	Read settings. More...

Private Member Functions
	__construct ()
	Singleton constructor. More...

Private Attributes
	$storage = null
	$enabled = false
	$localFS = true
	$maxFileSize = 64

Static Private Attributes
static	$instance = null

Detailed Description

File Manager settings.

Author

Stefan Meyer meyer.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

Definition at line 9 of file class.ilFMSettings.php.

Constructor & Destructor Documentation

__construct()

ilFMSettings::__construct ( )

private

Singleton constructor.

Definition at line 21 of file class.ilFMSettings.php.

        {
                $this->storage = new ilSetting('fm');
                $this->read();
        }

References read().

Here is the call graph for this function:

Member Function Documentation

enable()

ilFMSettings::enable

(

$a_status

)

Enable file manager.

Parameters

bool

$a_status

Definition at line 53 of file class.ilFMSettings.php.

        {
                $this->enabled = $a_status;
        }

Referenced by read().

Here is the caller graph for this function:

enableLocalFS()

ilFMSettings::enableLocalFS

(

$a_stat

)

Enable local file system frame.

Parameters

<type>

$a_stat

Definition at line 71 of file class.ilFMSettings.php.

        {
                $this->localFS = $a_stat;
        }

Referenced by read().

Here is the caller graph for this function:

getInstance()

static ilFMSettings::getInstance ( )

static

Get singleton instance.

Returns

ilFMSettings

Definition at line 31 of file class.ilFMSettings.php.

        {
                if(self::$instance)
                {
                        return self::$instance;
                }
                return self::$instance = new ilFMSettings();
        }

References $instance.

Referenced by ilObjCategoryAccess\_getCommands(), ilObjCourseAccess\_getCommands(), ilObjFolderAccess\_getCommands(), ilObjGroupAccess\_getCommands(), ilContainerGUI\fileManagerLaunchObject(), ilSoapObjectAdministration\getTreeChilds(), ilContainerGUI\initHeaderAction(), ilFMSettingsGUI\initSettingsForm(), and ilFMSettingsGUI\update().

Here is the caller graph for this function:

getMaxFileSize()

ilFMSettings::getMaxFileSize

(

)

Definition at line 90 of file class.ilFMSettings.php.

        {
                return $this->maxFileSize;
        }

References $maxFileSize.

Referenced by update().

Here is the caller graph for this function:

getStorage()

ilFMSettings::getStorage ( )

protected

Get storage.

Returns

ilSetting

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

        {
                return $this->storage;
        }

References $storage.

Referenced by read(), and update().

Here is the caller graph for this function:

isEnabled()

ilFMSettings::isEnabled

(

)

check if enabled

Returns

bool

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

        {
                return $this->enabled;
        }

References $enabled.

Referenced by update().

Here is the caller graph for this function:

isLocalFSEnabled()

ilFMSettings::isLocalFSEnabled

(

)

Check if local file system frame is enabled by default.

Returns

<type>

Definition at line 80 of file class.ilFMSettings.php.

        {
                return $this->localFS;
        }

References $localFS.

Referenced by update().

Here is the caller graph for this function:

read()

ilFMSettings::read ( )

protected

Read settings.

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

        {
                $this->enable($this->getStorage()->get('enabled', $this->enabled));
                $this->enableLocalFS($this->getStorage()->get('local'), $this->localFS);
                $this->setMaxFileSize($this->getStorage()->get('maxFileSize',$this->maxFileSize));
                
        }

References enable(), enableLocalFS(), getStorage(), and setMaxFileSize().

Referenced by __construct().

Here is the call graph for this function:

Here is the caller graph for this function:

setMaxFileSize()

ilFMSettings::setMaxFileSize

(

$a_size

)

Definition at line 85 of file class.ilFMSettings.php.

        {
                $this->maxFileSize = $a_size;
        }

Referenced by read().

Here is the caller graph for this function:

update()

ilFMSettings::update

(

)

Update settings.

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

        {
                $this->getStorage()->set('enabled',(int) $this->isEnabled());
                $this->getStorage()->set('local',(int) $this->isLocalFSEnabled());
                $this->getStorage()->set('maxFileSize', (int) $this->getMaxFileSize());
        }

References getMaxFileSize(), getStorage(), isEnabled(), and isLocalFSEnabled().

Here is the call graph for this function:

Field Documentation

$enabled

ilFMSettings::$enabled = false

private

Definition at line 14 of file class.ilFMSettings.php.

Referenced by isEnabled().

$instance

ilFMSettings::$instance = null

staticprivate

Definition at line 11 of file class.ilFMSettings.php.

Referenced by getInstance().

$localFS

ilFMSettings::$localFS = true

private

Definition at line 15 of file class.ilFMSettings.php.

Referenced by isLocalFSEnabled().

$maxFileSize

ilFMSettings::$maxFileSize = 64

private

Definition at line 16 of file class.ilFMSettings.php.

Referenced by getMaxFileSize().

$storage

ilFMSettings::$storage = null

private

Definition at line 13 of file class.ilFMSettings.php.

Referenced by getStorage().

---

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

• Services/WebServices/FileManager/classes/class.ilFMSettings.php