ilBookingPrefBookCron Class Reference

Cron for booking pools. More...

Inheritance diagram for ilBookingPrefBookCron:

Collaboration diagram for ilBookingPrefBookCron:

Public Member Functions
	__construct ()
	getId ()
	getTitle ()
	getDescription ()
	getDefaultScheduleType ()
	getDefaultScheduleValue ()
	hasAutoActivation ()
	hasFlexibleSchedule ()
	run ()
Public Member Functions inherited from ilCronJob
	setDateTimeProvider (?Closure $date_time_provider)
	isDue (?DateTimeImmutable $last_run, ?CronJobScheduleType $schedule_type, ?int $schedule_value, bool $is_manually_executed=false)
	getScheduleType ()
	Get current schedule type (if flexible) More...
	getScheduleValue ()
	Get current schedule value (if flexible) More...
	setSchedule (?CronJobScheduleType $a_type, ?int $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...
	isManuallyExecutable ()
	hasCustomSettings ()
	addCustomSettingsToForm (ilPropertyFormGUI $a_form)
	saveCustomSettings (ilPropertyFormGUI $a_form)
	addToExternalSettingsForm (int $a_form_id, array &$a_fields, bool $a_is_active)
	activationWasToggled (ilDBInterface $db, ilSetting $setting, bool $a_currently_active)
	Important: This method is (also) called from the setup process, where the constructor of an ilCronJob ist NOT executed. More...
	getId ()
	getTitle ()
	getDescription ()
	hasAutoActivation ()
	Is to be activated on "installation", does only work for ILIAS core cron jobs. More...
	hasFlexibleSchedule ()
	getDefaultScheduleType ()
	getDefaultScheduleValue ()
	run ()

Protected Attributes
ilLanguage	$lng
Protected Attributes inherited from ilCronJob
CronJobScheduleType	$schedule_type = null
int	$schedule_value = null
Closure	$date_time_provider = null

Detailed Description

Cron for booking pools.

• Automatic booking for overdue pools with booking by preferences

Author

Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

Definition at line 27 of file class.ilBookingPrefBookCron.php.

Constructor & Destructor Documentation

__construct()

ilBookingPrefBookCron::__construct

(

)

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

References $DIC, and ILIAS\Repository\lng().

    {
        global $DIC;

        $this->lng = $DIC->language();
    }

Here is the call graph for this function:

Member Function Documentation

getDefaultScheduleType()

ilBookingPrefBookCron::getDefaultScheduleType

(

)

Definition at line 61 of file class.ilBookingPrefBookCron.php.

                                            : CronJobScheduleType
    {
        return CronJobScheduleType::SCHEDULE_TYPE_DAILY;
    }

getDefaultScheduleValue()

ilBookingPrefBookCron::getDefaultScheduleValue

(

)

Definition at line 66 of file class.ilBookingPrefBookCron.php.

                                             : ?int
    {
        return null;
    }

getDescription()

ilBookingPrefBookCron::getDescription

(

)

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

References $lng, ilLanguage\loadLanguageModule(), and ilLanguage\txt().

                                    : string
    {
        $lng = $this->lng;

        $lng->loadLanguageModule("book");

        return $lng->txt("book_pref_book_cron_info");
    }

Here is the call graph for this function:

getId()

ilBookingPrefBookCron::getId

(

)

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

                           : string
    {
        return "book_pref_book";
    }

getTitle()

ilBookingPrefBookCron::getTitle

(

)

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

References $lng, ilLanguage\loadLanguageModule(), and ilLanguage\txt().

                              : string
    {
        $lng = $this->lng;

        $lng->loadLanguageModule("book");

        return $lng->txt("book_pref_book_cron");
    }

Here is the call graph for this function:

hasAutoActivation()

ilBookingPrefBookCron::hasAutoActivation

(

)

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

                                       : bool
    {
        return true;
    }

hasFlexibleSchedule()

ilBookingPrefBookCron::hasFlexibleSchedule

(

)

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

                                         : bool
    {
        return true;
    }

run()

ilBookingPrefBookCron::run

(

)

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

References ilCronJobResult\STATUS_NO_ACTION, and ilCronJobResult\STATUS_OK.

                         : ilCronJobResult
    {
        $cron_status = ilCronJobResult::STATUS_NO_ACTION;
        $message = "";

        $auto_book = new ilBookingPrefAutoBooking();
        $auto_book->run();

        $cron_status = ilCronJobResult::STATUS_OK;

        $cron_result = new ilCronJobResult();
        $cron_result->setStatus($cron_status);

        return $cron_result;
    }

Field Documentation

$lng

ilLanguage ilBookingPrefBookCron::$lng

protected

Definition at line 29 of file class.ilBookingPrefBookCron.php.

Referenced by getDescription(), and getTitle().

---

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

• components/ILIAS/BookingManager/classes/class.ilBookingPrefBookCron.php