ilWebResourceCronLinkCheck Class Reference

Inheritance diagram for ilWebResourceCronLinkCheck:

Collaboration diagram for ilWebResourceCronLinkCheck:

Public Member Functions
	getId ()
	getTitle ()
	getDescription ()
	getDefaultScheduleType ()
	getDefaultScheduleValue ()
	hasAutoActivation ()
	hasFlexibleSchedule ()
	run ()
	__getCheckPeriod ()
	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

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

Member Function Documentation

__getCheckPeriod()

ilWebResourceCronLinkCheck::__getCheckPeriod

(

)

Definition at line 113 of file class.ilWebResourceCronLinkCheck.php.

References ilCronJob\getScheduleType().

Referenced by run().

    {
        switch ($this->getScheduleType()) {
            case self::SCHEDULE_TYPE_DAILY:
                $period = 24 * 60 * 60;
                break;

            case self::SCHEDULE_TYPE_WEEKLY:
                $period = 7 * 24 * 60 * 60;
                break;

            case self::SCHEDULE_TYPE_MONTHLY:
                $period = 30 * 7 * 24 * 60 * 60;
                break;

            case self::SCHEDULE_TYPE_QUARTERLY:
                $period = 3 * 30 * 7 * 24 * 60 * 60;
                break;

            default:
                $period = 0;
        }
        return $period;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

activationWasToggled()

ilWebResourceCronLinkCheck::activationWasToggled

(

$a_currently_active

)

Definition at line 138 of file class.ilWebResourceCronLinkCheck.php.

References $DIC, and $ilSetting.

    {
        global $DIC;

        $ilSetting = $DIC['ilSetting'];
                
        // propagate cron-job setting to object setting
        $ilSetting->set("cron_web_resource_check", (bool) $a_currently_active);
    }

getDefaultScheduleType()

ilWebResourceCronLinkCheck::getDefaultScheduleType

(

)

Definition at line 39 of file class.ilWebResourceCronLinkCheck.php.

    {
        return self::SCHEDULE_TYPE_DAILY;
    }

getDefaultScheduleValue()

ilWebResourceCronLinkCheck::getDefaultScheduleValue

(

)

Definition at line 44 of file class.ilWebResourceCronLinkCheck.php.

    {
        return;
    }

getDescription()

ilWebResourceCronLinkCheck::getDescription

(

)

Definition at line 30 of file class.ilWebResourceCronLinkCheck.php.

References $DIC, and $lng.

    {
        global $DIC;

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

getId()

ilWebResourceCronLinkCheck::getId

(

)

Definition at line 16 of file class.ilWebResourceCronLinkCheck.php.

    {
        return "webr_link_check";
    }

getTitle()

ilWebResourceCronLinkCheck::getTitle

(

)

Definition at line 21 of file class.ilWebResourceCronLinkCheck.php.

References $DIC, and $lng.

    {
        global $DIC;

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

hasAutoActivation()

ilWebResourceCronLinkCheck::hasAutoActivation

(

)

Definition at line 49 of file class.ilWebResourceCronLinkCheck.php.

    {
        return false;
    }

hasFlexibleSchedule()

ilWebResourceCronLinkCheck::hasFlexibleSchedule

(

)

Definition at line 54 of file class.ilWebResourceCronLinkCheck.php.

    {
        return true;
    }

run()

ilWebResourceCronLinkCheck::run

(

)

Definition at line 59 of file class.ilWebResourceCronLinkCheck.php.

References $DIC, $ilDB, $ilLog, $ilUser, $message, $result, __getCheckPeriod(), ilUtil\_getObjectsByOperations(), ilObjectFactory\getInstanceByRefId(), ilCronJobResult\STATUS_NO_ACTION, and ilCronJobResult\STATUS_OK.

    {
        global $DIC;

        $ilLog = $DIC->logger()->webr();
        $ilUser = $DIC['ilUser'];
        $ilDB = $DIC['ilDB'];
        
        $status = ilCronJobResult::STATUS_NO_ACTION;
    
        include_once'./Services/LinkChecker/classes/class.ilLinkChecker.php';

        $counter = 0;
        foreach (ilUtil::_getObjectsByOperations('webr', 'write', $ilUser->getId(), -1) as $node) {
            if (!is_object($tmp_webr = ilObjectFactory::getInstanceByRefId($node, false))) {
                continue;
            }

            $tmp_webr->initLinkResourceItemsObject();
            
            // Set all link to valid. After check invalid links will be set to invalid

            $link_checker = new ilLinkChecker($ilDB);
            $link_checker->setMailStatus(true);
            $link_checker->setCheckPeriod($this->__getCheckPeriod());
            $link_checker->setObjId($tmp_webr->getId());


            $tmp_webr->items_obj->updateValidByCheck($this->__getCheckPeriod());
            foreach ($link_checker->checkWebResourceLinks() as $invalid) {
                $tmp_webr->items_obj->readItem($invalid['page_id']);
                $tmp_webr->items_obj->setActiveStatus(false);
                $tmp_webr->items_obj->setValidStatus(false);
                $tmp_webr->items_obj->setDisableCheckStatus(true);
                $tmp_webr->items_obj->setLastCheckDate(time());
                $tmp_webr->items_obj->update(false);
            }
            
            $tmp_webr->items_obj->updateLastCheck($this->__getCheckPeriod());

            foreach ($link_checker->getLogMessages() as $message) {
                $ilLog->debug($message);
                $counter++;
            }
        }
    
        if ($counter) {
            $status = ilCronJobResult::STATUS_OK;
        }
        $result = new ilCronJobResult();
        $result->setStatus($status);
        return $result;
    }

Here is the call graph for this function:

---

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

• Modules/WebResource/classes/class.ilWebResourceCronLinkCheck.php