ilDidacticTemplateSettingsGUI Class Reference

Settings for a single didactic template. More...

Collaboration diagram for ilDidacticTemplateSettingsGUI:

Public Member Functions
	__construct ($a_parent_obj)
	Constructor. More...
	executeCommand ()
	Execute command. More...

Protected Member Functions
	overview ()
	Show didactic template administration. More...
	showImportForm (ilPropertyFormGUI $form=NULL)
	Show template import form. More...
	createImportForm ()
	Create template import form. More...
	importTemplate ()
	Import template. More...
	editTemplate (ilPropertyFormGUI $form=null)
	Edit template. More...
	updateTemplate ()
	Update template. More...
	initEditTemplate (ilDidacticTemplateSetting $set)
	Init edit template form. More...
	copyTemplate ()
	Copy on template. More...
	exportTemplate ()
	Export one template. More...
	confirmDelete ()
	Show delete confirmation screen. More...
	deleteTemplates ()
	Delete chosen didactic templates @global ilErrorHandling $ilErr @global ilCtrl $ilCtrl. More...
	activateTemplates ()
	Activate didactic templates @global ilErrorHandling $ilErr @global ilCtrl $ilCtrl. More...
	deactivateTemplates ()
	Activate didactic templates @global ilErrorHandling $ilErr @global ilCtrl $ilCtrl. More...

Private Attributes
	$parent_object
	$lng

Detailed Description

Settings for a single didactic template.

Author

Stefan Meyer meyer.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

@ilCtrl_IsCalledBy ilDidacticTemplateSettingsGUI: ilObjRoleFolderGUI

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

Constructor & Destructor Documentation

__construct()

ilDidacticTemplateSettingsGUI::__construct

(

$a_parent_obj

)

Constructor.

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

        {
                global $lng;
                
                $this->parent_object = $a_parent_obj;
                $this->lng = $lng;
        }

References $lng.

Member Function Documentation

activateTemplates()

ilDidacticTemplateSettingsGUI::activateTemplates ( )

protected

Activate didactic templates @global ilErrorHandling $ilErr @global ilCtrl $ilCtrl.

Returns

void

Definition at line 414 of file class.ilDidacticTemplateSettingsGUI.php.

        {
                global $ilErr, $ilCtrl, $ilAccess;
 
                if(!$ilAccess->checkAccess('write','',$_REQUEST["ref_id"]))
                {
                        $this->ctrl->redirect($this, "overview");
                }
                if(!$_REQUEST['tpls'])
                {
                        ilUtil::sendFailure($this->lng->txt('select_one'));
                        return $ilCtrl->redirect($this,'overview');
                }
 
                foreach($_REQUEST['tpls'] as $tplid)
                {
                        $tpl = new ilDidacticTemplateSetting($tplid);
                        $tpl->enable(true);
                        $tpl->update();
                }
 
                ilUtil::sendSuccess($this->lng->txt('didactic_activated_msg'),true);
                $ilCtrl->redirect($this,'overview');
        }

References $_REQUEST, $ilCtrl, $ilErr, $tpl, ilUtil\sendFailure(), and ilUtil\sendSuccess().

Here is the call graph for this function:

confirmDelete()

ilDidacticTemplateSettingsGUI::confirmDelete ( )

protected

Show delete confirmation screen.

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

        {
                global $ilErr, $ilCtrl;
 
                if(!$_REQUEST['tpls'])
                {
                        ilUtil::sendFailure($this->lng->txt('select_one'));
                        return $ilCtrl->redirect($this,'overview');
                }
 
                include_once './Services/Utilities/classes/class.ilConfirmationGUI.php';
 
                $confirm = new ilConfirmationGUI();
                $confirm->setFormAction($ilCtrl->getFormAction($this));
                $confirm->setConfirm($this->lng->txt('delete'), 'deleteTemplates');
                $confirm->setCancel($this->lng->txt('cancel'), 'overview');
 
                foreach((array) $_REQUEST['tpls'] as $tplid)
                {
                        $tpl = new ilDidacticTemplateSetting($tplid);
                        $confirm->addItem('tpls[]', $tpl->getId(), $tpl->getTitle());
                }
 
                ilUtil::sendQuestion($this->lng->txt('didactic_confirm_delete_msg'));
                $GLOBALS['tpl']->setContent($confirm->getHTML());
        }

References $_REQUEST, $GLOBALS, $ilCtrl, $ilErr, $tpl, ilUtil\sendFailure(), and ilUtil\sendQuestion().

Here is the call graph for this function:

copyTemplate()

ilDidacticTemplateSettingsGUI::copyTemplate ( )

protected

Copy on template.

Definition at line 299 of file class.ilDidacticTemplateSettingsGUI.php.

        {
                global $ilErr, $ilCtrl, $ilAccess;
 
                if(!$ilAccess->checkAccess('write','',$_REQUEST["ref_id"]))
                {
                        $this->ctrl->redirect($this, "overview");
                }
 
                if(!$_REQUEST['tplid'])
                {
                        ilUtil::sendFailure($this->lng->txt('select_one'));
                        return $ilCtrl->redirect($this,'overview');
                }
 
                include_once './Services/DidacticTemplate/classes/class.ilDidacticTemplateCopier.php';
 
                $copier = new ilDidacticTemplateCopier((int) $_REQUEST['tplid']);
                $copier->start();
 
                ilUtil::sendSuccess($this->lng->txt('didactic_copy_suc_message'), true);
                $ilCtrl->redirect($this,'overview');
        }

References $_REQUEST, $ilCtrl, $ilErr, ilUtil\sendFailure(), and ilUtil\sendSuccess().

Here is the call graph for this function:

createImportForm()

ilDidacticTemplateSettingsGUI::createImportForm ( )

protected

Create template import form.

Returns

ilPropertyFormGUI $form

Definition at line 107 of file class.ilDidacticTemplateSettingsGUI.php.

        {
                global $ilCtrl;
 
                include_once './Services/Form/classes/class.ilPropertyFormGUI.php';
                $form = new ilPropertyFormGUI();
                $form->setShowTopButtons(false);
                $form->setFormAction($ilCtrl->getFormAction($this));
                $form->setTitle($this->lng->txt('didactic_import_table_title'));
                $form->addCommandButton('importTemplate', $this->lng->txt('import'));
                $form->addCommandButton('overview', $this->lng->txt('cancel'));
 
                $file = new ilFileInputGUI($this->lng->txt('import_file'), 'file');
                $file->setSuffixes(array('xml'));
                $file->setRequired(TRUE);
                $form->addItem($file);
 
                $created = true;
 
                return $form;
        }

References $file, and $ilCtrl.

Referenced by importTemplate(), and showImportForm().

Here is the caller graph for this function:

deactivateTemplates()

ilDidacticTemplateSettingsGUI::deactivateTemplates ( )

protected

Activate didactic templates @global ilErrorHandling $ilErr @global ilCtrl $ilCtrl.

Returns

void

Definition at line 445 of file class.ilDidacticTemplateSettingsGUI.php.

        {
                global $ilErr, $ilCtrl, $ilAccess;
 
                if(!$ilAccess->checkAccess('write','',$_REQUEST["ref_id"]))
                {
                        $this->ctrl->redirect($this, "overview");
                }
 
                if(!$_REQUEST['tpls'])
                {
                        ilUtil::sendFailure($this->lng->txt('select_one'));
                        return $ilCtrl->redirect($this,'overview');
                }
 
                foreach($_REQUEST['tpls'] as $tplid)
                {
                        $tpl = new ilDidacticTemplateSetting($tplid);
                        $tpl->enable(false);
                        $tpl->update();
                }
 
                ilUtil::sendSuccess($this->lng->txt('didactic_deactivated_msg'),true);
                $ilCtrl->redirect($this,'overview');
        }

References $_REQUEST, $ilCtrl, $ilErr, $tpl, ilUtil\sendFailure(), and ilUtil\sendSuccess().

Here is the call graph for this function:

deleteTemplates()

ilDidacticTemplateSettingsGUI::deleteTemplates ( )

protected

Delete chosen didactic templates @global ilErrorHandling $ilErr @global ilCtrl $ilCtrl.

Returns

void

Definition at line 383 of file class.ilDidacticTemplateSettingsGUI.php.

        {
                global $ilErr, $ilCtrl, $ilAccess;
 
                if(!$ilAccess->checkAccess('write','',$_REQUEST["ref_id"]))
                {
                        $this->ctrl->redirect($this, "overview");
                }
 
                if(!$_REQUEST['tpls'])
                {
                        ilUtil::sendFailure($this->lng->txt('select_one'));
                        return $ilCtrl->redirect($this,'overview');
                }
 
                foreach((array) $_REQUEST['tpls'] as $tplid)
                {
                        $tpl = new ilDidacticTemplateSetting($tplid);
                        $tpl->delete();
                }
 
                ilUtil::sendSuccess($this->lng->txt('didactic_delete_msg'),true);
                $ilCtrl->redirect($this,'overview');
        }

References $_REQUEST, $ilCtrl, $ilErr, $tpl, ilUtil\sendFailure(), and ilUtil\sendSuccess().

Here is the call graph for this function:

editTemplate()

ilDidacticTemplateSettingsGUI::editTemplate ( ilPropertyFormGUI  $form = null )

protected

Edit template.

Returns

void

Definition at line 182 of file class.ilDidacticTemplateSettingsGUI.php.

        {
                global $ilCtrl,$ilTabs;
 
                if(!$_REQUEST['tplid'])
                {
                        ilUtil::sendFailure($this->lng->txt('select_one'));
                        return $ilCtrl->redirect($this,'overview');
                }
 
                $ilTabs->clearTargets();
                $ilTabs->setBackTarget(
                        $this->lng->txt('didactic_back_to_overview'),
                        $ilCtrl->getLinkTarget($this,'overview')
                );
 
 
                $ilCtrl->saveParameter($this,'tplid');
 
                if(!$form instanceof ilPropertyFormGUI)
                {
                        $settings = new ilDidacticTemplateSetting((int) $_REQUEST['tplid']);
                        $form = $this->initEditTemplate($settings);
                }
                $GLOBALS['tpl']->setContent($form->getHTML());
        }

References $_REQUEST, $GLOBALS, $ilCtrl, initEditTemplate(), and ilUtil\sendFailure().

Referenced by updateTemplate().

Here is the call graph for this function:

Here is the caller graph for this function:

executeCommand()

ilDidacticTemplateSettingsGUI::executeCommand

(

)

Execute command.

Returns

<type>

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

        {
                global $ilCtrl;
                
                $next_class = $ilCtrl->getNextClass($this);
                $cmd = $ilCtrl->getCmd();
 
                switch($next_class)
                {
                        default:
                                if(!$cmd)
                                {
                                        $cmd = 'overview';
                                }
                                $this->$cmd();
 
                                break;
                }
                return true;
        }

References $cmd, and $ilCtrl.

exportTemplate()

ilDidacticTemplateSettingsGUI::exportTemplate ( )

protected

Export one template.

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

        {
                global $ilErr, $ilCtrl;
 
                if(!$_REQUEST['tplid'])
                {
                        ilUtil::sendFailure($this->lng->txt('select_one'));
                        return $ilCtrl->redirect($this,'overview');
                }
 
                include_once './Services/DidacticTemplate/classes/class.ilDidacticTemplateXmlWriter.php';
                $writer = new ilDidacticTemplateXmlWriter((int) $_REQUEST['tplid']);
                $writer->write();
 
                ilUtil::deliverData(
                        $writer->xmlDumpMem(TRUE), 
                        $writer->getSetting()->getTitle().'.xml',
                        'application/xml'
                );
        }

References $_REQUEST, $ilCtrl, $ilErr, ilUtil\deliverData(), and ilUtil\sendFailure().

Here is the call graph for this function:

importTemplate()

ilDidacticTemplateSettingsGUI::importTemplate ( )

protected

Import template.

Definition at line 132 of file class.ilDidacticTemplateSettingsGUI.php.

        {
                global $ilCtrl, $ilAccess;
 
                if(!$ilAccess->checkAccess('write','',$_REQUEST["ref_id"]))
                {
                        $this->ctrl->redirect($this, "overview");
                }
 
                $form = $this->createImportForm();
                if(!$form->checkInput())
                {
                        ilUtil::sendFailure($this->lng->txt('err_check_input'));
                        $form->setValuesByPost();
                        return $this->showImportForm($form);
                }
 
                // Do import
                include_once './Services/DidacticTemplate/classes/class.ilDidacticTemplateImport.php';
                
                $import = new ilDidacticTemplateImport(ilDidacticTemplateImport::IMPORT_FILE);
 
                $file = $form->getInput('file');
                $tmp = ilUtil::ilTempnam();
 
                // move uploaded file
                ilUtil::moveUploadedFile(
                        $file['tmp_name'],
                        $file['name'],
                        $tmp
                );
                $import->setInputFile($tmp);
 
                try {
                        $import->import();
                }
                catch(ilDidacticTemplateImportException $e)
                {
                        ilLoggerFactory::getLogger('otpl')->error('Import failed with message: ' . $e->getMessage());
                        ilUtil::sendFailure($this->lng->txt('didactic_import_failed').': '.$e->getMessage());
                }
 
                ilUtil::sendSuccess($this->lng->txt('didactic_import_success'),TRUE);
                $ilCtrl->redirect($this,'overview');
        }

References $_REQUEST, $file, $ilCtrl, createImportForm(), ilLoggerFactory\getLogger(), ilUtil\ilTempnam(), ilDidacticTemplateImport\IMPORT_FILE, ilUtil\moveUploadedFile(), ilUtil\sendFailure(), ilUtil\sendSuccess(), and showImportForm().

Here is the call graph for this function:

initEditTemplate()

ilDidacticTemplateSettingsGUI::initEditTemplate ( ilDidacticTemplateSetting  $set )

protected

Init edit template form.

Definition at line 244 of file class.ilDidacticTemplateSettingsGUI.php.

        {
                global $ilCtrl,$objDefinition;
 
                include_once './Services/Form/classes/class.ilPropertyFormGUI.php';
                $form = new ilPropertyFormGUI();
                $form->setShowTopButtons(false);
                $form->setFormAction($ilCtrl->getFormAction($this,'updateTemplate'));
                $form->setTitle($this->lng->txt('didactic_edit_tpl'));
                $form->addCommandButton('updateTemplate', $this->lng->txt('save'));
                $form->addCommandButton('overview', $this->lng->txt('cancel'));
 
                // title
                $title = new ilTextInputGUI($this->lng->txt('title'), 'title');
                $title->setValue($set->getTitle());
                $title->setSize(40);
                $title->setMaxLength(64);
                $title->setRequired(true);
                $form->addItem($title);
 
                // desc
                $desc = new ilTextAreaInputGUI($this->lng->txt('description'), 'description');
                $desc->setValue($set->getDescription());
                $desc->setRows(3);
                $form->addItem($desc);
 
                // info
                $info = new ilTextAreaInputGUI($this->lng->txt('didactic_install_info'), 'info');
                $info->setValue($set->getInfo());
                $info->setRows(6);
                $form->addItem($info);
 
                // object type
                $type = new ilSelectInputGUI($this->lng->txt('obj_type'),'type');
                $type->setRequired(true);
                $assigned = $set->getAssignments();
                $type->setValue(isset($assigned[0]) ? $assigned[0] : '');
                $subs = $objDefinition->getCreatableSubobjects('root', false);
                $options = array();
                foreach(array_merge($subs,array('fold' => 1)) as $obj => $null)
                {
                        if($objDefinition->isAllowedInRepository($obj))
                        {
                                $options[$obj] = $this->lng->txt('obj_'.$obj);
                        }
                }
                $type->setOptions($options);
                $form->addItem($type);
 
                return $form;
        }

References $ilCtrl, $info, $options, ilDidacticTemplateSetting\getAssignments(), ilDidacticTemplateSetting\getDescription(), ilDidacticTemplateSetting\getInfo(), and ilDidacticTemplateSetting\getTitle().

Referenced by editTemplate(), and updateTemplate().

Here is the call graph for this function:

Here is the caller graph for this function:

overview()

ilDidacticTemplateSettingsGUI::overview ( )

protected

Show didactic template administration.

@global ilToolbarGUI $ilToolbar

Definition at line 60 of file class.ilDidacticTemplateSettingsGUI.php.

        {
                global $ilToolbar,$lng, $ilCtrl, $ilAccess;
 
                if($ilAccess->checkAccess('write','',$_REQUEST["ref_id"]))
                {
                        $ilToolbar->addButton(
                                $lng->txt('didactic_import_btn'),
                                $ilCtrl->getLinkTarget($this,'showImportForm')
                        );
                }
 
 
                include_once './Services/DidacticTemplate/classes/class.ilDidacticTemplateSettingsTableGUI.php';
                $table = new ilDidacticTemplateSettingsTableGUI($this,'overview');
                $table->init();
                $table->parse();
 
                $GLOBALS['tpl']->setContent($table->getHTML());
        }

References $_REQUEST, $GLOBALS, $ilCtrl, and $lng.

showImportForm()

ilDidacticTemplateSettingsGUI::showImportForm ( ilPropertyFormGUI  $form = NULL )

protected

Show template import form.

@global ilTabsGUI $ilTabs

Definition at line 86 of file class.ilDidacticTemplateSettingsGUI.php.

        {
                global $ilTabs, $ilCtrl;
                
                $ilTabs->clearTargets();
                $ilTabs->setBackTarget(
                        $this->lng->txt('didactic_back_to_overview'),
                        $ilCtrl->getLinkTarget($this,'overview')
                );
 
                if(!$form instanceof ilPropertyFormGUI)
                {
                        $form = $this->createImportForm();
                }
                $GLOBALS['tpl']->setContent($form->getHTML());
        }

References $GLOBALS, $ilCtrl, and createImportForm().

Referenced by importTemplate().

Here is the call graph for this function:

Here is the caller graph for this function:

updateTemplate()

ilDidacticTemplateSettingsGUI::updateTemplate ( )

protected

Update template.

Definition at line 212 of file class.ilDidacticTemplateSettingsGUI.php.

        {
                global $ilCtrl, $ilAccess;
 
                if(!$ilAccess->checkAccess('write','',$_REQUEST["ref_id"]))
                {
                        $this->ctrl->redirect($this, "overview");
                }
 
                $temp = new ilDidacticTemplateSetting((int) $_REQUEST['tplid']);
                $form = $this->initEditTemplate($temp);
 
                if($form->checkInput())
                {
                        $temp->setTitle($form->getInput('title'));
                        $temp->setDescription($form->getInput('description'));
                        $temp->setInfo($form->getInput('info'));
                        $temp->setAssignments(array($form->getInput('type')));
                        $temp->update();
 
                        ilUtil::sendSuccess($this->lng->txt('save_settings'));
                        $ilCtrl->redirect($this,'overview');
                }
 
                ilUtil::sendFailure($this->lng->txt('err_check_input'));
                $form->setValuesByPost();
                $this->editTemplate($form);
        }

References $_REQUEST, $ilCtrl, editTemplate(), initEditTemplate(), ilUtil\sendFailure(), and ilUtil\sendSuccess().

Here is the call graph for this function:

Field Documentation

$lng

ilDidacticTemplateSettingsGUI::$lng

private

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

Referenced by __construct(), and overview().

$parent_object

ilDidacticTemplateSettingsGUI::$parent_object

private

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

---

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

• Services/DidacticTemplate/classes/class.ilDidacticTemplateSettingsGUI.php