ILIAS  release_5-3 Revision v5.3.23-19-g915713cf615
ilLearningModuleCronLinkCheck Class Reference
+ Inheritance diagram for ilLearningModuleCronLinkCheck:
+ Collaboration diagram for ilLearningModuleCronLinkCheck:

Public Member Functions

 __construct ()
 Constructor. More...
 
 getId ()
 
 getTitle ()
 
 getDescription ()
 
 getDefaultScheduleType ()
 
 getDefaultScheduleValue ()
 
 hasAutoActivation ()
 
 hasFlexibleSchedule ()
 
 run ()
 
- 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...
 

Protected Attributes

 $lng
 
 $log
 
 $db
 

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.ilLearningModuleCronLinkCheck.php.

Constructor & Destructor Documentation

◆ __construct()

ilLearningModuleCronLinkCheck::__construct ( )

Constructor.

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

References $DIC.

36  {
37  global $DIC;
38 
39  $this->lng = $DIC->language();
40  $this->log = $DIC["ilLog"];
41  $this->db = $DIC->database();
42  }
global $DIC
Definition: saml.php:7

Member Function Documentation

◆ getDefaultScheduleType()

ilLearningModuleCronLinkCheck::getDefaultScheduleType ( )

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

64  {
65  return self::SCHEDULE_TYPE_DAILY;
66  }

◆ getDefaultScheduleValue()

ilLearningModuleCronLinkCheck::getDefaultScheduleValue ( )

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

69  {
70  return;
71  }

◆ getDescription()

ilLearningModuleCronLinkCheck::getDescription ( )

Definition at line 56 of file class.ilLearningModuleCronLinkCheck.php.

References $lng.

57  {
58  $lng = $this->lng;
59 
60  return $lng->txt("check_link_desc");
61  }

◆ getId()

ilLearningModuleCronLinkCheck::getId ( )

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

45  {
46  return "lm_link_check";
47  }

◆ getTitle()

ilLearningModuleCronLinkCheck::getTitle ( )

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

References $lng.

50  {
51  $lng = $this->lng;
52 
53  return $lng->txt("check_link");
54  }

◆ hasAutoActivation()

ilLearningModuleCronLinkCheck::hasAutoActivation ( )

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

74  {
75  return false;
76  }

◆ hasFlexibleSchedule()

ilLearningModuleCronLinkCheck::hasFlexibleSchedule ( )

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

79  {
80  return false;
81  }

◆ run()

ilLearningModuleCronLinkCheck::run ( )

Definition at line 83 of file class.ilLearningModuleCronLinkCheck.php.

References $counter, $db, $ilDB, $ilLog, $log, $message, $result, ilCronJobResult\STATUS_NO_ACTION, and ilCronJobResult\STATUS_OK.

84  {
86  $ilDB = $this->db;
87 
89 
90  include_once'./Services/LinkChecker/classes/class.ilLinkChecker.php';
91 
92  $link_checker = new ilLinkChecker($ilDB);
93  $link_checker->setMailStatus(true);
94 
95  $link_checker->checkLinks();
96 
97  $counter = 0;
98  foreach ($link_checker->getLogMessages() as $message) {
99  $ilLog->write($message);
100  $counter++;
101  }
102 
103  if ($counter) {
104  $status = ilCronJobResult::STATUS_OK;
105  }
106  $result = new ilCronJobResult();
107  $result->setStatus($status);
108  return $result;
109  }
$result
class for checking external links in page objects Normally used in Cron jobs, but should be extensibl...
$counter
catch(Exception $e) $message
global $ilDB
Cron job result data container.

Field Documentation

◆ $db

ilLearningModuleCronLinkCheck::$db
protected

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

Referenced by run().

◆ $lng

ilLearningModuleCronLinkCheck::$lng
protected

Definition at line 19 of file class.ilLearningModuleCronLinkCheck.php.

Referenced by getDescription(), and getTitle().

◆ $log

ilLearningModuleCronLinkCheck::$log
protected

Definition at line 24 of file class.ilLearningModuleCronLinkCheck.php.

Referenced by run().


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