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

Class ilCtrlDatabaseUpdateSteps holds the database update- steps affecting ilCtrl tables. More...

+ Inheritance diagram for ilCtrlDatabaseUpdateSteps:
+ Collaboration diagram for ilCtrlDatabaseUpdateSteps:

Public Member Functions

 prepare (ilDBInterface $db)
 @inheritDoc More...
 
 step_1 ()
 Deletes the table 'ctrl_calls' from the database, as it is no longer needed. More...
 
 step_2 ()
 Deletes the table 'ctrl_classfile' from the database, as it is no longer needed. More...
 
 step_3 ()
 Deletes the table 'ctrl_structure' from the database, as it is no longer needed. More...
 
 step_4 ()
 Deletes the table 'il_request_token' from the database, since tokens are now stored in the ILIAS session. More...
 
 step_5 ()
 Deletes the table 'service_class' from the database, since information is now stored in an artifact. More...
 
 step_6 ()
 Deletes the table 'module_class' from the database, since information is now stored in an artifact. More...
 
- Public Member Functions inherited from ilDatabaseUpdateSteps
 prepare (\ilDBInterface $db)
 Prepare the execution of the steps. More...
 

Private Member Functions

 abortIfNotPrepared ()
 Halts the execution of these update steps if no database was provided. More...
 

Private Attributes

ilDBInterface $database = null
 

Detailed Description

Class ilCtrlDatabaseUpdateSteps holds the database update- steps affecting ilCtrl tables.

Author
Thibeau Fuhrer thf@s.nosp@m.tude.nosp@m.r-rai.nosp@m.mann.nosp@m..ch

Definition at line 27 of file class.ilCtrlDatabaseUpdateSteps.php.

Member Function Documentation

◆ abortIfNotPrepared()

ilCtrlDatabaseUpdateSteps::abortIfNotPrepared ( )
private

Halts the execution of these update steps if no database was provided.

Exceptions
LogicExceptionif the database update steps were not yet prepared.

Definition at line 121 of file class.ilCtrlDatabaseUpdateSteps.php.

121 : void
122 {
123 if (null === $this->database) {
124 throw new LogicException(self::class . "::prepare() must be called before db-update-steps execution.");
125 }
126 }

References ILIAS\Repository\database().

Referenced by step_1(), step_2(), step_3(), step_4(), step_5(), and step_6().

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

◆ prepare()

ilCtrlDatabaseUpdateSteps::prepare ( ilDBInterface  $db)

@inheritDoc

Definition at line 37 of file class.ilCtrlDatabaseUpdateSteps.php.

37 : void
38 {
39 $this->database = $db;
40 }

References ILIAS\Repository\database().

+ Here is the call graph for this function:

◆ step_1()

ilCtrlDatabaseUpdateSteps::step_1 ( )

Deletes the table 'ctrl_calls' from the database, as it is no longer needed.

Definition at line 46 of file class.ilCtrlDatabaseUpdateSteps.php.

46 : void
47 {
48 $this->abortIfNotPrepared();
49 if ($this->database->tableExists('ctrl_calls')) {
50 $this->database->dropTable('ctrl_calls');
51 }
52 }
abortIfNotPrepared()
Halts the execution of these update steps if no database was provided.

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

+ Here is the call graph for this function:

◆ step_2()

ilCtrlDatabaseUpdateSteps::step_2 ( )

Deletes the table 'ctrl_classfile' from the database, as it is no longer needed.

Definition at line 58 of file class.ilCtrlDatabaseUpdateSteps.php.

58 : void
59 {
60 $this->abortIfNotPrepared();
61 if ($this->database->tableExists('ctrl_classfile')) {
62 $this->database->dropTable('ctrl_classfile');
63 }
64 }

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

+ Here is the call graph for this function:

◆ step_3()

ilCtrlDatabaseUpdateSteps::step_3 ( )

Deletes the table 'ctrl_structure' from the database, as it is no longer needed.

Definition at line 70 of file class.ilCtrlDatabaseUpdateSteps.php.

70 : void
71 {
72 $this->abortIfNotPrepared();
73 if ($this->database->tableExists('ctrl_structure')) {
74 $this->database->dropTable('ctrl_structure');
75 }
76 }

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

+ Here is the call graph for this function:

◆ step_4()

ilCtrlDatabaseUpdateSteps::step_4 ( )

Deletes the table 'il_request_token' from the database, since tokens are now stored in the ILIAS session.

Definition at line 82 of file class.ilCtrlDatabaseUpdateSteps.php.

82 : void
83 {
84 $this->abortIfNotPrepared();
85 if ($this->database->tableExists('il_request_token')) {
86 $this->database->dropTable('il_request_token');
87 }
88 }

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

+ Here is the call graph for this function:

◆ step_5()

ilCtrlDatabaseUpdateSteps::step_5 ( )

Deletes the table 'service_class' from the database, since information is now stored in an artifact.

Definition at line 94 of file class.ilCtrlDatabaseUpdateSteps.php.

94 : void
95 {
96 $this->abortIfNotPrepared();
97 if ($this->database->tableExists('service_class')) {
98 $this->database->dropTable('service_class');
99 }
100 }

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

+ Here is the call graph for this function:

◆ step_6()

ilCtrlDatabaseUpdateSteps::step_6 ( )

Deletes the table 'module_class' from the database, since information is now stored in an artifact.

Definition at line 106 of file class.ilCtrlDatabaseUpdateSteps.php.

106 : void
107 {
108 $this->abortIfNotPrepared();
109 if ($this->database->tableExists('module_class')) {
110 $this->database->dropTable('module_class');
111 }
112 }

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

+ Here is the call graph for this function:

Field Documentation

◆ $database

ilDBInterface ilCtrlDatabaseUpdateSteps::$database = null
private

Definition at line 32 of file class.ilCtrlDatabaseUpdateSteps.php.


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