ilWebResourceCronLinkCheck Class Reference

Inheritance diagram for ilWebResourceCronLinkCheck:

Collaboration diagram for ilWebResourceCronLinkCheck:

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...
	__getCheckPeriod ()
	activationWasToggled ($a_currently_active)
	Cron job status was changed. 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...
	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

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

Member Function Documentation

__getCheckPeriod()

ilWebResourceCronLinkCheck::__getCheckPeriod

(

)

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

    {
        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;
    }

References ilCronJob\getScheduleType(), ilCronJob\SCHEDULE_TYPE_DAILY, ilCronJob\SCHEDULE_TYPE_MONTHLY, ilCronJob\SCHEDULE_TYPE_QUARTERLY, and ilCronJob\SCHEDULE_TYPE_WEEKLY.

Referenced by run().

Here is the call graph for this function:

Here is the caller graph for this function:

activationWasToggled()

ilWebResourceCronLinkCheck::activationWasToggled

(

$a_currently_active

)

Cron job status was changed.

Parameters

bool

$a_currently_active

Reimplemented from ilCronJob.

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

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

References $ilSetting.

getDefaultScheduleType()

ilWebResourceCronLinkCheck::getDefaultScheduleType

(

)

Get schedule type.

Returns

int

Reimplemented from ilCronJob.

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

    {
        return self::SCHEDULE_TYPE_DAILY;
    }

References ilCronJob\SCHEDULE_TYPE_DAILY.

getDefaultScheduleValue()

ilWebResourceCronLinkCheck::getDefaultScheduleValue

(

)

Get schedule value.

Returns

int|array

Reimplemented from ilCronJob.

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

    {
        return;
    }

getDescription()

ilWebResourceCronLinkCheck::getDescription

(

)

Get description.

Returns

string

Reimplemented from ilCronJob.

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

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

References $lng.

getId()

ilWebResourceCronLinkCheck::getId

(

)

Get id.

Returns

string

Reimplemented from ilCronJob.

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

    {
        return "webr_link_check";
    }

getTitle()

ilWebResourceCronLinkCheck::getTitle

(

)

Get title.

Returns

string

Reimplemented from ilCronJob.

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

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

References $lng.

hasAutoActivation()

ilWebResourceCronLinkCheck::hasAutoActivation

(

)

Is to be activated on "installation".

Returns

boolean

Reimplemented from ilCronJob.

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

    {
        return false;
    }

hasFlexibleSchedule()

ilWebResourceCronLinkCheck::hasFlexibleSchedule

(

)

Can the schedule be configured?

Returns

boolean

Reimplemented from ilCronJob.

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

    {
        return true;
    }

run()

ilWebResourceCronLinkCheck::run

(

)

Run job.

Returns

ilCronJobResult

Reimplemented from ilCronJob.

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

    {
        global $ilLog, $ilUser, $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->write($message);
                $counter++;
            }
        }
    
        if ($counter) {
            $status = ilCronJobResult::STATUS_OK;
        }
        $result = new ilCronJobResult();
        $result->setStatus($status);
        return $result;
    }

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

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