Handles tree tasks. More...

Inheritance diagram for ilSCTreeTasksGUI:

Collaboration diagram for ilSCTreeTasksGUI:

Public Member Functions
	getGroupTitle ()

	getGroupDescription ()

	getTitle ()
	Get title of task. More...

	getDescription ()
	Get title of task. More...

	getActions ()
	get actions for table gui More...

	analyzeStructure ()
	Analyze tree structure. More...

	listTree ()
	List tree. More...

	showTree ()
	Show already scanned tree. More...

	validateDuplicates ()
	start task More...

Public Member Functions inherited from ilSCComponentTaskGUI
	__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...

Data Fields
const	TYPE_DUPLICATES = 'duplicates'

const	TYPE_DUMP = 'dump'

const	TYPE_MISSING = 'missing_reference'

const	TYPE_MISSING_TREE = 'missing_tree'

const	TYPE_STRUCTURE = 'structure'

Protected Member Functions
	confirmRepairStructure ()
	Show repair missing confirmation. More...

	repairStructure ()
	Repair structure. More...

	repairDuplicates ()
	repair More...

	deleteDuplicatesFromRepository ()

	deleteDuplicatesFromTrash ()

	findMissing ()
	find missing objects More...

	confirmRepairMissing ()
	Show repair missing confirmation. More...

	repairMissing ()
	Repair missing objects. More...

	findMissingTreeEntries ()
	find missing objects More...

	confirmRepairMissingTreeEntries ()
	Show repair missing confirmation. More...

	repairMissingTreeEntries ()
	Repair missing objects. More...

Protected Member Functions inherited from ilSCComponentTaskGUI
	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...

Additional Inherited Members
Protected Attributes inherited from ilSCComponentTaskGUI
	$ctrl

	$lng

	$task = null

Detailed Description

Handles tree tasks.

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

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

Member Function Documentation

◆ analyzeStructure()

ilSCTreeTasksGUI::analyzeStructure ( )

Analyze tree structure.

Definition at line 174 of file class.ilSCTreeTasksGUI.php.

References ilSCComponentTaskGUI\getCtrl(), ilSCComponentTaskGUI\getLang(), ilSCComponentTaskGUI\getTask(), ilUtil\sendFailure(), ilUtil\sendSuccess(), and ilSCTask\STATUS_FAILED.

     {
         include_once './Services/Tree/classes/class.ilSCTreeTasks.php';
         $tasks = new ilSCTreeTasks($this->getTask());
         $num_failures = $tasks->validateStructure();
         
         if ($this->getTask()->getStatus() == ilSCTask::STATUS_FAILED) {
             // error message
             ilUtil::sendFailure($this->getLang()->txt('sysc_tree_structure_failures') . ' ' . $num_failures, true);
         } else {
             ilUtil::sendSuccess($this->getLang()->txt('sysc_message_success'), true);
         }
         $this->getCtrl()->returnToParent($this);
     }

Here is the call graph for this function:

◆ confirmRepairMissing()

ilSCTreeTasksGUI::confirmRepairMissing ( )

protected

Show repair missing confirmation.

Returns: type

Definition at line 366 of file class.ilSCTreeTasksGUI.php.

References ilSCComponentTaskGUI\getLang(), and ilSCComponentTaskGUI\showSimpleConfirmation().

     {
         return $this->showSimpleConfirmation(
             $this->getLang()->txt('sysc_message_tree_missing_confirm'),
             $this->getLang()->txt('sysc_btn_tree_missing'),
             'repairMissing'
         );
     }

Here is the call graph for this function:

◆ confirmRepairMissingTreeEntries()

ilSCTreeTasksGUI::confirmRepairMissingTreeEntries ( )

protected

Show repair missing confirmation.

Returns: type

Definition at line 415 of file class.ilSCTreeTasksGUI.php.

References ilSCComponentTaskGUI\getLang(), and ilSCComponentTaskGUI\showSimpleConfirmation().

     {
         return $this->showSimpleConfirmation(
             $this->getLang()->txt('sysc_message_tree_missing_confirm'),
             $this->getLang()->txt('sysc_btn_tree_missing'),
             'repairMissingTreeEntries'
         );
     }

Here is the call graph for this function:

◆ confirmRepairStructure()

ilSCTreeTasksGUI::confirmRepairStructure ( )

protected

Show repair missing confirmation.

Returns: type

Definition at line 194 of file class.ilSCTreeTasksGUI.php.

References ilSCComponentTaskGUI\getLang(), and ilSCComponentTaskGUI\showSimpleConfirmation().

     {
         return $this->showSimpleConfirmation(
             $this->getLang()->txt('sysc_message_tree_structure_confirm'),
             $this->getLang()->txt('sysc_btn_tree_structure'),
             'repairStructure'
         );
     }

Here is the call graph for this function:

◆ deleteDuplicatesFromRepository()

ilSCTreeTasksGUI::deleteDuplicatesFromRepository ( )

protected

Definition at line 311 of file class.ilSCTreeTasksGUI.php.

References $GLOBALS, ilSCTreeTasks\deleteDuplicateFromTree(), ilSCComponentTaskGUI\getCtrl(), ilSCComponentTaskGUI\getLang(), ilSCComponentTaskGUI\getTask(), ilSCTreeTasks\repairPK(), and ilUtil\sendSuccess().

     {
         $GLOBALS['ilLog']->write(__METHOD__ . ': Removing from repository: ' . $_REQUEST['duplicate_id']);
         include_once './Services/Tree/classes/class.ilSCTreeTasks.php';
         ilSCTreeTasks::deleteDuplicateFromTree((int) $_REQUEST['duplicate_id'], false);
 
         $tasks = new ilSCTreeTasks($this->getTask());
         if ($tasks->checkDuplicates()) {
             ilSCTreeTasks::repairPK();
         }
         
         ilUtil::sendSuccess($this->getLang()->txt('sysc_deleted_duplicate'), true);
         $this->getCtrl()->returnToParent($this);
     }

Here is the call graph for this function:

◆ deleteDuplicatesFromTrash()

ilSCTreeTasksGUI::deleteDuplicatesFromTrash ( )

protected

Definition at line 326 of file class.ilSCTreeTasksGUI.php.

References $GLOBALS, ilSCTreeTasks\deleteDuplicateFromTree(), ilSCComponentTaskGUI\getCtrl(), ilSCComponentTaskGUI\getLang(), ilSCComponentTaskGUI\getTask(), ilSCTreeTasks\repairPK(), and ilUtil\sendSuccess().

     {
         $GLOBALS['ilLog']->write(__METHOD__ . ': Removing from repository: ' . $_REQUEST['duplicate_id']);
         include_once './Services/Tree/classes/class.ilSCTreeTasks.php';
         ilSCTreeTasks::deleteDuplicateFromTree((int) $_REQUEST['duplicate_id'], true);
         
 
         $tasks = new ilSCTreeTasks($this->getTask());
         if ($tasks->checkDuplicates()) {
             ilSCTreeTasks::repairPK();
         }
 
         ilUtil::sendSuccess($this->getLang()->txt('sysc_deleted_duplicate'), true);
         $this->getCtrl()->returnToParent($this);
     }

Here is the call graph for this function:

◆ findMissing()

ilSCTreeTasksGUI::findMissing ( )

protected

find missing objects

Definition at line 345 of file class.ilSCTreeTasksGUI.php.

References ilSCComponentTaskGUI\getCtrl(), ilSCComponentTaskGUI\getLang(), ilSCComponentTaskGUI\getTask(), ilUtil\sendFailure(), ilUtil\sendSuccess(), and ilSCTask\STATUS_FAILED.

     {
         include_once './Services/Tree/classes/class.ilSCTreeTasks.php';
         $tasks = new ilSCTreeTasks($this->getTask());
         $num_failures = $tasks->findMissing();
         
         if ($this->getTask()->getStatus() == ilSCTask::STATUS_FAILED) {
             // error message
             ilUtil::sendFailure($this->getLang()->txt('sysc_tree_missing_failures') . ' ' . $num_failures, true);
         } else {
             ilUtil::sendSuccess($this->getLang()->txt('sysc_message_success'), true);
         }
         $this->getCtrl()->returnToParent($this);
     }

Here is the call graph for this function:

◆ findMissingTreeEntries()

ilSCTreeTasksGUI::findMissingTreeEntries ( )

protected

find missing objects

Definition at line 396 of file class.ilSCTreeTasksGUI.php.

References ilSCComponentTaskGUI\getCtrl(), ilSCComponentTaskGUI\getLang(), ilSCComponentTaskGUI\getTask(), ilUtil\sendFailure(), ilUtil\sendSuccess(), and ilSCTask\STATUS_FAILED.

     {
         include_once './Services/Tree/classes/class.ilSCTreeTasks.php';
         $tasks = new ilSCTreeTasks($this->getTask());
         $num_failures = $tasks->findMissingTreeEntries();
         
         if ($this->getTask()->getStatus() == ilSCTask::STATUS_FAILED) {
             // error message
             ilUtil::sendFailure($this->getLang()->txt('sysc_tree_missing_tree_failures') . ' ' . $num_failures, true);
         } else {
             ilUtil::sendSuccess($this->getLang()->txt('sysc_message_success'), true);
         }
         $this->getCtrl()->returnToParent($this);
     }

Here is the call graph for this function:

◆ getActions()

ilSCTreeTasksGUI::getActions ( )

get actions for table gui

Definition at line 81 of file class.ilSCTreeTasksGUI.php.

References array, ilSCComponentTaskGUI\getLang(), ilSCComponentTaskGUI\getTask(), and ilSCTask\STATUS_FAILED.

     {
         $repair = false;
         if ($this->getTask()->getStatus() == ilSCTask::STATUS_FAILED) {
             $repair = true;
         }
         
         $actions = array();
         switch ($this->getTask()->getIdentifier()) {
             case self::TYPE_DUPLICATES:
                 
                 $actions[] = array(
                     'txt' => $this->getLang()->txt('sysc_action_validate'),
                     'command' => 'validateDuplicates'
                 );
                 
                 if ($repair) {
                     $actions[] = array(
                         'txt' => $this->getLang()->txt('sysc_action_repair'),
                         'command' => 'repairDuplicates'
                     );
                 }
                 break;
                 
             case self::TYPE_DUMP:
                 
                 include_once './Services/Repository/classes/class.ilValidator.php';
                 $validator = new ilValidator();
                 if ($validator->hasScanLog()) {
                     $actions[] = array(
                         'txt' => $this->getLang()->txt('sysc_action_show_tree'),
                         'command' => 'showTree'
                     );
                 }
                 
                 $actions[] = array(
                     'txt' => $this->getLang()->txt('sysc_action_list_tree'),
                     'command' => 'listTree'
                 );
                 break;
                 
             case self::TYPE_MISSING:
 
                 $actions[] = array(
                     'txt' => $this->getLang()->txt('sysc_action_validate'),
                     'command' => 'findMissing'
                 );
                 
                 if ($repair) {
                     $actions[] = array(
                         'txt' => $this->getLang()->txt('sysc_action_repair'),
                         'command' => 'confirmRepairMissing'
                     );
                 }
                 break;
                 
             case self::TYPE_MISSING_TREE:
 
                 $actions[] = array(
                     'txt' => $this->getLang()->txt('sysc_action_validate'),
                     'command' => 'findMissingTreeEntries'
                 );
                 
                 if ($repair) {
                     $actions[] = array(
                         'txt' => $this->getLang()->txt('sysc_action_repair'),
                         'command' => 'confirmRepairMissingTreeEntries'
                     );
                 }
                 break;
                 
             case self::TYPE_STRUCTURE:
 
                 $actions[] = array(
                     'txt' => $this->getLang()->txt('sysc_action_validate'),
                     'command' => 'analyzeStructure'
                 );
                 
                 if ($repair) {
                     $actions[] = array(
                         'txt' => $this->getLang()->txt('sysc_action_repair'),
                         'command' => 'confirmRepairStructure'
                     );
                 }
                 break;
                 
         }
         return $actions;
     }

Here is the call graph for this function:

◆ getDescription()

ilSCTreeTasksGUI::getDescription ( )

Get title of task.

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

References ilSCComponentTaskGUI\getLang(), and ilSCComponentTaskGUI\getTask().

     {
         switch ($this->getTask()->getIdentifier()) {
             case self::TYPE_DUMP:
                 return $this->getLang()->txt('sysc_task_tree_dump_desc');
                 
             case self::TYPE_DUPLICATES:
                 return $this->getLang()->txt('sysc_task_tree_duplicates_desc');
 
             case self::TYPE_MISSING:
                 return $this->getLang()->txt('sysc_task_tree_missing_reference_desc');
 
             case self::TYPE_MISSING_TREE:
                 return $this->getLang()->txt('sysc_task_tree_missing_tree_desc');
 
             case self::TYPE_STRUCTURE:
                 return $this->getLang()->txt('sysc_task_structure_desc');
         }
     }

Here is the call graph for this function:

◆ getGroupDescription()

ilSCTreeTasksGUI::getGroupDescription ( )

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

References ilSCComponentTaskGUI\getLang().

     {
         return $this->getLang()->txt('sysc_grp_tree_desc');
     }

Here is the call graph for this function:

◆ getGroupTitle()

ilSCTreeTasksGUI::getGroupTitle ( )

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

References ilSCComponentTaskGUI\getLang().

     {
         return $this->getLang()->txt('sysc_grp_tree');
     }

Here is the call graph for this function:

◆ getTitle()

ilSCTreeTasksGUI::getTitle ( )

Get title of task.

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

References ilSCComponentTaskGUI\getLang(), and ilSCComponentTaskGUI\getTask().

     {
         switch ($this->getTask()->getIdentifier()) {
             case self::TYPE_DUMP:
                 return $this->getLang()->txt('sysc_task_tree_dump');
                 
             case self::TYPE_DUPLICATES:
                 return $this->getLang()->txt('sysc_task_tree_duplicates');
                 
             case self::TYPE_MISSING:
                 return $this->getLang()->txt('sysc_task_tree_missing_reference');
                 
             case self::TYPE_MISSING_TREE:
                 return $this->getLang()->txt('sysc_task_tree_missing_tree');
 
             case self::TYPE_STRUCTURE:
                 return $this->getLang()->txt('sysc_task_structure');
         }
     }

Here is the call graph for this function:

◆ listTree()

ilSCTreeTasksGUI::listTree ( )

List tree.

Definition at line 233 of file class.ilSCTreeTasksGUI.php.

References $GLOBALS, ilSCComponentTaskGUI\getCtrl(), ilSCComponentTaskGUI\getLang(), ilSCComponentTaskGUI\getTask(), IL_CAL_UNIX, ilUtil\sendFailure(), ilSCTask\STATUS_COMPLETED, ilSCTask\STATUS_FAILED, and time.

     {
         include_once './Services/Repository/classes/class.ilValidator.php';
         $validator = new ilValidator(true);
         $errors_count = $validator->dumpTree();
         
         
         $GLOBALS['ilLog']->write(print_r($this->getTask(), true));
         
         if ($errors_count) {
             $this->getTask()->setStatus(ilSCTask::STATUS_FAILED);
             ilUtil::sendFailure($this->getLang()->txt('sysc_tree_list_failures') . ' ' . $errors_count, true);
         } else {
             $this->getTask()->setStatus(ilSCTask::STATUS_COMPLETED);
             ilUtil::sendFailure($this->getLang()->txt('sysc_message_success'), true);
         }
         
         $this->getTask()->setLastUpdate(new ilDateTime(time(), IL_CAL_UNIX));
         $this->getTask()->update();
         
         $this->getCtrl()->returnToParent($this);
     }

Here is the call graph for this function:

◆ repairDuplicates()

ilSCTreeTasksGUI::repairDuplicates ( )

protected

repair

Parameters

type $a_task_identifier

Definition at line 297 of file class.ilSCTreeTasksGUI.php.

References $GLOBALS, $table, and ilSCTreeTasks\findDeepestDuplicate().

     {
         // repair duplicates
         include_once './Services/Tree/classes/class.ilSCTreeTasks.php';
         $deepest_duplicate = ilSCTreeTasks::findDeepestDuplicate();
         
         include_once './Services/Tree/classes/class.ilSCTreeDuplicatesTableGUI.php';
         $table = new ilSCTreeDuplicatesTableGUI($this, 'repairTask');
         $table->init();
         $table->parse($deepest_duplicate);
         
         $GLOBALS['tpl']->setContent($table->getHTML());
     }

Here is the call graph for this function:

◆ repairMissing()

ilSCTreeTasksGUI::repairMissing ( )

protected

Repair missing objects.

Definition at line 378 of file class.ilSCTreeTasksGUI.php.

References ilSCComponentTaskGUI\getCtrl(), ilSCComponentTaskGUI\getLang(), ilSCComponentTaskGUI\getTask(), IL_CAL_UNIX, ilUtil\sendSuccess(), ilSCTask\STATUS_COMPLETED, and time.

     {
         include_once './Services/Tree/classes/class.ilSCTreeTasks.php';
         $tasks = new ilSCTreeTasks($this->getTask());
         $tasks->repairMissing();
         
         
         $this->getTask()->setStatus(ilSCTask::STATUS_COMPLETED);
         $this->getTask()->setLastUpdate(new ilDateTime(time(), IL_CAL_UNIX));
         $this->getTask()->update();
         
         ilUtil::sendSuccess($this->getLang()->txt('sysc_message_success'), true);
         $this->getCtrl()->returnToParent($this);
     }

Here is the call graph for this function:

◆ repairMissingTreeEntries()

ilSCTreeTasksGUI::repairMissingTreeEntries ( )

protected

Repair missing objects.

Definition at line 427 of file class.ilSCTreeTasksGUI.php.

References ilSCComponentTaskGUI\getCtrl(), ilSCComponentTaskGUI\getLang(), ilSCComponentTaskGUI\getTask(), IL_CAL_UNIX, ilUtil\sendSuccess(), ilSCTask\STATUS_COMPLETED, and time.

     {
         include_once './Services/Tree/classes/class.ilSCTreeTasks.php';
         $tasks = new ilSCTreeTasks($this->getTask());
         $tasks->repairMissingTreeEntries();
         
         $this->getTask()->setStatus(ilSCTask::STATUS_COMPLETED);
         $this->getTask()->setLastUpdate(new ilDateTime(time(), IL_CAL_UNIX));
         $this->getTask()->update();
         
         ilUtil::sendSuccess($this->getLang()->txt('sysc_message_success'), true);
         $this->getCtrl()->returnToParent($this);
     }

Here is the call graph for this function:

◆ repairStructure()

ilSCTreeTasksGUI::repairStructure ( )

protected

Repair structure.

Definition at line 206 of file class.ilSCTreeTasksGUI.php.

References $GLOBALS, ilMaterializedPathTree\createFromParentReleation(), ilSCComponentTaskGUI\getCtrl(), ilSCComponentTaskGUI\getLang(), ilSCComponentTaskGUI\getTask(), IL_CAL_UNIX, ilUtil\sendSuccess(), ilSCTask\STATUS_COMPLETED, and time.

     {
         include_once './Services/Tree/classes/class.ilSCTreeTasks.php';
         $tasks = new ilSCTreeTasks($this->getTask());
         
         
         if ($GLOBALS['tree']->getTreeImplementation() instanceof ilMaterializedPathTree) {
             ilMaterializedPathTree::createFromParentReleation();
         } elseif ($GLOBALS['tree']->getTreeImplementation() instanceof ilNestedSetTree) {
             $GLOBALS['tree']->renumber(ROOT_FOLDER_ID);
         }
         
         $this->getTask()->setStatus(ilSCTask::STATUS_COMPLETED);
         $this->getTask()->setLastUpdate(new ilDateTime(time(), IL_CAL_UNIX));
         $this->getTask()->update();
         
         ilUtil::sendSuccess($this->getLang()->txt('sysc_message_success'), true);
         $this->getCtrl()->returnToParent($this);
     }

Here is the call graph for this function:

◆ showTree()

ilSCTreeTasksGUI::showTree ( )

Show already scanned tree.

Definition at line 259 of file class.ilSCTreeTasksGUI.php.

References $GLOBALS.

     {
         include_once "./Services/Repository/classes/class.ilValidator.php";
         $validator = new ilValidator();
         $scan_log = $validator->readScanLog();
 
         if (is_array($scan_log)) {
             $scan_log = '<pre>' . implode("", $scan_log) . '</pre>';
             $GLOBALS['tpl']->setContent($scan_log);
         }
     }

◆ validateDuplicates()

ilSCTreeTasksGUI::validateDuplicates ( )

start task

Parameters

type $a_task_identifier

Definition at line 276 of file class.ilSCTreeTasksGUI.php.

References ilSCComponentTaskGUI\getCtrl(), ilSCComponentTaskGUI\getLang(), ilSCComponentTaskGUI\getTask(), ilUtil\sendFailure(), ilUtil\sendSuccess(), and ilSCTask\STATUS_FAILED.

     {
         include_once './Services/Tree/classes/class.ilSCTreeTasks.php';
         $tasks = new ilSCTreeTasks($this->getTask());
         $num_failures = $tasks->validateDuplicates();
         
         if ($this->getTask()->getStatus() == ilSCTask::STATUS_FAILED) {
             // error message
             ilUtil::sendFailure($this->getLang()->txt('sysc_tree_duplicate_failures') . ' ' . $num_failures, true);
         } else {
             ilUtil::sendSuccess($this->getLang()->txt('sysc_message_success'), true);
         }
         $this->getCtrl()->returnToParent($this);
     }

Here is the call graph for this function:

Field Documentation

◆ TYPE_DUMP

const ilSCTreeTasksGUI::TYPE_DUMP = 'dump'

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

◆ TYPE_DUPLICATES

const ilSCTreeTasksGUI::TYPE_DUPLICATES = 'duplicates'

Definition at line 15 of file class.ilSCTreeTasksGUI.php.

◆ TYPE_MISSING

const ilSCTreeTasksGUI::TYPE_MISSING = 'missing_reference'

Definition at line 17 of file class.ilSCTreeTasksGUI.php.

◆ TYPE_MISSING_TREE

const ilSCTreeTasksGUI::TYPE_MISSING_TREE = 'missing_tree'

Definition at line 18 of file class.ilSCTreeTasksGUI.php.

◆ TYPE_STRUCTURE

const ilSCTreeTasksGUI::TYPE_STRUCTURE = 'structure'

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

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

Services/Tree/classes/class.ilSCTreeTasksGUI.php

Public Member Functions

Data Fields

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ analyzeStructure()

◆ confirmRepairMissing()

◆ confirmRepairMissingTreeEntries()

◆ confirmRepairStructure()

◆ deleteDuplicatesFromRepository()

◆ deleteDuplicatesFromTrash()

◆ findMissing()

◆ findMissingTreeEntries()

◆ getActions()

◆ getDescription()

◆ getGroupDescription()

◆ getGroupTitle()

◆ getTitle()

◆ listTree()

◆ repairDuplicates()

◆ repairMissing()

◆ repairMissingTreeEntries()

◆ repairStructure()

◆ showTree()

◆ validateDuplicates()

Field Documentation

◆ TYPE_DUMP

◆ TYPE_DUPLICATES

◆ TYPE_MISSING

◆ TYPE_MISSING_TREE

◆ TYPE_STRUCTURE