ilObjSystemCheckGUI Class Reference

Inheritance diagram for ilObjSystemCheckGUI:

Collaboration diagram for ilObjSystemCheckGUI:

Public Member Functions
	__construct ($a_data, $a_id, $a_call_by_reference, $a_prepare_output=true)
	getLang ()
	Get language obj. More...
	executeCommand ()
	ilCtrl execute command More...
Public Member Functions inherited from ilObjectGUI
	executeCommand ()
	execute command More...
	withReferences ()
	determines wether objects are referenced or not (got ref ids or not) More...
	setCreationMode ($a_mode=true)
	if true, a creation screen is displayed the current $_GET[ref_id] don't belong to the current class! the mode is determined in ilrepositorygui More...
	getCreationMode ()
	get creation mode More...
	prepareOutput ($a_show_subobjects=true)
	prepare output More...
	getAdminTabs ()
	administration tabs show only permissions and trash folder More...
	getHTML ()
	confirmedDeleteObject ()
	confirmed deletion of object -> objects are moved to trash or deleted immediately, if trash is disabled More...
	cancelDeleteObject ()
	cancel deletion of object More...
	cancelObject ()
	cancel action and go back to previous page public More...
	createObject ()
	create new object form More...
	cancelCreation ()
	cancel create action and go back to repository parent More...
	saveObject ()
	save object More...
	getDidacticTemplateVar ($a_type)
	Get didactic template setting from creation screen. More...
	putObjectInTree (ilObject $a_obj, $a_parent_node_id=null)
	Add object to tree at given position. More...
	editObject ()
	edit object More...
	addExternalEditFormCustom (ilPropertyFormGUI $a_form)
	updateObject ()
	updates object entry in object_data More...
	getFormAction ($a_cmd, $a_formaction="")
	get form action for command (command is method name without "Object", e.g. More...
	isVisible ($a_ref_id, $a_type)
	viewObject ()
	list childs of current object More...
	deleteObject ($a_error=false)
	Display deletion confirmation screen. More...
	cloneAllObject ()
	Clone single (not container object) Method is overwritten in ilContainerGUI. More...

Data Fields
const	SECTION_MAIN = 'main'
const	SECTION_GROUP = 'group'
	$ctrl
Data Fields inherited from ilObjectGUI
const	COPY_WIZARD_NEEDS_PAGE = 1
	$objDefinition
	$tpl
	$tree
	$lng
	$data
	$object
	$ref_id
	$obj_id
	$maxcount
	$formaction
	$return_location
	$target_frame
	$tab_target_script
	$actions
	$sub_objects
	$omit_locator = false
const	CFORM_NEW = 1
const	CFORM_IMPORT = 2
const	CFORM_CLONE = 3

Protected Member Functions
	overview ()
	Show overview table. More...
	showGroup ()
	Show group tasks. More...
	trash (ilPropertyFormGUI $form=null)
	Show trash form. More...
	initFormTrash ()
	Show trash restore form. More...
	handleTrashAction ()
	Handle Trash action. More...
	setSubTabs ($a_section, $a_active)
	Set subtabs. More...
Protected Member Functions inherited from ilObjectGUI
	assignObject ()
	setTitleAndDescription ()
	called by prepare output More...
	initHeaderAction ($a_sub_type=null, $a_sub_id=null)
	Add header action menu. More...
	insertHeaderAction ($a_list_gui)
	Insert header action into main template. More...
	addHeaderAction ()
	Add header action menu. More...
	redrawHeaderActionObject ()
	Ajax call: redraw action header only. More...
	showMountWebfolderIcon ()
	setTabs ()
	set admin tabs public More...
	setAdminTabs ()
	set admin tabs public More...
	setLocator ()
	set Locator More...
	addLocatorItems ()
	should be overwritten to add object specific items (repository items are preloaded) More...
	omitLocator ($a_omit=true)
	addAdminLocatorItems ($a_do_not_add_object=false)
	should be overwritten to add object specific items (repository items are preloaded) More...
	initCreationForms ($a_new_type)
	Init creation froms. More...
	getCreationFormsHTML (array $a_forms)
	Get HTML for creation forms (accordion) More...
	initCreateForm ($a_new_type)
	Init object creation form. More...
	initDidacticTemplate (ilPropertyFormGUI $form)
	Show didactic template types. More...
	addDidacticTemplateOptions (array &$a_options)
	Add custom templates. More...
	afterSave (ilObject $a_new_object)
	Post (successful) object creation hook. More...
	initEditForm ()
	Init object edit form. More...
	initEditCustomForm (ilPropertyFormGUI $a_form)
	Add custom fields to update form. More...
	getEditFormValues ()
	Get values for edit form. More...
	getEditFormCustomValues (array &$a_values)
	Add values to custom edit fields. More...
	validateCustom (ilPropertyFormGUI $a_form)
	Validate custom values (if not possible with checkInput()) More...
	updateCustom (ilPropertyFormGUI $a_form)
	Insert custom update form values into object. More...
	afterUpdate ()
	Post (successful) object update hook. More...
	initImportForm ($a_new_type)
	Init object import form. More...
	importFileObject ($parent_id=null, $a_catch_errors=true)
	Import. More...
	afterImport (ilObject $a_new_object)
	Post (successful) object import hook. More...
	setFormAction ($a_cmd, $a_formaction)
	set specific form action for command More...
	getReturnLocation ($a_cmd, $a_location="")
	get return location for command (command is method name without "Object", e.g. More...
	setReturnLocation ($a_cmd, $a_location)
	set specific return location for command More...
	getTargetFrame ($a_cmd, $a_target_frame="")
	get target frame for command (command is method name without "Object", e.g. More...
	setTargetFrame ($a_cmd, $a_target_frame)
	set specific target frame for command More...
	showPossibleSubObjects ()
	show possible subobjects (pulldown menu) More...
	getTemplateFile ($a_cmd, $a_type="")
	get a template blockfile format: tpl. More...
	getTabs ()
	get tabs abstract method. More...
	__showButton ($a_cmd, $a_text, $a_target='')
	hitsperpageObject ()
&	__initTableGUI ()
	__setTableGUIBasicData (&$tbl, &$result_set, $a_from="")
	standard implementation for tables use 'from' variable use different initial setting of table More...
	redirectToRefId ($a_ref_id, $a_cmd="")
	redirects to (repository) view per ref id usually to a container and usually used at the end of a save/import method where the object gui type (of the new object) doesn't match with the type of the current $_GET["ref_id"] value More...
	fillCloneTemplate ($a_tpl_varname, $a_type)
	Fill object clone template This method can be called from any object GUI class that wants to offer object cloning. More...
	getCenterColumnHTML ()
	Get center column. More...
	getRightColumnHTML ()
	Display right column. More...
	setColumnSettings (ilColumnGUI $column_gui)
	May be overwritten in subclasses. More...
	checkPermission ($a_perm, $a_cmd="", $a_type="", $a_ref_id=null)
	Check permission and redirect on error. More...
	checkPermissionBool ($a_perm, $a_cmd="", $a_type="", $a_ref_id=null)
	Check permission. More...
	enableDragDropFileUpload ()
	Enables the file upload into this object by dropping files. More...
	handleAutoRating (ilObject $a_new_obj)
	Activate rating automatically if parent container setting. More...

Additional Inherited Members
Static Public Member Functions inherited from ilObjectGUI
static	_gotoRepositoryRoot ($a_raise_error=false)
	Goto repository root. More...
static	_gotoRepositoryNode ($a_ref_id, $a_cmd="frameset")
	Goto repository root. More...
Protected Attributes inherited from ilObjectGUI
	$ilErr
	$locator
	$user
	$access
	$settings
	$rbacreview
	$toolbar
	$rbacsystem
	$tmp_import_dir
	$tabs_gui = null
	$ctrl

Detailed Description

Author

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

Version

$Id$ ilObjSystemCheckGUI: ilPermissionGUI, ilObjectOwnershipManagementGUI, ilObjSystemFolderGUI, ilSCComponentTasksGUI ilObjSystemCheckGUI: ilAdministrationGUI

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

Constructor & Destructor Documentation

__construct()

ilObjSystemCheckGUI::__construct	(		$a_data,
			$a_id,
			$a_call_by_reference,
			$a_prepare_output = true
	)

Parameters

	$a_data
	$a_id
	$a_call_by_reference
bool	$a_prepare_output

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

    {
        $this->type = 'sysc';
        parent::__construct($a_data, $a_id, $a_call_by_reference, $a_prepare_output);
        $this->lng->loadLanguageModule('sysc');
    }

Member Function Documentation

executeCommand()

ilObjSystemCheckGUI::executeCommand

(

)

ilCtrl execute command

Definition at line 52 of file class.ilObjSystemCheckGUI.php.

References $GLOBALS, $handler, ilObjectGUI\$rbacsystem, array, ilObjectGUI\getAdminTabs(), ilSCComponentTaskFactory\getComponentTask(), ilObjectGUI\prepareOutput(), and setSubTabs().

    {
        $next_class = $this->ctrl->getNextClass($this);
        $cmd        = $this->ctrl->getCmd();
        $this->prepareOutput();

        switch ($next_class) {
            case "ilobjectownershipmanagementgui":
                $this->setSubTabs(self::SECTION_MAIN, 'no_owner');
                include_once 'Services/Object/classes/class.ilObjectOwnershipManagementGUI.php';
                $gui = new ilObjectOwnershipManagementGUI(0);
                $this->ctrl->forwardCommand($gui);
                break;
            
            case 'ilobjsystemfoldergui':
                include_once './Modules/SystemFolder/classes/class.ilObjSystemFolderGUI.php';
                $sys_folder = new ilObjSystemFolderGUI('', SYSTEM_FOLDER_ID, true);
                $this->ctrl->forwardCommand($sys_folder);
                
                $GLOBALS['ilTabs']->clearTargets();
                
                $this->setSubTabs(self::SECTION_MAIN, 'sc');
                break;
            
            case 'ilpermissiongui':
                $this->tabs_gui->setTabActive('perm_settings');
                require_once 'Services/AccessControl/classes/class.ilPermissionGUI.php';
                $perm_gui = new ilPermissionGUI($this);
                $this->ctrl->forwardCommand($perm_gui);
                break;

            case '':
            case 'ilobjsystemcheckgui':
                if ($cmd == '' || $cmd == 'view') {
                    $cmd = 'overview';
                }
                $this->$cmd();
                break;
                
            default:
                // Forward to task handler
                include_once './Services/SystemCheck/classes/class.ilSCComponentTaskFactory.php';
                $this->ctrl->saveParameter($this, 'grp_id');
                $this->ctrl->saveParameter($this, 'task_id');
                $this->ctrl->setReturn($this, 'showGroup');
                $GLOBALS['ilTabs']->clearTargets();
                $GLOBALS['ilTabs']->setBackTarget($this->lng->txt('back'), $this->ctrl->getLinkTarget($this, 'showGroup'));
                $handler = ilSCComponentTaskFactory::getComponentTask((int) $_REQUEST['task_id']);
                $this->ctrl->forwardCommand($handler);
                break;
                
                
        }
    }

Here is the call graph for this function:

getLang()

ilObjSystemCheckGUI::getLang

(

)

Get language obj.

Returns

ilLanguage

Definition at line 44 of file class.ilObjSystemCheckGUI.php.

References ilObjectGUI\$lng.

Referenced by overview(), and setSubTabs().

    {
        return $this->lng;
    }

Here is the caller graph for this function:

handleTrashAction()

ilObjSystemCheckGUI::handleTrashAction ( )

protected

Handle Trash action.

Definition at line 255 of file class.ilObjSystemCheckGUI.php.

References $form, array, initFormTrash(), ilSystemCheckTrash\MODE_TRASH_REMOVE, ilUtil\sendFailure(), ilUtil\sendSuccess(), and trash().

    {
        $form = $this->initFormTrash();
        if ($form->checkInput()) {
            $trash = new ilSystemCheckTrash();
            $trash->setMode(ilSystemCheckTrash::MODE_TRASH_REMOVE);
            $dt = $form->getItemByPostVar('age')->getDate();
            if ($dt) {
                $trash->setAgeLimit($dt);
            }
            $trash->setNumberLimit($form->getInput('number'));
            
            if ($form->getInput('types')) {
                $trash->setTypesLimit((array) $form->getInput('types'));
            }
            $trash->setMode($form->getInput('type'));
            $trash->start();
            
            ilUtil::sendSuccess($this->lng->txt('settings_saved'), true);
            $form->setValuesByPost();
            $this->trash($form);
            return true;
        }
        
        ilUtil::sendFailure($this->lng->txt('err_check_input'));
        $form->setValuesByPost();
        $this->trash($form);
        return false;
    }

Here is the call graph for this function:

initFormTrash()

ilObjSystemCheckGUI::initFormTrash ( )

protected

Show trash restore form.

Returns

ilPropertyFormGUI

Definition at line 186 of file class.ilObjSystemCheckGUI.php.

References $action, $form, $GLOBALS, $options, ilObjectGUI\$sub_objects, array, ilSystemCheckTrash\MODE_TRASH_REMOVE, ilSystemCheckTrash\MODE_TRASH_RESTORE, ilRadioOption\setInfo(), and ilFormPropertyGUI\setInfo().

Referenced by handleTrashAction(), and trash().

    {
        include_once './Services/Form/classes/class.ilPropertyFormGUI.php';
        $form = new ilPropertyFormGUI();
        $form->setFormAction($this->ctrl->getFormAction($this));
        
        $form->setTitle($this->lng->txt('sysc_administrate_deleted'));
        
        $action = new ilRadioGroupInputGUI($this->lng->txt('sysc_trash_action'), 'type');
        $action->setRequired(true);
        
        // Restore
        $restore = new ilRadioOption($this->lng->txt('sysc_trash_restore'), ilSystemCheckTrash::MODE_TRASH_RESTORE);
        $restore->setInfo($this->lng->txt('sysc_trash_restore_info'));
        $action->addOption($restore);
        
        // Remove
        $remove = new ilRadioOption($this->lng->txt('sysc_trash_remove'), ilSystemCheckTrash::MODE_TRASH_REMOVE);
        $remove->setInfo($this->lng->txt('sysc_trash_remove_info'));
        $action->addOption($remove);
        
        // limit number
        $num = new ilNumberInputGUI($this->lng->txt('sysc_trash_limit_num'), 'number');
        $num->setInfo($this->lng->txt('purge_count_limit_desc'));
        $num->setSize(10);
        $num->setMinValue(1);
        $remove->addSubItem($num);
        
        $age = new ilDateTimeInputGUI($this->lng->txt('sysc_trash_limit_age'), 'age');
        $age->setInfo($this->lng->txt('purge_age_limit_desc'));
        $age->setMinuteStepSize(15);
        #$earlier = new ilDateTime(time(),IL_CAL_UNIX);
        #$earlier->increment(IL_CAL_MONTH,-6);
        #$age->setDate($earlier);
        $remove->addSubItem($age);
        
        // limit types
        $types = new ilSelectInputGUI($this->lng->txt('sysc_trash_limit_type'), 'types');
        /*
         * @var ilObjDefinition
         */
        $sub_objects = $GLOBALS['tree']->lookupTrashedObjectTypes();
        
        $options = array();
        $options[0] = '';
        foreach ($sub_objects as $obj_type) {
            if (!$GLOBALS['objDefinition']->isRBACObject($obj_type) or !$GLOBALS['objDefinition']->isAllowedInRepository($obj_type)) {
                continue;
            }
            $options[$obj_type] = $this->lng->txt('obj_' . $obj_type);
        }
        
        asort($options);
        
        $types->setOptions($options);
        $remove->addSubItem($types);
        
        $form->addItem($action);
        
        
        $form->addCommandButton('handleTrashAction', $this->lng->txt('start_scan'));
        $form->addCommandButton('', $this->lng->txt('cancel'));
        
        return $form;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

overview()

ilObjSystemCheckGUI::overview ( )

protected

Show overview table.

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

References $GLOBALS, $table, getLang(), and setSubTabs().

    {
        $this->getLang()->loadLanguageModule('sysc');
        
        
        $this->setSubTabs(self::SECTION_MAIN, 'overview');
        
        
        include_once 'Services/SystemCheck/classes/class.ilSCGroupTableGUI.php';
        
        $table = new ilSCGroupTableGUI($this, 'overview');
        $table->init();
        $table->parse();
        
        $GLOBALS['tpl']->setContent($table->getHTML());
        return true;
    }

Here is the call graph for this function:

setSubTabs()

ilObjSystemCheckGUI::setSubTabs (   $a_section,   $a_active  )

protected

Set subtabs.

Parameters

type

$a_section

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

References $GLOBALS, and getLang().

Referenced by executeCommand(), overview(), showGroup(), and trash().

    {
        switch ($a_section) {
            case self::SECTION_MAIN:
                $GLOBALS['ilTabs']->addSubTab(
                    '',
                    $this->getLang()->txt('sysc_groups'),
                    $this->ctrl->getLinkTarget($this, 'overview')
                );
                $GLOBALS['ilTabs']->addSubTab(
                    'trash',
                    $this->getLang()->txt('sysc_tab_trash'),
                    $this->ctrl->getLinkTarget($this, 'trash')
                );
                $GLOBALS['ilTabs']->addSubTab(
                    'no_owner',
                    $this->getLang()->txt('system_check_no_owner'),
                    $this->ctrl->getLinkTargetByClass('ilobjectownershipmanagementgui')
                );
                break;
            
            case self::SECTION_GROUP:
                $GLOBALS['ilTabs']->clearTargets();
                $GLOBALS['ilTabs']->setBackTarget(
                    $this->lng->txt('back'),
                    $this->ctrl->getLinkTarget($this, 'overview')
                );
        }
        $GLOBALS['ilTabs']->activateSubTab($a_active);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

showGroup()

ilObjSystemCheckGUI::showGroup ( )

protected

Show group tasks.

Definition at line 150 of file class.ilObjSystemCheckGUI.php.

References $GLOBALS, $table, and setSubTabs().

    {
        $this->setSubTabs(self::SECTION_GROUP, '');
        
        $grp_id = (int) $_REQUEST['grp_id'];
        $this->ctrl->saveParameter($this, 'grp_id');
        
        include_once 'Services/SystemCheck/classes/class.ilSCTaskTableGUI.php';
        $table = new ilSCTaskTableGUI($grp_id, $this, 'showGroup');
        $table->init();
        $table->parse();
        
        $GLOBALS['tpl']->setContent($table->getHTML());
        return true;
    }

Here is the call graph for this function:

trash()

ilObjSystemCheckGUI::trash ( ilPropertyFormGUI  $form = null )

protected

Show trash form.

Parameters

ilPropertyFormGUI

$form

Definition at line 173 of file class.ilObjSystemCheckGUI.php.

References $form, $GLOBALS, initFormTrash(), and setSubTabs().

Referenced by handleTrashAction().

    {
        $this->setSubTabs(self::SECTION_MAIN, 'trash');
        if (!$form instanceof ilPropertyFormGUI) {
            $form = $this->initFormTrash();
        }
        $GLOBALS['tpl']->setContent($form->getHTML());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$ctrl

ilObjSystemCheckGUI::$ctrl

Definition at line 25 of file class.ilObjSystemCheckGUI.php.

SECTION_GROUP

const ilObjSystemCheckGUI::SECTION_GROUP = 'group'

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

SECTION_MAIN

const ilObjSystemCheckGUI::SECTION_MAIN = 'main'

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

---

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

• Services/SystemCheck/classes/class.ilObjSystemCheckGUI.php