ilMembershipCronMinMembers Class Reference

Cron for course/group minimum members. More...

Inheritance diagram for ilMembershipCronMinMembers:

Collaboration diagram for ilMembershipCronMinMembers:

Public Member Functions
	__construct ()
	getId ()
	getTitle ()
	getDescription ()
	getDefaultScheduleType ()
	getDefaultScheduleValue ()
	hasAutoActivation ()
	hasFlexibleSchedule ()
	run ()
Public Member Functions inherited from ILIAS\Cron\CronJob
	setDateTimeProvider (?\Closure $date_time_provider)
	isDue (?\DateTimeImmutable $last_run, ?JobScheduleType $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 (?JobScheduleType $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 ()
	usesLegacyForms ()
	getCustomConfigurationInput (\ILIAS\UI\Factory $ui_factory, \ILIAS\Refinery\Factory $factory, \ilLanguage $lng)
	addCustomSettingsToForm (\ilPropertyFormGUI $a_form)
	saveCustomConfiguration (mixed $form_data)
	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 Member Functions
	getCourses (array &$a_recipients_map)
	getGroups (array &$a_recipients_map)
	sendMessage (int $a_reci_id, array $a_items)

Protected Attributes
ilLanguage	$lng
Protected Attributes inherited from ILIAS\Cron\CronJob
JobScheduleType	$schedule_type = null
int	$schedule_value = null
Closure	$date_time_provider = null

Detailed Description

Cron for course/group minimum members.

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 32 of file class.ilMembershipCronMinMembers.php.

Constructor & Destructor Documentation

__construct()

ilMembershipCronMinMembers::__construct

(

)

Definition at line 36 of file class.ilMembershipCronMinMembers.php.

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

    {
        global $DIC;

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

Here is the call graph for this function:

Member Function Documentation

getCourses()

ilMembershipCronMinMembers::getCourses ( array &  $a_recipients_map )

protected

Definition at line 103 of file class.ilMembershipCronMinMembers.php.

References ilObjCourse\findCoursesWithNotEnoughMembers().

Referenced by run().

                                                           : void
    {
        foreach (ilObjCourse::findCoursesWithNotEnoughMembers() as $obj_id => $item) {
            $too_few = (bool) $item[0];


            if ($too_few) {
                // not enough members: notifiy course admins
                foreach ($item[1] as $reci_id) {
                    $a_recipients_map[$reci_id][] = array("crs", $obj_id, $item[0]);
                }
            }
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getDefaultScheduleType()

ilMembershipCronMinMembers::getDefaultScheduleType

(

)

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

                                            : JobScheduleType
    {
        return JobScheduleType::DAILY;
    }

getDefaultScheduleValue()

ilMembershipCronMinMembers::getDefaultScheduleValue

(

)

Definition at line 63 of file class.ilMembershipCronMinMembers.php.

References null.

                                             : ?int
    {
        return null;
    }

getDescription()

ilMembershipCronMinMembers::getDescription

(

)

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

References ILIAS\Repository\lng().

                                    : string
    {
        return $this->lng->txt("mem_cron_min_members_info");
    }

Here is the call graph for this function:

getGroups()

ilMembershipCronMinMembers::getGroups ( array &  $a_recipients_map )

protected

Definition at line 118 of file class.ilMembershipCronMinMembers.php.

References ilObjGroup\findGroupsWithNotEnoughMembers().

Referenced by run().

                                                          : void
    {
        foreach (ilObjGroup::findGroupsWithNotEnoughMembers() as $obj_id => $item) {
            $too_few = (bool) $item[0];


            if ($too_few) {
                // not enough members: notifiy group admins
                foreach ($item[1] as $reci_id) {
                    $a_recipients_map[$reci_id][] = array("grp", $obj_id, $item[0]);
                }
            }
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getId()

ilMembershipCronMinMembers::getId

(

)

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

                           : string
    {
        return "mem_min_members";
    }

getTitle()

ilMembershipCronMinMembers::getTitle

(

)

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

References ILIAS\Repository\lng().

                              : string
    {
        return $this->lng->txt("mem_cron_min_members");
    }

Here is the call graph for this function:

hasAutoActivation()

ilMembershipCronMinMembers::hasAutoActivation

(

)

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

                                       : bool
    {
        return true;
    }

hasFlexibleSchedule()

ilMembershipCronMinMembers::hasFlexibleSchedule

(

)

Definition at line 73 of file class.ilMembershipCronMinMembers.php.

                                         : bool
    {
        return false;
    }

run()

ilMembershipCronMinMembers::run

(

)

Definition at line 78 of file class.ilMembershipCronMinMembers.php.

References $message, getCourses(), getGroups(), and sendMessage().

                         : JobResult
    {
        $status = JobResult::STATUS_NO_ACTION;
        $message = '';

        $recipients_map = array();

        $this->getCourses($recipients_map);
        $this->getGroups($recipients_map);

        if (count($recipients_map)) {
            foreach ($recipients_map as $reci_id => $items) {
                $this->sendMessage($reci_id, $items);
            }
            $status = JobResult::STATUS_OK;
            $message = count($recipients_map) . " notifications sent";
        }

        $result = new JobResult();
        $result->setStatus($status);
        $result->setMessage($message);

        return $result;
    }

Here is the call graph for this function:

sendMessage()

ilMembershipCronMinMembers::sendMessage ( int  $a_reci_id, array  $a_items  )

protected

Definition at line 133 of file class.ilMembershipCronMinMembers.php.

References $ref_id, $url, ilObject\_getAllReferences(), ilObjUser\_lookupLogin(), ilObject\_lookupTitle(), ANONYMOUS_USER_ID, ilLanguage\getUserLanguage(), ILIAS\Repository\int(), null, and ilLanguage\txt().

Referenced by run().

                                                                  : void
    {
        $ntf = new ilSystemNotification();
        $ntf->setLangModules(array("crs"));

        // #17097
        $ntf->setReasonLangId("mem_cron_min_members_reason");

        // user specific language
        $lng = $ntf->getUserLanguage($a_reci_id);

        $list = array();
        foreach ($a_items as $item) {
            $obj_type = (string) $item[0];
            $obj_id = (int) $item[1];
            $ref_ids = ilObject::_getAllReferences($obj_id);
            $ref_id = array_pop($ref_ids);
            $title = ilObject::_lookupTitle($obj_id);
            $url = ilLink::_getLink($ref_id, $obj_type);

            $list[] = $title . "\n" . $url . "\n";
        }
        $list = implode($ntf->getBlockBorder(), $list);

        $ntf->addAdditionalInfo("mem_cron_min_members_intro", $list, true);
        $ntf->addAdditionalInfo("mem_cron_min_members_task", "");

        $mail = new ilMail(ANONYMOUS_USER_ID);
        $mail->enqueue(
            ilObjUser::_lookupLogin($a_reci_id),
            '',
            '',
            $lng->txt("mem_cron_min_members_subject"),
            $ntf->composeAndGetMessage($a_reci_id, null, "read", true),
            []
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$lng

ilLanguage ilMembershipCronMinMembers::$lng

protected

Definition at line 34 of file class.ilMembershipCronMinMembers.php.

---

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

• components/ILIAS/Membership/classes/Cron/class.ilMembershipCronMinMembers.php