ilDAVCronDiskQuota Class Reference

Soft disk quota notifications. More...

Inheritance diagram for ilDAVCronDiskQuota:

Collaboration diagram for ilDAVCronDiskQuota:

Public Member Functions
	getId ()
	getTitle ()
	getDescription ()
	getDefaultScheduleType ()
	getDefaultScheduleValue ()
	hasAutoActivation ()
	hasFlexibleSchedule ()
	hasCustomSettings ()
	run ()
	addCustomSettingsToForm (ilPropertyFormGUI $a_form)
	saveCustomSettings (ilPropertyFormGUI $a_form)
	addToExternalSettingsForm ($a_form_id, array &$a_fields, $a_is_active)
	activationWasToggled ($a_currently_active)
Public Member Functions inherited from ilCronJob
	isActive ($a_ts_last_run, $a_schedule_type, $a_schedule_value, $a_manual=false)
	Is job currently active? More...
	getScheduleType ()
	Get current schedule type (if flexible) More...
	getScheduleValue ()
	Get current schedule value (if flexible) More...
	setSchedule ($a_type, $a_value)
	Update current schedule (if flexible) More...
	getAllScheduleTypes ()
	Get all available schedule types. More...
	getScheduleTypesWithValues ()
	getValidScheduleTypes ()
	Returns a collection of all valid schedule types for a specific job. More...
	getTitle ()
	Get title. More...
	getDescription ()
	Get description. More...
	isManuallyExecutable ()
	Defines whether or not a cron job can be started manually. More...
	hasCustomSettings ()
	Has cron job any custom setting which can be edited? More...
	addCustomSettingsToForm (ilPropertyFormGUI $a_form)
	Add custom settings to form. More...
	saveCustomSettings (ilPropertyFormGUI $a_form)
	Save custom settings. More...
	addToExternalSettingsForm ($a_form_id, array &$a_fields, $a_is_active)
	Add external settings to form. More...
	activationWasToggled ($a_currently_active)
	Cron job status was changed. More...
	getId ()
	Get id. More...
	hasAutoActivation ()
	Is to be activated on "installation". More...
	hasFlexibleSchedule ()
	Can the schedule be configured? More...
	getDefaultScheduleType ()
	Get schedule type. More...
	getDefaultScheduleValue ()
	Get schedule value. More...
	run ()
	Run job. More...

Additional Inherited Members
Data Fields inherited from ilCronJob
const	SCHEDULE_TYPE_DAILY = 1
const	SCHEDULE_TYPE_IN_MINUTES = 2
const	SCHEDULE_TYPE_IN_HOURS = 3
const	SCHEDULE_TYPE_IN_DAYS = 4
const	SCHEDULE_TYPE_WEEKLY = 5
const	SCHEDULE_TYPE_MONTHLY = 6
const	SCHEDULE_TYPE_QUARTERLY = 7
const	SCHEDULE_TYPE_YEARLY = 8
Protected Member Functions inherited from ilCronJob
	checkSchedule ($a_ts_last_run, $a_schedule_type, $a_schedule_value)

Detailed Description

Soft disk quota notifications.

Author

Jörg Lützenkirchen luetz.nosp@m.enki.nosp@m.rchen.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

Definition at line 12 of file class.ilDAVCronDiskQuota.php.

Member Function Documentation

activationWasToggled()

ilDAVCronDiskQuota::activationWasToggled

(

$a_currently_active

)

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

    {
        // #12221
        $settings = new ilSetting('disk_quota');
        $settings->set('enabled', $a_currently_active);
        
        /* objDefinition is not available in setup, we cannot use ilObject
        $disk_quota_obj = ilObjDiskQuotaSettings::getInstance();
        $disk_quota_obj->setDiskQuotaEnabled((bool)$a_currently_active);
        $disk_quota_obj->update();
        */
    }

addCustomSettingsToForm()

ilDAVCronDiskQuota::addCustomSettingsToForm

(

ilPropertyFormGUI

$a_form

)

Definition at line 81 of file class.ilDAVCronDiskQuota.php.

References $DIC, $lng, ilPropertyFormGUI\addItem(), ilObjDiskQuotaSettings\getInstance(), and ilCheckboxInputGUI\setValue().

    {
        global $DIC;
        $lng = $DIC['lng'];
        
        $lng->loadLanguageModule("file");
        
        $disk_quota_obj = ilObjDiskQuotaSettings::getInstance();

        // Enable disk quota reminder mail
        $cb_prop_reminder = new ilCheckboxInputGUI($lng->txt("enable_disk_quota_reminder_mail"), "enable_disk_quota_reminder_mail");
        $cb_prop_reminder->setValue('1');
        $cb_prop_reminder->setChecked($disk_quota_obj->isDiskQuotaReminderMailEnabled());
        $cb_prop_reminder->setInfo($lng->txt('disk_quota_reminder_mail_desc'));
        $a_form->addItem($cb_prop_reminder);
        
        // Enable summary mail for certain users
        $cb_prop_summary = new ilCheckboxInputGUI($lng->txt("enable_disk_quota_summary_mail"), "enable_disk_quota_summary_mail");
        $cb_prop_summary->setValue(1);
        $cb_prop_summary->setChecked($disk_quota_obj->isDiskQuotaSummaryMailEnabled());
        $cb_prop_summary->setInfo($lng->txt('enable_disk_quota_summary_mail_desc'));
        $a_form->addItem($cb_prop_summary);
        
        // Edit disk quota recipients
        $summary_rcpt = new ilTextInputGUI($lng->txt("disk_quota_summary_rctp"), "disk_quota_summary_rctp");
        $summary_rcpt->setValue($disk_quota_obj->getSummaryRecipients());
        $summary_rcpt->setInfo($lng->txt('disk_quota_summary_rctp_desc'));
        $cb_prop_summary->addSubItem($summary_rcpt);
    }

Here is the call graph for this function:

addToExternalSettingsForm()

ilDAVCronDiskQuota::addToExternalSettingsForm	(		$a_form_id,
		array &	$a_fields,
			$a_is_active
	)

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

References $DIC, $lng, ilDiskQuotaActivationChecker\_isReminderMailActive(), ilDiskQuotaActivationChecker\_isSummaryMailActive(), ilAdministrationSettingsFormHandler\FORM_FILES_QUOTA, ilAdministrationSettingsFormHandler\FORM_REPOSITORY, and ilAdministrationSettingsFormHandler\VALUE_BOOL.

    {
        global $DIC;
        $lng = $DIC['lng'];
        
        $lng->loadLanguageModule("file");
        
        switch ($a_form_id) {
            case ilAdministrationSettingsFormHandler::FORM_REPOSITORY:
            case ilAdministrationSettingsFormHandler::FORM_FILES_QUOTA:
            

                $subitems = array(
                    "enable_disk_quota_reminder_mail" => array(
                        ilDiskQuotaActivationChecker::_isReminderMailActive(),
                        ilAdministrationSettingsFormHandler::VALUE_BOOL
                        ),
                    "enable_disk_quota_summary_mail" => array(
                        ilDiskQuotaActivationChecker::_isSummaryMailActive(),
                        ilAdministrationSettingsFormHandler::VALUE_BOOL
                        )
                );
                $a_fields["repository_disk_quota"] = array($a_is_active ?
                    $lng->txt("enabled") :
                    $lng->txt("disabled"),
                    null, $subitems);
                break;
        }
    }

Here is the call graph for this function:

getDefaultScheduleType()

ilDAVCronDiskQuota::getDefaultScheduleType

(

)

Definition at line 37 of file class.ilDAVCronDiskQuota.php.

    {
        return self::SCHEDULE_TYPE_DAILY;
    }

getDefaultScheduleValue()

ilDAVCronDiskQuota::getDefaultScheduleValue

(

)

Definition at line 42 of file class.ilDAVCronDiskQuota.php.

    {
        return;
    }

getDescription()

ilDAVCronDiskQuota::getDescription

(

)

Definition at line 28 of file class.ilDAVCronDiskQuota.php.

References $DIC, and $lng.

    {
        global $DIC;
        $lng = $DIC['lng'];
        
        $lng->loadLanguageModule("file");
        return $lng->txt("repository_disk_quota_info");
    }

getId()

ilDAVCronDiskQuota::getId

(

)

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

    {
        return "rep_disk_quota";
    }

getTitle()

ilDAVCronDiskQuota::getTitle

(

)

Definition at line 19 of file class.ilDAVCronDiskQuota.php.

References $DIC, and $lng.

    {
        global $DIC;
        $lng = $DIC['lng'];
        
        $lng->loadLanguageModule("file");
        return $lng->txt("repository_disk_quota");
    }

hasAutoActivation()

ilDAVCronDiskQuota::hasAutoActivation

(

)

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

    {
        return false;
    }

hasCustomSettings()

ilDAVCronDiskQuota::hasCustomSettings

(

)

Definition at line 57 of file class.ilDAVCronDiskQuota.php.

    {
        return true;
    }

hasFlexibleSchedule()

ilDAVCronDiskQuota::hasFlexibleSchedule

(

)

Definition at line 52 of file class.ilDAVCronDiskQuota.php.

    {
        return false;
    }

run()

ilDAVCronDiskQuota::run

(

)

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

References $result, ilDiskQuotaActivationChecker\_isActive(), ilDiskQuotaActivationChecker\_isReminderMailActive(), ilDiskQuotaActivationChecker\_isSummaryMailActive(), ilDiskQuotaChecker\_sendReminderMails(), ilDiskQuotaChecker\_sendSummaryMails(), ilDiskQuotaChecker\_updateDiskUsageReport(), and ilCronJobResult\STATUS_OK.

    {
        if (ilDiskQuotaActivationChecker::_isActive()) {
            ilDiskQuotaChecker::_updateDiskUsageReport();
                        
            if (ilDiskQuotaActivationChecker::_isReminderMailActive()) {
                ilDiskQuotaChecker::_sendReminderMails();
            }

            if (ilDiskQuotaActivationChecker::_isSummaryMailActive()) {
                ilDiskQuotaChecker::_sendSummaryMails();
            }
        }
    
        $result = new ilCronJobResult();
        $result->setStatus(ilCronJobResult::STATUS_OK);
        return $result;
    }

Here is the call graph for this function:

saveCustomSettings()

ilDAVCronDiskQuota::saveCustomSettings

(

ilPropertyFormGUI

$a_form

)

Definition at line 111 of file class.ilDAVCronDiskQuota.php.

References $_POST, ilObjDiskQuotaSettings\getInstance(), and ilUtil\stripSlashes().

    {
        $disk_quota_obj = ilObjDiskQuotaSettings::getInstance();
        $disk_quota_obj->setDiskQuotaReminderMailEnabled($_POST['enable_disk_quota_reminder_mail'] == '1');
        $disk_quota_obj->isDiskQuotaSummaryMailEnabled($_POST['enable_disk_quota_summary_mail'] == '1');
        $disk_quota_obj->setSummaryRecipients(ilUtil::stripSlashes($_POST['disk_quota_summary_rctp']));
        $disk_quota_obj->update();
            
        return true;
    }

Here is the call graph for this function:

---

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

• Services/DiskQuota/classes/class.ilDAVCronDiskQuota.php