ilMembershipCronMinMembers Class Reference

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

Inheritance diagram for ilMembershipCronMinMembers:

Collaboration diagram for ilMembershipCronMinMembers:

Public Member Functions
	getId ()
	Get id. More...
	getTitle ()
	Get title. More...
	getDescription ()
	Get description. More...
	getDefaultScheduleType ()
	Get schedule type. More...
	getDefaultScheduleValue ()
	Get schedule value. More...
	hasAutoActivation ()
	Is to be activated on "installation". More...
	hasFlexibleSchedule ()
	Can the schedule be configured? More...
	run ()
	Run job. More...
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...

Protected Member Functions
	getCourses (array &$a_recipients_map)
	getGroups (array &$a_recipients_map)
	sendMessage ($a_reci_id, array $a_items)
Protected Member Functions inherited from ilCronJob
	checkSchedule ($a_ts_last_run, $a_schedule_type, $a_schedule_value)

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

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

Member Function Documentation

getCourses()

ilMembershipCronMinMembers::getCourses ( array &  $a_recipients_map )

protected

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

    {
        include_once "Modules/Course/classes/class.ilObjCourse.php";
        foreach (ilObjCourse::findCoursesWithNotEnoughMembers() as $obj_id => $item) {
            $too_few = (bool) $item[0];
            
            /*
            $ilDB->manipulate("UPDATE crs_settings".
                " SET cancel_end_noti = ".$ilDB->quote($now, "integer").
                " WHERE obj_id = ".$ilDB->quote($obj_id, "integer"));
            */
            
            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]);
                }
            } else {
                // enough members: notify members?
                
                // :TODO: ?
            }
        }
    }

References ilObjCourse\findCoursesWithNotEnoughMembers().

Referenced by run().

Here is the call graph for this function:

Here is the caller graph for this function:

getDefaultScheduleType()

ilMembershipCronMinMembers::getDefaultScheduleType

(

)

Get schedule type.

Returns

int

Reimplemented from ilCronJob.

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

    {
        return self::SCHEDULE_TYPE_DAILY;
    }

References ilCronJob\SCHEDULE_TYPE_DAILY.

getDefaultScheduleValue()

ilMembershipCronMinMembers::getDefaultScheduleValue

(

)

Get schedule value.

Returns

int|array

Reimplemented from ilCronJob.

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

    {
        return;
    }

getDescription()

ilMembershipCronMinMembers::getDescription

(

)

Get description.

Returns

string

Reimplemented from ilCronJob.

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

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

References $DIC, and $lng.

getGroups()

ilMembershipCronMinMembers::getGroups ( array &  $a_recipients_map )

protected

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

    {
        include_once "Modules/Group/classes/class.ilObjGroup.php";
        foreach (ilObjGroup::findGroupsWithNotEnoughMembers() as $obj_id => $item) {
            $too_few = (bool) $item[0];
            
            /*
            $ilDB->manipulate("UPDATE grp_settings".
                " SET cancel_end_noti = ".$ilDB->quote($now, "integer").
                " WHERE obj_id = ".$ilDB->quote($obj_id, "integer"));
            */
            
            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]);
                }
            } else {
                // enough members: notify members?
                
                // :TODO: ?
            }
        }
    }

References ilObjGroup\findGroupsWithNotEnoughMembers().

Referenced by run().

Here is the call graph for this function:

Here is the caller graph for this function:

getId()

ilMembershipCronMinMembers::getId

(

)

Get id.

Returns

string

Reimplemented from ilCronJob.

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

    {
        return "mem_min_members";
    }

getTitle()

ilMembershipCronMinMembers::getTitle

(

)

Get title.

Returns

string

Reimplemented from ilCronJob.

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

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

References $DIC, and $lng.

hasAutoActivation()

ilMembershipCronMinMembers::hasAutoActivation

(

)

Is to be activated on "installation".

Returns

boolean

Reimplemented from ilCronJob.

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

    {
        return true;
    }

hasFlexibleSchedule()

ilMembershipCronMinMembers::hasFlexibleSchedule

(

)

Can the schedule be configured?

Returns

boolean

Reimplemented from ilCronJob.

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

    {
        return false;
    }

run()

ilMembershipCronMinMembers::run

(

)

Run job.

Returns

ilCronJobResult

Reimplemented from ilCronJob.

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

    {
        $status = ilCronJobResult::STATUS_NO_ACTION;
        $message = null;
        
        $recipients_map = array();
        
        $this->getCourses($recipients_map);
        $this->getGroups($recipients_map);
    
        if (sizeof($recipients_map)) {
            foreach ($recipients_map as $reci_id => $items) {
                $this->sendMessage($reci_id, $items);
            }
                    
            $status = ilCronJobResult::STATUS_OK;
            $message = sizeof($recipients_map) . " notifications sent";
        }
        
        $result = new ilCronJobResult();
        $result->setStatus($status);
        $result->setMessage($message);
        
        return $result;
    }

References $message, $result, getCourses(), getGroups(), sendMessage(), ilCronJobResult\STATUS_NO_ACTION, and ilCronJobResult\STATUS_OK.

Here is the call graph for this function:

sendMessage()

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

protected

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

    {
        global $DIC;
 
        $ilUser = $DIC['ilUser'];
        
        include_once "Services/Link/classes/class.ilLink.php";
        include_once "./Services/Notification/classes/class.ilSystemNotification.php";
        $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 = $item[0];
            $obj_id = $item[1];
            $ref_id = array_pop(ilObject::_getAllReferences($obj_id));
            
            $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),
            null,
            null,
            $lng->txt("mem_cron_min_members_subject"),
            $ntf->composeAndGetMessage($a_reci_id, null, "read", true),
            []
        );
    }

References $DIC, $ilUser, $lng, $url, ilObject\_getAllReferences(), ilLink\_getLink(), ilObjUser\_lookupLogin(), and ilObject\_lookupTitle().

Referenced by run().

Here is the call graph for this function:

Here is the caller graph for this function:

---

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

• Services/Membership/classes/class.ilMembershipCronMinMembers.php