Inheritance diagram for ilObjDiskQuotaSettings:

Collaboration diagram for ilObjDiskQuotaSettings:

Public Member Functions
	ilObjDiskQuotaSettings ($a_id=0, $a_call_by_reference=true)
	Constructor.
	setDiskQuotaEnabled ($newValue)
	Sets the diskQuotaEnabled property.
	isDiskQuotaEnabled ()
	Gets the diskQuotaEnabled property.
	setDiskQuotaReminderMailEnabled ($newValue)
	Sets the diskQuotaReminderMailEnabled property.
	isDiskQuotaReminderMailEnabled ()
	Gets the diskQuotaReminderMailEnabled property.
	create ()
	create
	update ()
	update object in db
	read ($a_force_db=false)
	read object data from db into object
	_lookupReminderMailTemplate ($a_lang)
	Looks up the mail template for the specified language.
	_writeReminderMailTemplate ($a_lang, $a_subject, $a_sal_g, $a_sal_f, $a_sal_m, $a_body)
	setSummaryRecipients ($s_recipients)
	Setter for summary recipients.
	getSummaryRecipients ()
	Getter fpr summary recipients.
	isDiskQuotaSummaryMailEnabled ($status=null)
	Setter/Getter to activate/deactivate the summary mail cron job.
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
	_lookupObjIdByImportId ($a_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
	_lookupDescription ($a_id)
	lookup object description
	_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
	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)
	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
	$diskQuotaEnabled
	Boolean property.
	$diskQuotaReminderMailEnabled
	Boolean property.
	$diskQuotaSummaryMailEnabled = false
	Boolean property.
	$summary_recipients = ''
	Recipients.

Static Private Attributes
static	$dqSettings
	DiskQuota Settings variable.

Additional Inherited Members
Static Public Member Functions inherited from ilObject
static	_getAllReferences ($a_id)
	get all reference ids of object
static	_lookupTitle ($a_id)
	lookup object title
static	_getIdsForTitle ($title, $type= '', $partialmatch=false)
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)
	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 40 of file class.ilObjDiskQuotaSettings.php.

Member Function Documentation

ilObjDiskQuotaSettings::_lookupReminderMailTemplate ( $a_lang )

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

References $ilDB, and DB_FETCHMODE_ASSOC.

Referenced by ilDiskQuotaReminderMail\readMailTemplate().

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

Here is the caller graph for this function:

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

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

References $ilDB.

        {
                global $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);
                }
        }

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

References write().

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

Here is the call graph for this function:

ilObjDiskQuotaSettings::getSummaryRecipients ( )

Getter fpr summary recipients.

Returns: String Recipients public

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

References $summary_recipients.

Referenced by write().

        {
                return $this->summary_recipients;
        }       

Here is the caller graph for this function:

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

References ilObject\ilObject().

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

Here is the call graph for this function:

ilObjDiskQuotaSettings::isDiskQuotaEnabled ( )

Gets the diskQuotaEnabled property.

Returns: boolean value

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

References $diskQuotaEnabled.

        {
                return $this->diskQuotaEnabled;
        }

ilObjDiskQuotaSettings::isDiskQuotaReminderMailEnabled ( )

Gets the diskQuotaReminderMailEnabled property.

Returns: boolean value

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

References $diskQuotaReminderMailEnabled.

        {
                return $this->diskQuotaReminderMailEnabled;
        }

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 public

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

References $diskQuotaSummaryMailEnabled.

Referenced by read(), and write().

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

Here is the caller graph for this function:

ilObjDiskQuotaSettings::read ( $a_force_db = false )

read object data from db into object

Parameters

boolean

Reimplemented from ilObject.

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

References isDiskQuotaSummaryMailEnabled(), and setSummaryRecipients().

        {
                parent::read($a_force_db);
                $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'));            
        }

Here is the call graph for this function:

ilObjDiskQuotaSettings::setDiskQuotaEnabled ( $newValue )

Sets the diskQuotaEnabled property.

Parameters

boolean new value

Returns: void

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

        {
                $this->diskQuotaEnabled = $newValue;
        }

ilObjDiskQuotaSettings::setDiskQuotaReminderMailEnabled ( $newValue )

Sets the diskQuotaReminderMailEnabled property.

Parameters

boolean new value

Returns: void

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

        {
                $this->diskQuotaReminderMailEnabled = $newValue;
        }

ilObjDiskQuotaSettings::setSummaryRecipients ( $s_recipients )

Setter for summary recipients.

Parameters

String Recipients public

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

Referenced by read().

        {
                $this->summary_recipients = $s_recipients;
                
                return $this;
        }

Here is the caller graph for this function:

ilObjDiskQuotaSettings::update ( )

update object in db

Returns: boolean true on success

Reimplemented from ilObject.

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

References write().

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

Here is the call graph for this function:

ilObjDiskQuotaSettings::write ( )

private

write object data into db

Parameters

boolean

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

References getSummaryRecipients(), and isDiskQuotaSummaryMailEnabled().

Referenced by create(), and update().

        {
                $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());
        }