ILIAS  release_5-3 Revision v5.3.23-19-g915713cf615
ilSCComponentTaskGUI Class Reference

Abstract class for component tasks. More...

+ Inheritance diagram for ilSCComponentTaskGUI:
+ Collaboration diagram for ilSCComponentTaskGUI:

Public Member Functions

 __construct (ilSCTask $task=null)
 
 getActions ()
 Get actions for task table gui array( 'txt' => $lng->txt('sysc_action_repair') 'command' => 'repairTask' );. More...
 
 getTitle ()
 Get title of task. More...
 
 getDescription ()
 get description of task More...
 
 getGroupTitle ()
 Get title of group. More...
 
 getGroupDescription ()
 Get description of group. More...
 
 getTask ()
 
 executeCommand ()
 Execute command. More...
 

Protected Member Functions

 getLang ()
 Get language. More...
 
 getCtrl ()
 Get ctrl. More...
 
 showSimpleConfirmation ($a_text, $a_btn_text, $a_cmd)
 Show simple confirmation. More...
 
 cancel ()
 Cancel and return to task list. More...
 

Protected Attributes

 $ctrl
 
 $lng
 
 $task = null
 

Detailed Description

Abstract class for component tasks.

Author
Stefan Meyer smeye.nosp@m.r.il.nosp@m.ias@g.nosp@m.mx.d.nosp@m.e

Definition at line 11 of file class.ilSCComponentTaskGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilSCComponentTaskGUI::__construct ( ilSCTask  $task = null)

Definition at line 22 of file class.ilSCComponentTaskGUI.php.

References $GLOBALS, $task, getActions(), getDescription(), getGroupDescription(), getGroupTitle(), and getTitle().

23  {
24  $this->task = $task;
25 
26  $this->ctrl = $GLOBALS['ilCtrl'];
27  $this->lng = $GLOBALS['lng'];
28  }
$GLOBALS['loaded']
Global hash that tracks already loaded includes.
+ Here is the call graph for this function:

Member Function Documentation

◆ cancel()

ilSCComponentTaskGUI::cancel ( )
protected

Cancel and return to task list.

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

References getCtrl().

122  {
123  $this->getCtrl()->returnToParent($this);
124  }
+ Here is the call graph for this function:

◆ executeCommand()

ilSCComponentTaskGUI::executeCommand ( )

Execute command.

Definition at line 91 of file class.ilSCComponentTaskGUI.php.

References getCtrl().

92  {
93  $next_class = $this->getCtrl()->getNextClass($this);
94  $cmd = $this->getCtrl()->getCmd();
95 
96  switch ($next_class) {
97  default:
98  $this->$cmd();
99  break;
100  }
101  }
+ Here is the call graph for this function:

◆ getActions()

ilSCComponentTaskGUI::getActions ( )
abstract

Get actions for task table gui array( 'txt' => $lng->txt('sysc_action_repair') 'command' => 'repairTask' );.

Returns
array

Referenced by __construct().

+ Here is the caller graph for this function:

◆ getCtrl()

◆ getDescription()

ilSCComponentTaskGUI::getDescription ( )
abstract

get description of task

Referenced by __construct().

+ Here is the caller graph for this function:

◆ getGroupDescription()

ilSCComponentTaskGUI::getGroupDescription ( )
abstract

Get description of group.

Referenced by __construct().

+ Here is the caller graph for this function:

◆ getGroupTitle()

ilSCComponentTaskGUI::getGroupTitle ( )
abstract

Get title of group.

Referenced by __construct().

+ Here is the caller graph for this function:

◆ getLang()

◆ getTask()

◆ getTitle()

ilSCComponentTaskGUI::getTitle ( )
abstract

Get title of task.

Referenced by __construct().

+ Here is the caller graph for this function:

◆ showSimpleConfirmation()

ilSCComponentTaskGUI::showSimpleConfirmation (   $a_text,
  $a_btn_text,
  $a_cmd 
)
protected

Show simple confirmation.

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

References $GLOBALS, and getCtrl().

Referenced by ilSCTreeTasksGUI\confirmRepairMissing(), ilSCTreeTasksGUI\confirmRepairMissingTreeEntries(), and ilSCTreeTasksGUI\confirmRepairStructure().

107  {
108  include_once './Services/Utilities/classes/class.ilConfirmationGUI.php';
109  $confirm = new ilConfirmationGUI();
110  $confirm->setFormAction($this->getCtrl()->getFormAction($this));
111  $confirm->setConfirm($a_btn_text, $a_cmd);
112  $confirm->setCancel($this->lng->txt('cancel'), 'cancel');
113  $confirm->setHeaderText($a_text);
114 
115  $GLOBALS['tpl']->setContent($confirm->getHTML());
116  }
$GLOBALS['loaded']
Global hash that tracks already loaded includes.
Confirmation screen class.
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

Field Documentation

◆ $ctrl

ilSCComponentTaskGUI::$ctrl
protected

Definition at line 13 of file class.ilSCComponentTaskGUI.php.

Referenced by getCtrl().

◆ $lng

ilSCComponentTaskGUI::$lng
protected

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

Referenced by getLang().

◆ $task

ilSCComponentTaskGUI::$task = null
protected

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

Referenced by __construct(), and getTask().


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