ilExSubmissionTextGUI Class Reference

Object-based submissions (ends up as static file) More...

Inheritance diagram for ilExSubmissionTextGUI:

Collaboration diagram for ilExSubmissionTextGUI:

Public Member Functions
	executeCommand ()
	editAssignmentTextObject (ilPropertyFormGUI $a_form=null)
	updateAssignmentTextAndReturnObject ()
	updateAssignmentTextObject ($a_return=false)
	showAssignmentTextObject ()
Public Member Functions inherited from ilExSubmissionBaseGUI
	__construct (ilObjExercise $a_exercise, ilExSubmission $a_submission)
	returnToParentObject ()

Static Public Member Functions
static	getOverviewContent (ilInfoScreenGUI $a_info, ilExSubmission $a_submission)
static	getOverviewContent (ilInfoScreenGUI $a_info, ilExSubmission $a_submission)

Protected Member Functions
	initAssignmentTextForm ($a_read_only=false)
Protected Member Functions inherited from ilExSubmissionBaseGUI
	handleTabs ()
	handleNewUpload ($a_no_notifications=false)
	handleRemovedUpload ()

Additional Inherited Members
Protected Attributes inherited from ilExSubmissionBaseGUI
	$exercise
	$submission
	$assignment

Detailed Description

Object-based submissions (ends up as static file)

Author

Jörg Lützenkirchen luetz.nosp@m.enki.nosp@m.rchen.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

@ilCtrl_Calls ilExSubmissionTextGUI:

Definition at line 12 of file class.ilExSubmissionTextGUI.php.

Member Function Documentation

editAssignmentTextObject()

ilExSubmissionTextGUI::editAssignmentTextObject

(

ilPropertyFormGUI

$a_form = null

)

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

        {
                global $ilCtrl;
 
                if(!$this->submission->canSubmit())                             
                {
                        ilUtil::sendFailure($this->lng->txt("exercise_time_over"), true);
                        $ilCtrl->redirect($this, "returnToParent");
                }
                
                $deadline = max($this->assignment->getDeadline(), $this->assignment->getExtendedDeadline());
                if($deadline)
                {                                                                       
                        // extended deadline date should not be presented anywhere
                        // see ilExAssignmentGUI::addSchedule()
                        $dl_info = ilDatePresentation::formatDate(new ilDateTime($this->assignment->getDeadline(), IL_CAL_UNIX));
                                        
                        // #16151 - extended deadline warning (only after deadline passed)
                        if($this->assignment->getDeadline() < time())
                        {                                                       
                                $dl = ilDatePresentation::formatDate(new ilDateTime($this->assignment->getDeadline(),IL_CAL_UNIX));
                                $dl = '<br /><span class="warning">'.sprintf($this->lng->txt("exc_late_submission_warning"), $dl).'</span>';                                                    
                                $dl_info .= $dl;
                        }
                        
                        ilUtil::sendInfo($this->lng->txt("exc_edit_until").": ".$dl_info);
                }
                
                $this->handleTabs();
 
                global $ilHelp;
                $ilHelp->setScreenIdComponent("exc");
                $ilHelp->setScreenId("text_submission");
 
                if(!$a_form)
                {
                        $a_form = $this->initAssignmentTextForm();              
 
                        $files = $this->submission->getFiles();
                        if($files)
                        {
                                $files = array_shift($files);
                                if(trim($files["atext"]))
                                {
                                   $text = $a_form->getItemByPostVar("atxt");
                                   // mob id to mob src
                                   $text->setValue(ilRTE::_replaceMediaObjectImageSrc($files["atext"], 1));
                                }
                        }
                }
        
                $this->tpl->setContent($a_form->getHTML());
        }

References $ilCtrl, $text, ilRTE\_replaceMediaObjectImageSrc(), ilDatePresentation\formatDate(), ilExSubmissionBaseGUI\handleTabs(), IL_CAL_UNIX, initAssignmentTextForm(), ilUtil\sendFailure(), and ilUtil\sendInfo().

Referenced by updateAssignmentTextObject().

Here is the call graph for this function:

Here is the caller graph for this function:

executeCommand()

ilExSubmissionTextGUI::executeCommand

(

)

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

        {
                global $ilCtrl;
                
                if(!$this->assignment ||
                        $this->assignment->getType() != ilExAssignment::TYPE_TEXT ||
                        !$this->submission->canView())
                {
                        return;
                }
                
                $class = $ilCtrl->getNextClass($this);
                $cmd = $ilCtrl->getCmd("showassignmenttext");           
                
                switch($class)
                {               
                        default:                                                                        
                                $this->{$cmd."Object"}();                               
                                break;                  
                }
        }

References $cmd, $ilCtrl, and ilExAssignment\TYPE_TEXT.

getOverviewContent()

static ilExSubmissionTextGUI::getOverviewContent ( ilInfoScreenGUI  $a_info, ilExSubmission  $a_submission  )

static

Reimplemented from ilExSubmissionBaseGUI.

Definition at line 36 of file class.ilExSubmissionTextGUI.php.

        {
                global $lng, $ilCtrl;
                
                if($a_submission->canSubmit())
                {
                        $button = ilLinkButton::getInstance();
                        $button->setPrimary(true);
                        $button->setCaption("exc_text_assignment_edit");
                        $button->setUrl($ilCtrl->getLinkTargetByClass(array("ilExSubmissionGUI", "ilExSubmissionTextGUI"), "editAssignmentText"));                                                      
                        $files_str = $button->render();                                                 
                }
                else
                {
                        $button = ilLinkButton::getInstance();
                        $button->setCaption("exc_text_assignment_show");
                        $button->setUrl($ilCtrl->getLinkTargetByClass(array("ilExSubmissionGUI", "ilExSubmissionTextGUI"), "showAssignmentText"));                                                      
                        $files_str = $button->render();                                                                                                         
                }
 
                $a_info->addProperty($lng->txt("exc_files_returned_text"), $files_str); 
        }

References $ilCtrl, $lng, ilInfoScreenGUI\addProperty(), ilExSubmission\canSubmit(), and ilLinkButton\getInstance().

Here is the call graph for this function:

initAssignmentTextForm()

ilExSubmissionTextGUI::initAssignmentTextForm (   $a_read_only = false )

protected

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

        {               
                global $ilCtrl;
                
                include_once "Services/Form/classes/class.ilPropertyFormGUI.php";
                $form = new ilPropertyFormGUI();                
                $form->setTitle($this->lng->txt("exc_assignment")." \"".$this->assignment->getTitle()."\"");
                        
                if(!$a_read_only)
                {
                        $text = new ilTextAreaInputGUI($this->lng->txt("exc_your_text"), "atxt");
                        $text->setRequired((bool)$this->submission->getAssignment()->getMandatory());                           
                        $text->setRows(40);
                        $form->addItem($text);
                        
                        // custom rte tags
                        $text->setUseRte(true);         
                        $text->setRTESupport($this->submission->getUserId(), "exca~", "exc_ass"); 
                        
                        // see ilObjForumGUI
                        $text->disableButtons(array(
                                'charmap',
                                'undo',
                                'redo',
                                'justifyleft',
                                'justifycenter',
                                'justifyright',
                                'justifyfull',
                                'anchor',
                                'fullscreen',
                                'cut',
                                'copy',
                                'paste',
                                'pastetext',
                                // 'formatselect' #13234
                        ));
                        
                        $form->setFormAction($ilCtrl->getFormAction($this, "updateAssignmentText"));
                        $form->addCommandButton("updateAssignmentTextAndReturn", $this->lng->txt("save_return"));               
                        $form->addCommandButton("updateAssignmentText", $this->lng->txt("save"));                                                       
                }
                else
                {
                        $form->setFormAction($ilCtrl->getFormAction($this, "returnToParent"));
                        $text = new ilNonEditableValueGUI($this->lng->txt("exc_files_returned_text"), "atxt", true);    
                        $form->addItem($text);                                  
                }
                $form->addCommandButton("returnToParent", $this->lng->txt("cancel"));
                
                return $form;
        }

References $ilCtrl, and $text.

Referenced by editAssignmentTextObject(), showAssignmentTextObject(), and updateAssignmentTextObject().

Here is the caller graph for this function:

showAssignmentTextObject()

ilExSubmissionTextGUI::showAssignmentTextObject

(

)

Definition at line 241 of file class.ilExSubmissionTextGUI.php.

        {               
                if(!$this->submission->isTutor())               
                {
                        $this->handleTabs();
                }
                
                $a_form = $this->initAssignmentTextForm(true);  
                
                $files = $this->submission->getFiles();
                if($files)
                {
                        $files = array_shift($files);
                        if(trim($files["atext"]))
                        {
                                if($files["late"] && 
                                        !$this->submission->hasPeerReviewAccess())
                                {
                                        ilUtil::sendFailure($this->lng->txt("exc_late_submission"));
                                }
                                
                                $text = $a_form->getItemByPostVar("atxt");
                                // mob id to mob src
                                $text->setValue(nl2br(ilRTE::_replaceMediaObjectImageSrc($files["atext"], 1)));
                        }
                }               
        
                $this->tpl->setContent($a_form->getHTML());     
        }

References $text, ilRTE\_replaceMediaObjectImageSrc(), ilExSubmissionBaseGUI\handleTabs(), initAssignmentTextForm(), and ilUtil\sendFailure().

Here is the call graph for this function:

updateAssignmentTextAndReturnObject()

ilExSubmissionTextGUI::updateAssignmentTextAndReturnObject

(

)

Definition at line 170 of file class.ilExSubmissionTextGUI.php.

        {
                $this->updateAssignmentTextObject(true);                
        }

References updateAssignmentTextObject().

Here is the call graph for this function:

updateAssignmentTextObject()

ilExSubmissionTextGUI::updateAssignmentTextObject

(

$a_return = false

)

Definition at line 175 of file class.ilExSubmissionTextGUI.php.

        {
                global $ilCtrl;
                
                if(!$this->submission->canSubmit())
                {
                        ilUtil::sendFailure($this->lng->txt("exercise_time_over"), true);
                        $ilCtrl->redirect($this, "returnToParent");
                }
                
                $form = $this->initAssignmentTextForm();        
                
                // we are not using a purifier, so we have to set the valid RTE tags
                // :TODO: 
                include_once("./Services/AdvancedEditing/classes/class.ilObjAdvancedEditing.php");
                $rte = $form->getItemByPostVar("atxt");
                $rte->setRteTags(ilObjAdvancedEditing::_getUsedHTMLTags("exc_ass"));
                
                if($form->checkInput())
                {                       
                        $text = trim($form->getInput("atxt"));  
                                                                        
                        $existing = $this->submission->getFiles();
                                                                                                
                        $returned_id = $this->submission->updateTextSubmission(
                                // mob src to mob id
                                ilRTE::_replaceMediaObjectImageSrc($text, 0));  
                        
                        // no empty text
                        if($returned_id)
                        {
                                // #16532 - always send notifications
                                $this->handleNewUpload();                                       
                                
                                // mob usage
                                include_once "Services/MediaObjects/classes/class.ilObjMediaObject.php";
                                $mobs = ilRTE::_getMediaObjects($text, 0);
                                foreach($mobs as $mob)
                                {
                                        if(ilObjMediaObject::_exists($mob))
                                        {
                                                ilObjMediaObject::_removeUsage($mob, 'exca~:html', $this->submission->getUserId());
                                                ilObjMediaObject::_saveUsage($mob, 'exca:html', $returned_id);
                                        }
                                }
                        }
                        else
                        {
                                $this->handleRemovedUpload();
                        }
                        
                        ilUtil::sendSuccess($this->lng->txt("settings_saved"), true);
                        if($a_return)
                        {
                                $ilCtrl->redirect($this, "returnToParent");
                        }
                        else
                        {
                                $ilCtrl->redirect($this, "editAssignmentText");
                        }
                }
                
                $form->setValuesByPost();
                $this->editAssignmentTextObject($form);         
        }

References $ilCtrl, $mobs, $text, ilObjMediaObject\_exists(), ilRTE\_getMediaObjects(), ilObjAdvancedEditing\_getUsedHTMLTags(), ilObjMediaObject\_removeUsage(), ilRTE\_replaceMediaObjectImageSrc(), ilObjMediaObject\_saveUsage(), editAssignmentTextObject(), ilExSubmissionBaseGUI\handleNewUpload(), ilExSubmissionBaseGUI\handleRemovedUpload(), initAssignmentTextForm(), ilUtil\sendFailure(), and ilUtil\sendSuccess().

Referenced by updateAssignmentTextAndReturnObject().

Here is the call graph for this function:

Here is the caller graph for this function:

---

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

• Modules/Exercise/classes/class.ilExSubmissionTextGUI.php