ILIAS  release_5-1 Revision 5.0.0-5477-g43f3e3fab5f
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 110 of file class.ilWebResourceCronLinkCheck.php.

111 {
112 switch($this->getScheduleType())
113 {
115 $period = 24 * 60 * 60;
116 break;
117
119 $period = 7 * 24 * 60 * 60;
120 break;
121
123 $period = 30 * 7 * 24 * 60 * 60;
124 break;
125
127 $period = 3 * 30 * 7 * 24 * 60 * 60;
128 break;
129
130 default:
131 $period = 0;
132 }
133 return $period;
134 }
getScheduleType()
Get current schedule type (if flexible)
const SCHEDULE_TYPE_WEEKLY
const SCHEDULE_TYPE_DAILY
const SCHEDULE_TYPE_QUARTERLY
const SCHEDULE_TYPE_MONTHLY

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 136 of file class.ilWebResourceCronLinkCheck.php.

137 {
138 global $ilSetting;
139
140 // propagate cron-job setting to object setting
141 $ilSetting->set("cron_web_resource_check", (bool)$a_currently_active);
142 }
global $ilSetting
Definition: privfeed.php:40

References $ilSetting.

◆ getDefaultScheduleType()

ilWebResourceCronLinkCheck::getDefaultScheduleType ( )

Get schedule type.

Returns
int

Reimplemented from ilCronJob.

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

36 {
38 }

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.

41 {
42 return;
43 }

◆ getDescription()

ilWebResourceCronLinkCheck::getDescription ( )

Get description.

Returns
string

Reimplemented from ilCronJob.

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

29 {
30 global $lng;
31
32 return $lng->txt("check_web_resources_desc");
33 }
global $lng
Definition: privfeed.php:40

References $lng.

◆ getId()

ilWebResourceCronLinkCheck::getId ( )

Get id.

Returns
string

Reimplemented from ilCronJob.

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

17 {
18 return "webr_link_check";
19 }

◆ getTitle()

ilWebResourceCronLinkCheck::getTitle ( )

Get title.

Returns
string

Reimplemented from ilCronJob.

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

22 {
23 global $lng;
24
25 return $lng->txt("check_web_resources");
26 }

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.

46 {
47 return false;
48 }

◆ hasFlexibleSchedule()

ilWebResourceCronLinkCheck::hasFlexibleSchedule ( )

Can the schedule be configured?

Returns
boolean

Reimplemented from ilCronJob.

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

51 {
52 return true;
53 }

◆ run()

ilWebResourceCronLinkCheck::run ( )

Run job.

Returns
ilCronJobResult

Reimplemented from ilCronJob.

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

56 {
57 global $ilLog, $ilUser, $ilDB;
58
60
61 include_once'./Services/LinkChecker/classes/class.ilLinkChecker.php';
62
63 $counter = 0;
64 foreach(ilUtil::_getObjectsByOperations('webr','write',$ilUser->getId(),-1) as $node)
65 {
66 if(!is_object($tmp_webr = ilObjectFactory::getInstanceByRefId($node,false)))
67 {
68 continue;
69 }
70
71 $tmp_webr->initLinkResourceItemsObject();
72
73 // Set all link to valid. After check invalid links will be set to invalid
74
75 $link_checker =& new ilLinkChecker($ilDB);
76 $link_checker->setMailStatus(true);
77 $link_checker->setCheckPeriod($this->__getCheckPeriod());
78 $link_checker->setObjId($tmp_webr->getId());
79
80
81 $tmp_webr->items_obj->updateValidByCheck($this->__getCheckPeriod());
82 foreach($link_checker->checkWebResourceLinks() as $invalid)
83 {
84 $tmp_webr->items_obj->readItem($invalid['page_id']);
85 $tmp_webr->items_obj->setActiveStatus(false);
86 $tmp_webr->items_obj->setValidStatus(false);
87 $tmp_webr->items_obj->setDisableCheckStatus(true);
88 $tmp_webr->items_obj->setLastCheckDate(time());
89 $tmp_webr->items_obj->update(false);
90 }
91
92 $tmp_webr->items_obj->updateLastCheck($this->__getCheckPeriod());
93
94 foreach($link_checker->getLogMessages() as $message)
95 {
96 $ilLog->write($message);
97 $counter++;
98 }
99 }
100
101 if($counter)
102 {
104 }
105 $result = new ilCronJobResult();
106 $result->setStatus($status);
107 return $result;
108 }
$result
Cron job result data container.
class for checking external links in page objects Normally used in Cron jobs, but should be extensibl...
getInstanceByRefId($a_ref_id, $stop_on_error=true)
get an instance of an Ilias object by reference id
static _getObjectsByOperations($a_obj_type, $a_operation, $a_usr_id=0, $limit=0)
Get all objects of a specific type and check access This function is not recursive,...
global $ilDB
global $ilUser
Definition: imgupload.php:15

References $ilDB, $ilLog, $ilUser, $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: