ilSCTreeTasksGUI Class Reference

Handles tree tasks. More...

Inheritance diagram for ilSCTreeTasksGUI:

Collaboration diagram for ilSCTreeTasksGUI:

Public Member Functions
	__construct (ilSCTask $task=null)
	getGroupTitle ()
	getGroupDescription ()
	getTitle ()
	getDescription ()
	getActions ()
	analyzeStructure ()
	listTree ()
	showTree ()
	validateDuplicates ()
Public Member Functions inherited from ilSCComponentTaskGUI
	__construct (ilSCTask $task=null)
	getActions ()
	array( 'txt' => $lng->txt('sysc_action_repair') 'command' => 'repairTask' ); More...
	getTitle ()
	getDescription ()
	getGroupTitle ()
	getGroupDescription ()
	getTask ()
	executeCommand ()

Data Fields
const	TYPE_DUMP = 'dump'

Protected Member Functions
	getDuplicateIdFromRequest ()
	confirmRepairStructure ()
	repairStructure ()
	repairDuplicates ()
	deleteDuplicatesFromRepository ()
	deleteDuplicatesFromTrash ()
	findMissing ()
	confirmRepairMissing ()
	repairMissing ()
	findMissingTreeEntries ()
	confirmRepairMissingTreeEntries ()
	repairMissingTreeEntries ()
Protected Member Functions inherited from ilSCComponentTaskGUI
	getLang ()
	getCtrl ()
	showSimpleConfirmation (string $a_text, string $a_btn_text, string $a_cmd)
	cancel ()

Protected Attributes
const	TYPE_DUPLICATES = 'duplicates'
const	TYPE_MISSING = 'missing_reference'
const	TYPE_MISSING_TREE = 'missing_tree'
const	TYPE_STRUCTURE = 'structure'
ilTree	$tree
GlobalHttpState	$http
Factory	$refinery
Protected Attributes inherited from ilSCComponentTaskGUI
ilCtrl	$ctrl
ilLanguage	$lng
ilGlobalTemplateInterface	$tpl
ilSCTask	$task

Private Attributes
ilDBInterface	$db

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 29 of file class.ilSCTreeTasksGUI.php.

Constructor & Destructor Documentation

__construct()

ilSCTreeTasksGUI::__construct

(

ilSCTask

$task = null

)

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

References $DIC, ilSCComponentTaskGUI\$task, ILIAS\GlobalScreen\Provider\__construct(), ILIAS\FileDelivery\http(), and ILIAS\Repository\refinery().

    {
        global $DIC;
        parent::__construct($task);

        $this->tree = $DIC->repositoryTree();
        $this->http = $DIC->http();
        $this->refinery = $DIC->refinery();
        $this->db = $DIC->database();
    }

Here is the call graph for this function:

Member Function Documentation

analyzeStructure()

ilSCTreeTasksGUI::analyzeStructure

(

)

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

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

                                      : void
    {
        $tasks = new ilSCTreeTasks($this->getTask());
        $num_failures = $tasks->validateStructure();

        if ($this->getTask()->getStatus() == ilSCTask::STATUS_FAILED) {
            // error message
            $this->tpl->setOnScreenMessage('failure', $this->getLang()->txt('sysc_tree_structure_failures') . ' ' . $num_failures, true);
        } else {
            $this->tpl->setOnScreenMessage('success', $this->getLang()->txt('sysc_message_success'), true);
        }
        $this->getCtrl()->returnToParent($this);
    }

Here is the call graph for this function:

confirmRepairMissing()

ilSCTreeTasksGUI::confirmRepairMissing ( )

protected

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

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

                                             : void
    {
        $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

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

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

                                                        : void
    {
        $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

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

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

                                               : void
    {
        $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 301 of file class.ilSCTreeTasksGUI.php.

References ilSCTreeTasks\deleteDuplicateFromTree(), ilSCComponentTaskGUI\getCtrl(), getDuplicateIdFromRequest(), ilSCComponentTaskGUI\getLang(), ilSCComponentTaskGUI\getTask(), and ilSCTreeTasks\repairPK().

                                                       : void
    {
        ilSCTreeTasks::deleteDuplicateFromTree($this->getDuplicateIdFromRequest(), false);

        $tasks = new ilSCTreeTasks($this->getTask());
        if ($tasks->checkDuplicates()) {
            ilSCTreeTasks::repairPK();
        }

        $this->tpl->setOnScreenMessage('success', $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 314 of file class.ilSCTreeTasksGUI.php.

References ilSCTreeTasks\deleteDuplicateFromTree(), ilSCComponentTaskGUI\getCtrl(), getDuplicateIdFromRequest(), ilSCComponentTaskGUI\getLang(), ilSCComponentTaskGUI\getTask(), and ilSCTreeTasks\repairPK().

                                                  : void
    {
        ilSCTreeTasks::deleteDuplicateFromTree($this->getDuplicateIdFromRequest(), true);

        $tasks = new ilSCTreeTasks($this->getTask());
        if ($tasks->checkDuplicates()) {
            ilSCTreeTasks::repairPK();
        }

        $this->tpl->setOnScreenMessage('success', $this->getLang()->txt('sysc_deleted_duplicate'), true);
        $this->getCtrl()->returnToParent($this);
    }

Here is the call graph for this function:

findMissing()

ilSCTreeTasksGUI::findMissing ( )

protected

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

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

                                    : void
    {
        $tasks = new ilSCTreeTasks($this->getTask());
        $num_failures = $tasks->findMissing();

        if ($this->getTask()->getStatus() == ilSCTask::STATUS_FAILED) {
            // error message
            $this->tpl->setOnScreenMessage('failure', $this->getLang()->txt('sysc_tree_missing_failures') . ' ' . $num_failures, true);
        } else {
            $this->tpl->setOnScreenMessage('success', $this->getLang()->txt('sysc_message_success'), true);
        }
        $this->getCtrl()->returnToParent($this);
    }

Here is the call graph for this function:

findMissingTreeEntries()

ilSCTreeTasksGUI::findMissingTreeEntries ( )

protected

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

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

                                               : void
    {
        $tasks = new ilSCTreeTasks($this->getTask());
        $num_failures = $tasks->findMissingTreeEntries();

        if ($this->getTask()->getStatus() == ilSCTask::STATUS_FAILED) {
            // error message
            $this->tpl->setOnScreenMessage('failure', $this->getLang()->txt('sysc_tree_missing_tree_failures') . ' ' . $num_failures, true);
        } else {
            $this->tpl->setOnScreenMessage('success', $this->getLang()->txt('sysc_message_success'), true);
        }
        $this->getCtrl()->returnToParent($this);
    }

Here is the call graph for this function:

getActions()

ilSCTreeTasksGUI::getActions

(

)

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

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

                                : array
    {
        $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:

                $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

(

)

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

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

                                    : string
    {
        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');
        }
        return '';
    }

Here is the call graph for this function:

getDuplicateIdFromRequest()

ilSCTreeTasksGUI::getDuplicateIdFromRequest ( )

protected

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

References ILIAS\FileDelivery\http(), and ILIAS\Repository\refinery().

Referenced by deleteDuplicatesFromRepository(), and deleteDuplicatesFromTrash().

                                                  : int
    {
        if ($this->http->wrapper()->query()->has('duplicate_id')) {
            return $this->http->wrapper()->query()->retrieve(
                'duplicate_id',
                $this->refinery->kindlyTo()->int()
            );
        }
        return 0;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getGroupDescription()

ilSCTreeTasksGUI::getGroupDescription

(

)

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

References ilSCComponentTaskGUI\getLang().

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

Here is the call graph for this function:

getGroupTitle()

ilSCTreeTasksGUI::getGroupTitle

(

)

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

References ilSCComponentTaskGUI\getLang().

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

Here is the call graph for this function:

getTitle()

ilSCTreeTasksGUI::getTitle

(

)

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

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

                              : string
    {
        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');
        }
        return '';
    }

Here is the call graph for this function:

listTree()

ilSCTreeTasksGUI::listTree

(

)

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

References ilSCComponentTaskGUI\getCtrl(), ilSCComponentTaskGUI\getLang(), ilSCComponentTaskGUI\getTask(), IL_CAL_UNIX, ilSCTask\STATUS_COMPLETED, and ilSCTask\STATUS_FAILED.

                              : void
    {
        $validator = new ilValidator(true);
        $errors_count = $validator->dumpTree();

        if ($errors_count) {
            $this->getTask()->setStatus(ilSCTask::STATUS_FAILED);
            $this->tpl->setOnScreenMessage('failure', $this->getLang()->txt('sysc_tree_list_failures') . ' ' . $errors_count, true);
        } else {
            $this->getTask()->setStatus(ilSCTask::STATUS_COMPLETED);
            $this->tpl->setOnScreenMessage('failure', $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

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

References ilSCTreeTasks\findDeepestDuplicate().

                                         : void
    {
        $deepest_duplicate = ilSCTreeTasks::findDeepestDuplicate();

        $table = new ilSCTreeDuplicatesTableGUI($this, 'repairTask');
        $table->init();
        $table->parse($deepest_duplicate);

        $this->tpl->setContent($table->getHTML());
    }

Here is the call graph for this function:

repairMissing()

ilSCTreeTasksGUI::repairMissing ( )

protected

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

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

                                      : void
    {
        $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();

        $this->tpl->setOnScreenMessage('success', $this->getLang()->txt('sysc_message_success'), true);
        $this->getCtrl()->returnToParent($this);
    }

Here is the call graph for this function:

repairMissingTreeEntries()

ilSCTreeTasksGUI::repairMissingTreeEntries ( )

protected

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

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

                                                 : void
    {
        $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();

        $this->tpl->setOnScreenMessage('success', $this->getLang()->txt('sysc_message_success'), true);
        $this->getCtrl()->returnToParent($this);
    }

Here is the call graph for this function:

repairStructure()

ilSCTreeTasksGUI::repairStructure ( )

protected

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

References ilMaterializedPathTree\createFromParentRelation(), ilSCComponentTaskGUI\getCtrl(), ilSCComponentTaskGUI\getLang(), ilSCComponentTaskGUI\getTask(), IL_CAL_UNIX, ROOT_FOLDER_ID, and ilSCTask\STATUS_COMPLETED.

                                        : void
    {
        $tasks = new ilSCTreeTasks($this->getTask());

        if ($this->tree->getTreeImplementation() instanceof ilMaterializedPathTree) {
            ilMaterializedPathTree::createFromParentRelation($this->db);
        } elseif ($this->tree->getTreeImplementation() instanceof ilNestedSetTree) {
            $this->tree->renumber(ROOT_FOLDER_ID);
        }

        $this->getTask()->setStatus(ilSCTask::STATUS_COMPLETED);
        $this->getTask()->setLastUpdate(new ilDateTime(time(), IL_CAL_UNIX));
        $this->getTask()->update();

        $this->tpl->setOnScreenMessage('success', $this->getLang()->txt('sysc_message_success'), true);
        $this->getCtrl()->returnToParent($this);
    }

Here is the call graph for this function:

showTree()

ilSCTreeTasksGUI::showTree

(

)

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

                              : void
    {
        $validator = new ilValidator();
        $scan_log = $validator->readScanLog();

        if (is_array($scan_log)) {
            $scan_log = '<pre>' . implode("", $scan_log) . '</pre>';
            $this->tpl->setContent($scan_log);
        }
    }

validateDuplicates()

ilSCTreeTasksGUI::validateDuplicates

(

)

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

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

                                        : void
    {
        $tasks = new ilSCTreeTasks($this->getTask());
        $num_failures = $tasks->validateDuplicates();

        if ($this->getTask()->getStatus() == ilSCTask::STATUS_FAILED) {
            // error message
            $this->tpl->setOnScreenMessage('failure', $this->getLang()->txt('sysc_tree_duplicate_failures') . ' ' . $num_failures, true);
        } else {
            $this->tpl->setOnScreenMessage('success', $this->getLang()->txt('sysc_message_success'), true);
        }
        $this->getCtrl()->returnToParent($this);
    }

Here is the call graph for this function:

Field Documentation

$db

ilDBInterface ilSCTreeTasksGUI::$db

private

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

$http

GlobalHttpState ilSCTreeTasksGUI::$http

protected

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

$refinery

Factory ilSCTreeTasksGUI::$refinery

protected

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

$tree

ilTree ilSCTreeTasksGUI::$tree

protected

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

TYPE_DUMP

const ilSCTreeTasksGUI::TYPE_DUMP = 'dump'

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

Referenced by ilSCComponentTaskFactory\getTask().

TYPE_DUPLICATES

const ilSCTreeTasksGUI::TYPE_DUPLICATES = 'duplicates'

protected

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

TYPE_MISSING

const ilSCTreeTasksGUI::TYPE_MISSING = 'missing_reference'

protected

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

TYPE_MISSING_TREE

const ilSCTreeTasksGUI::TYPE_MISSING_TREE = 'missing_tree'

protected

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

TYPE_STRUCTURE

const ilSCTreeTasksGUI::TYPE_STRUCTURE = 'structure'

protected

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

---

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

• Services/Tree/classes/SystemCheck/class.ilSCTreeTasksGUI.php