ilPaymentCronNotification Class Reference

Payment notifications. More...

Inheritance diagram for ilPaymentCronNotification:

Collaboration diagram for ilPaymentCronNotification:

Public Member Functions
	getId ()
	getTitle ()
	getDescription ()
	getDefaultScheduleType ()
	getDefaultScheduleValue ()
	hasAutoActivation ()
	hasFlexibleSchedule ()
	hasCustomSettings ()
	run ()
	addCustomSettingsToForm (ilPropertyFormGUI $a_form)
	saveCustomSettings (ilPropertyFormGUI $a_form)
	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...
	getValidScheduleTypes ()
	Get all available schedule types. 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

Payment notifications.

Author

Nadia Ahmad nahma.nosp@m.d@da.nosp@m.tabay.nosp@m..de

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

Member Function Documentation

activationWasToggled()

ilPaymentCronNotification::activationWasToggled

(

$a_currently_active

)

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

References $ilSetting.

        {               
                global $ilSetting;
                
                // propagate cron-job setting to object setting
                $ilSetting->set('payment_notification', (bool)$a_currently_active);
        }

addCustomSettingsToForm()

ilPaymentCronNotification::addCustomSettingsToForm

(

ilPropertyFormGUI

$a_form

)

Definition at line 76 of file class.ilPaymentCronNotification.php.

References $ilSetting, $lng, ilPropertyFormGUI\addItem(), and ilNumberInputGUI\setSize().

        {
                global $lng, $ilSetting;
                
                $num_days = new ilNumberInputGUI($lng->txt('payment_notification_days'),'payment_notification_days');
                $num_days->setSize(3);
                $num_days->setMinValue(0);
                $num_days->setMaxValue(120);
                $num_days->setRequired(true);
                $num_days->setValue($ilSetting->get('payment_notification_days'));
                $num_days->setInfo($lng->txt('payment_notification_days_desc'));
                $a_form->addItem($num_days);
        }

Here is the call graph for this function:

getDefaultScheduleType()

ilPaymentCronNotification::getDefaultScheduleType

(

)

Definition at line 33 of file class.ilPaymentCronNotification.php.

        {
                return self::SCHEDULE_TYPE_DAILY;
        }

getDefaultScheduleValue()

ilPaymentCronNotification::getDefaultScheduleValue

(

)

Definition at line 38 of file class.ilPaymentCronNotification.php.

        {
                return;
        }

getDescription()

ilPaymentCronNotification::getDescription

(

)

Definition at line 26 of file class.ilPaymentCronNotification.php.

References $lng.

        {
                global $lng;
                        
                return $lng->txt("payment_notification_desc");
        }

getId()

ilPaymentCronNotification::getId

(

)

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

        {
                return "pay_notification";
        }

getTitle()

ilPaymentCronNotification::getTitle

(

)

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

References $lng.

        {
                global $lng;
                        
                return $lng->txt("payment_notification");
        }

hasAutoActivation()

ilPaymentCronNotification::hasAutoActivation

(

)

Definition at line 43 of file class.ilPaymentCronNotification.php.

        {
                return false;
        }

hasCustomSettings()

ilPaymentCronNotification::hasCustomSettings

(

)

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

        {
                return true;
        }

hasFlexibleSchedule()

ilPaymentCronNotification::hasFlexibleSchedule

(

)

Definition at line 48 of file class.ilPaymentCronNotification.php.

        {
                return false;
        }

run()

ilPaymentCronNotification::run

(

)

Definition at line 58 of file class.ilPaymentCronNotification.php.

References $result, ilUserDefinedInvoiceNumber\_isUDInvoiceNumberActive(), and ilCronJobResult\STATUS_OK.

        {                                               
                require_once 'Services/Payment/classes/class.ilPaymentNotification.php';
                $msn = new ilPaymentNotification();
                $msn->send();

                include_once './Services/Payment/classes/class.ilUserDefinedInvoiceNumber.php';
                if(ilUserDefinedInvoiceNumber::_isUDInvoiceNumberActive())
                {                       
                        $msn = new ilUserDefinedInvoiceNumber();
                        $msn->cronCheck();
                }
        
                $result = new ilCronJobResult();
                $result->setStatus(ilCronJobResult::STATUS_OK);         
                return $result;
        }

Here is the call graph for this function:

saveCustomSettings()

ilPaymentCronNotification::saveCustomSettings

(

ilPropertyFormGUI

$a_form

)

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

References $_POST, and $ilSetting.

        {                       
                global $ilSetting;
                
                $ilSetting->set('payment_notification_days', $_POST['payment_notification_days']);      
                
                // invoice_number_reset_period is not saved ?!
                // see: ilObjSystemFolderGUI::saveCronJobsObject() [<= 4.3.x]
                
                // see also
                // - ilObjPaymentSettings::generalSettingsObject()
                // - ilObjPaymentSettings::saveInvoiceNumberObject()
                        
                return true;
        }

---

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

• Services/Payment/classes/class.ilPaymentCronNotification.php