Inheritance diagram for ilObjDiskQuotaSettings:

Collaboration diagram for ilObjDiskQuotaSettings:

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

	setDiskQuotaEnabled ($newValue)
	Sets the diskQuotaEnabled property. More...

	isDiskQuotaEnabled ()
	Gets the diskQuotaEnabled property. More...

	setDiskQuotaReminderMailEnabled ($newValue)
	Sets the diskQuotaReminderMailEnabled property. More...

	isDiskQuotaReminderMailEnabled ()
	Gets the diskQuotaReminderMailEnabled property. More...

	create ()
	create More...

	update ()
	update object in db More...

	read ()
	read object data from db into object More...

	_writeReminderMailTemplate ($a_lang, $a_subject, $a_sal_g, $a_sal_f, $a_sal_m, $a_body)

	setSummaryRecipients ($s_recipients)
	Setter for summary recipients. More...

	getSummaryRecipients ()
	Getter fpr summary recipients. More...

	isDiskQuotaSummaryMailEnabled ($status=null)
	Setter/Getter to activate/deactivate the summary mail cron job. More...

	setPersonalWorkspaceDiskQuotaEnabled ($newValue)
	Sets the personalWorkspaceDiskQuotaEnabled property. More...

	isPersonalWorkspaceDiskQuotaEnabled ()
	Gets the personalWorkspaceDiskQuotaEnabled property. More...

Public Member Functions inherited from ilObject
	__construct ($a_id=0, $a_reference=true)
	Constructor @access 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 @access public More...

	setId ($a_id)
	set object id @access public More...

	setRefId ($a_id)
	set reference id @access public More...

	getRefId ()
	get reference id @access public More...

	getType ()
	get object type @access public More...

	setType ($a_type)
	set object type @access public More...

	getPresentationTitle ()
	get presentation title Normally same as title Overwritten for sessions More...

	getTitle ()
	get object title @access public More...

	getUntranslatedTitle ()
	get untranslated object title @access 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 @access public More...

	getLastUpdateDate ()
	get last update date @access 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) @access 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	getInstance ()
	Get settings instance. More...

static	_lookupReminderMailTemplate ($a_lang)
	Looks up the mail template for the specified language. 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@access public 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...

Private Attributes
	$diskQuotaEnabled
	Boolean property. More...

	$diskQuotaReminderMailEnabled
	Boolean property. More...

	$diskQuotaSummaryMailEnabled = false
	Boolean property. More...

	$summary_recipients = ''
	Recipients More...

	$personalWorkspaceDiskQuotaEnabled

Static Private Attributes
static	$dqSettings
	DiskQuota Settings variable. 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 40 of file class.ilObjDiskQuotaSettings.php.

Constructor & Destructor Documentation

◆ __construct()

ilObjDiskQuotaSettings::__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)

Reimplemented from ilObject.

Definition at line 68 of file class.ilObjDiskQuotaSettings.php.

    {
        // NOTE: We share the facs object with ilObjFileAccessSettings!
        $this->type = "facs";
        parent::__construct($a_id, $a_call_by_reference);
    }

Member Function Documentation

◆ _lookupReminderMailTemplate()

static ilObjDiskQuotaSettings::_lookupReminderMailTemplate ( $a_lang )

static

Looks up the mail template for the specified language.

This mail template is used for the reminder mails sent to users who have exceeded their disk quota.

Parameters

string $a_lang language code

Returns: array{} Associative array with mail templates.

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

    {
        global $DIC;
        $ilDB = $DIC['ilDB'];
 
        $set = $ilDB->query("SELECT * FROM mail_template " .
            " WHERE type='dqta' AND lang = " . $ilDB->quote($a_lang, 'text'));
 
        if ($rec = $set->fetchRow(ilDBConstants::FETCHMODE_ASSOC)) {
            return $rec;
        }
        return array();
    }

References $DIC, $ilDB, and ilDBConstants\FETCHMODE_ASSOC.

Referenced by ilObjFileAccessSettingsGUI\initDiskQuotaMailTemplateForm(), and ilDiskQuotaReminderMail\readMailTemplate().

Here is the caller graph for this function:

◆ _writeReminderMailTemplate()

ilObjDiskQuotaSettings::_writeReminderMailTemplate	(	$a_lang,
		$a_subject,
		$a_sal_g,
		$a_sal_f,
		$a_sal_m,
		$a_body
	)

Definition at line 212 of file class.ilObjDiskQuotaSettings.php.

    {
        global $DIC;
        $ilDB = $DIC['ilDB'];
 
        if (self::_lookupReminderMailTemplate($a_lang)) {
            $values = array(
                'subject' => array('text',$a_subject),
                'body' => array('clob',$a_body),
                'sal_g' => array('text',$a_sal_g),
                'sal_f' => array('text',$a_sal_f),
                'sal_m' => array('text',$a_sal_m)
                );
            $ilDB->update(
                'mail_template',
                $values,
                array('lang' => array('text',$a_lang), 'type' => array('text','dqta'))
            );
        } else {
            $values = array(
                'subject' => array('text',$a_subject),
                'body' => array('clob',$a_body),
                'sal_g' => array('text',$a_sal_g),
                'sal_f' => array('text',$a_sal_f),
                'sal_m' => array('text',$a_sal_m),
                'lang' => array('text',$a_lang),
                'type' => array('text','dqta')
                );
            $ilDB->insert('mail_template', $values);
        }
    }

References $DIC, $ilDB, and $values.

◆ create()

ilObjDiskQuotaSettings::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 145 of file class.ilObjDiskQuotaSettings.php.

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

References write().

Here is the call graph for this function:

◆ getInstance()

static ilObjDiskQuotaSettings::getInstance ( )

static

Get settings instance.

Returns: ilObjDiskQuotaSettings

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

    {
        global $DIC;
        $ilDB = $DIC['ilDB'];
        
        $query = "SELECT object_reference.ref_id FROM object_reference,tree,object_data " .
            "WHERE tree.parent = " . $ilDB->quote(SYSTEM_FOLDER_ID, 'integer') . " " .
            "AND object_data.type = " . $ilDB->quote('facs', 'text') .
            "AND object_reference.ref_id = tree.child " .
            "AND object_reference.obj_id = object_data.obj_id";
        $res = $ilDB->query($query);
        $row = $res->fetchRow(ilDBConstants::FETCHMODE_ASSOC);
        $ref_id = $row["ref_id"];
        if ($ref_id) {
            $obj = new self($ref_id);
            $obj->read();
            return $obj;
        }
    }

References $DIC, $ilDB, $query, ilObject\$ref_id, $res, $row, and ilDBConstants\FETCHMODE_ASSOC.

Referenced by ilDAVCronDiskQuota\addCustomSettingsToForm(), ilObjPersonalDesktopSettingsGUI\addToExternalSettingsForm(), ilObjPersonalDesktopSettingsGUI\editWsp(), ilDAVCronDiskQuota\saveCustomSettings(), and ilObjPersonalDesktopSettingsGUI\saveWsp().

Here is the caller graph for this function:

◆ getSummaryRecipients()

ilObjDiskQuotaSettings::getSummaryRecipients ( )

Getter fpr summary recipients.

Returns: String Recipients @access public

Definition at line 279 of file class.ilObjDiskQuotaSettings.php.

    {
        return $this->summary_recipients;
    }

References $summary_recipients.

Referenced by write().

Here is the caller graph for this function:

◆ isDiskQuotaEnabled()

ilObjDiskQuotaSettings::isDiskQuotaEnabled ( )

Gets the diskQuotaEnabled property.

Returns: boolean value

Definition at line 115 of file class.ilObjDiskQuotaSettings.php.

    {
        return $this->diskQuotaEnabled;
    }

References $diskQuotaEnabled.

◆ isDiskQuotaReminderMailEnabled()

ilObjDiskQuotaSettings::isDiskQuotaReminderMailEnabled ( )

Gets the diskQuotaReminderMailEnabled property.

Returns: boolean value

Definition at line 134 of file class.ilObjDiskQuotaSettings.php.

    {
        return $this->diskQuotaReminderMailEnabled;
    }

References $diskQuotaReminderMailEnabled.

◆ isDiskQuotaSummaryMailEnabled()

ilObjDiskQuotaSettings::isDiskQuotaSummaryMailEnabled ( $status = null )

Setter/Getter to activate/deactivate the summary mail cron job.

Parameters

mixed Boolean value or null

Returns: mixed Boolean value or instance of ilObjDiskQuoataSettings @access public

Definition at line 293 of file class.ilObjDiskQuotaSettings.php.

    {
        if (null === $status) {
            return $this->diskQuotaSummaryMailEnabled;
        }
        
        $this->diskQuotaSummaryMailEnabled = $status;
        
        return $this;
    }

References $diskQuotaSummaryMailEnabled.

Referenced by read(), and write().

Here is the caller graph for this function:

◆ isPersonalWorkspaceDiskQuotaEnabled()

ilObjDiskQuotaSettings::isPersonalWorkspaceDiskQuotaEnabled ( )

Gets the personalWorkspaceDiskQuotaEnabled property.

Returns: boolean value

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

    {
        return $this->personalWorkspaceDiskQuotaEnabled;
    }

References $personalWorkspaceDiskQuotaEnabled.

◆ read()

ilObjDiskQuotaSettings::read ( )

read object data from db into object

Reimplemented from ilObject.

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

    {
        parent::read();
 
        $settings = new ilSetting('disk_quota');
        $this->diskQuotaEnabled = $settings->get('enabled') == true;
        $this->diskQuotaReminderMailEnabled = $settings->get('reminder_mail_enabled') == true;
        $this->isDiskQuotaSummaryMailEnabled($settings->get('summary_mail_enabled') == 1 ? true : false);
        $this->setSummaryRecipients($settings->get('summary_rcpt'));
        $this->setPersonalWorkspaceDiskQuotaEnabled($settings->get('wsp_enabled'));
    }

References isDiskQuotaSummaryMailEnabled(), setPersonalWorkspaceDiskQuotaEnabled(), and setSummaryRecipients().

Here is the call graph for this function:

◆ setDiskQuotaEnabled()

ilObjDiskQuotaSettings::setDiskQuotaEnabled ( $newValue )

Sets the diskQuotaEnabled property.

Parameters

boolean new value

Returns: void

Definition at line 106 of file class.ilObjDiskQuotaSettings.php.

    {
        $this->diskQuotaEnabled = $newValue;
    }

◆ setDiskQuotaReminderMailEnabled()

ilObjDiskQuotaSettings::setDiskQuotaReminderMailEnabled ( $newValue )

Sets the diskQuotaReminderMailEnabled property.

Parameters

boolean new value

Returns: void

Definition at line 125 of file class.ilObjDiskQuotaSettings.php.

    {
        $this->diskQuotaReminderMailEnabled = $newValue;
    }

◆ setPersonalWorkspaceDiskQuotaEnabled()

ilObjDiskQuotaSettings::setPersonalWorkspaceDiskQuotaEnabled ( $newValue )

Sets the personalWorkspaceDiskQuotaEnabled property.

Parameters

boolean new value

Returns: void

Definition at line 310 of file class.ilObjDiskQuotaSettings.php.

    {
        $this->personalWorkspaceDiskQuotaEnabled = $newValue;
    }

Referenced by read().

Here is the caller graph for this function:

◆ setSummaryRecipients()

ilObjDiskQuotaSettings::setSummaryRecipients ( $s_recipients )

Setter for summary recipients.

Parameters

String Recipients @access public

Definition at line 252 of file class.ilObjDiskQuotaSettings.php.

    {
        if ($s_recipients) {
            $s_recipients = explode(',', $s_recipients);
            $loginnames = array();
            foreach ($s_recipients as $loginname) {
                $loginname = trim($loginname);
                if (ilObjUser::_lookupId($loginname)) {
                    $loginnames[] = $loginname;
                }
            }
            $s_recipients = implode(',', $loginnames);
        }
            
        $this->summary_recipients = $s_recipients;
        
        return $this;
    }

References ilObjUser\_lookupId().

Referenced by read().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ update()

ilObjDiskQuotaSettings::update ( )

update object in db

Returns: boolean true on success

Reimplemented from ilObject.

Definition at line 155 of file class.ilObjDiskQuotaSettings.php.

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

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

Here is the call graph for this function:

◆ write()

ilObjDiskQuotaSettings::write ( )

private

write object data into db

Parameters

boolean

Definition at line 164 of file class.ilObjDiskQuotaSettings.php.

    {
        $settings = new ilSetting('disk_quota');
        $settings->set('enabled', $this->diskQuotaEnabled);
        $settings->set('reminder_mail_enabled', $this->diskQuotaReminderMailEnabled);
        $settings->set('summary_mail_enabled', $this->isDiskQuotaSummaryMailEnabled() ? 1 : 0);
        $settings->set('summary_rcpt', $this->getSummaryRecipients());
        $settings->set('wsp_enabled', $this->personalWorkspaceDiskQuotaEnabled);
    }