ILIAS  trunk Revision v11.0_alpha-3011-gc6b235a2e85
ilLearningSequenceActivationDB Class Reference

Persistence for online/activation period. More...

+ Collaboration diagram for ilLearningSequenceActivationDB:

Public Member Functions

 __construct (ilDBInterface $database)
 
 getActivationForRefId (int $ref_id)
 
 deleteForRefId (int $ref_id)
 
 store (ilLearningSequenceActivation $settings)
 
 setEffectiveOnlineStatus (int $ref_id, bool $status)
 

Data Fields

const TABLE_NAME = 'lso_activation'
 

Protected Member Functions

 insert (ilLearningSequenceActivation $settings)
 
 select (int $ref_id)
 
 buildActivationSettings (int $ref_id, bool $online=false, bool $effective_online=false, ?\DateTime $activation_start=null, ?\DateTime $activation_end=null)
 

Protected Attributes

ilDBInterface $database
 

Detailed Description

Persistence for online/activation period.

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

Constructor & Destructor Documentation

◆ __construct()

ilLearningSequenceActivationDB::__construct ( ilDBInterface  $database)

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

References $database, and ILIAS\Repository\database().

+ Here is the call graph for this function:

Member Function Documentation

◆ buildActivationSettings()

ilLearningSequenceActivationDB::buildActivationSettings ( int  $ref_id,
bool  $online = false,
bool  $effective_online = false,
?\DateTime  $activation_start = null,
?\DateTime  $activation_end = null 
)
protected

Definition at line 147 of file class.ilLearningSequenceActivationDB.php.

155 $ref_id,
156 $online,
157 $effective_online,
158 $activation_start,
159 $activation_end
160 );
161 }
$ref_id
Definition: ltiauth.php:66

Referenced by getActivationForRefId().

+ Here is the caller graph for this function:

◆ deleteForRefId()

ilLearningSequenceActivationDB::deleteForRefId ( int  $ref_id)

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

68 : void
69 {
70 $query = "DELETE FROM " . static::TABLE_NAME . PHP_EOL
71 . "WHERE ref_id = " . $this->database->quote($ref_id, "integer") . PHP_EOL
72 ;
73 $this->database->manipulate($query);
74 }

References ILIAS\Repository\database().

+ Here is the call graph for this function:

◆ getActivationForRefId()

ilLearningSequenceActivationDB::getActivationForRefId ( int  $ref_id)

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

36 {
37 $data = $this->select($ref_id);
38 if (count($data) == 0) {
39 $settings = $this->buildActivationSettings($ref_id);
40 $this->insert($settings);
41 } else {
42 if ($data['activation_start_ts']) {
43 $start = new \DateTime();
44 $start->setTimestamp((int) $data['activation_start_ts']);
45 } else {
46 $start = null;
47 }
48
49 if ($data['activation_end_ts']) {
50 $end = new \DateTime();
51 $end->setTimestamp((int) $data['activation_end_ts']);
52 } else {
53 $end = null;
54 }
55
56 $settings = $this->buildActivationSettings(
57 (int) $data['ref_id'],
58 (bool) $data['online'],
59 (bool) $data['effective_online'],
60 $start,
61 $end
62 );
63 }
64
65 return $settings;
66 }
buildActivationSettings(int $ref_id, bool $online=false, bool $effective_online=false, ?\DateTime $activation_start=null, ?\DateTime $activation_end=null)
insert(ilLearningSequenceActivation $settings)

References $data, buildActivationSettings(), insert(), and select().

+ Here is the call graph for this function:

◆ insert()

ilLearningSequenceActivationDB::insert ( ilLearningSequenceActivation  $settings)
protected

Definition at line 102 of file class.ilLearningSequenceActivationDB.php.

102 : void
103 {
104 $start = $settings->getActivationStart();
105 $end = $settings->getActivationEnd();
106
107 if ($start) {
108 $start = $start->getTimestamp();
109 }
110
111 if ($end) {
112 $end = $end->getTimestamp();
113 }
114
115 $values = [
116 "ref_id" => ["integer", $settings->getRefId()],
117 "online" => ["integer", $settings->getIsOnline()],
118 "effective_online" => ["integer", $settings->getEffectiveOnlineStatus()],
119 "activation_start_ts" => ["integer", $start],
120 "activation_end_ts" => ["integer", $end]
121 ];
122
123 $this->database->insert(static::TABLE_NAME, $values);
124 }

References ILIAS\Repository\database(), ilLearningSequenceActivation\getActivationEnd(), ilLearningSequenceActivation\getActivationStart(), ilLearningSequenceActivation\getEffectiveOnlineStatus(), ilLearningSequenceActivation\getIsOnline(), and ilLearningSequenceActivation\getRefId().

Referenced by getActivationForRefId().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ select()

ilLearningSequenceActivationDB::select ( int  $ref_id)
protected
Returns
string[]

Definition at line 129 of file class.ilLearningSequenceActivationDB.php.

129 : array
130 {
131 $ret = [];
132 $query =
133 "SELECT ref_id, online, effective_online, activation_start_ts, activation_end_ts" . PHP_EOL
134 . "FROM " . static::TABLE_NAME . PHP_EOL
135 . "WHERE ref_id = " . $this->database->quote($ref_id, "integer") . PHP_EOL
136 ;
137
138 $result = $this->database->query($query);
139
140 if ($this->database->numRows($result) !== 0) {
141 $ret = $this->database->fetchAssoc($result);
142 }
143
144 return $ret;
145 }

References ILIAS\Repository\database().

Referenced by getActivationForRefId().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ setEffectiveOnlineStatus()

ilLearningSequenceActivationDB::setEffectiveOnlineStatus ( int  $ref_id,
bool  $status 
)

Definition at line 163 of file class.ilLearningSequenceActivationDB.php.

163 : void
164 {
165 $where = ["ref_id" => ["integer", $ref_id]];
166 $values = ["effective_online" => ["integer", $status]];
167
168 $this->database->update(static::TABLE_NAME, $values, $where);
169 }

References $ref_id, and ILIAS\Repository\database().

+ Here is the call graph for this function:

◆ store()

ilLearningSequenceActivationDB::store ( ilLearningSequenceActivation  $settings)

Definition at line 76 of file class.ilLearningSequenceActivationDB.php.

76 : void
77 {
78 $where = [
79 "ref_id" => ["integer", $settings->getRefId()]
80 ];
81
82 $start = $settings->getActivationStart();
83 $end = $settings->getActivationEnd();
84
85 if ($start) {
86 $start = $start->getTimestamp();
87 }
88
89 if ($end) {
90 $end = $end->getTimestamp();
91 }
92
93 $values = [
94 "online" => ["integer", $settings->getIsOnline()],
95 "activation_start_ts" => ["integer", $start],
96 "activation_end_ts" => ["integer", $end]
97 ];
98
99 $this->database->update(static::TABLE_NAME, $values, $where);
100 }

References ILIAS\Repository\database(), ilLearningSequenceActivation\getActivationEnd(), ilLearningSequenceActivation\getActivationStart(), ilLearningSequenceActivation\getIsOnline(), and ilLearningSequenceActivation\getRefId().

+ Here is the call graph for this function:

Field Documentation

◆ $database

ilDBInterface ilLearningSequenceActivationDB::$database
protected

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

Referenced by __construct().

◆ TABLE_NAME

const ilLearningSequenceActivationDB::TABLE_NAME = 'lso_activation'

Definition at line 26 of file class.ilLearningSequenceActivationDB.php.


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