ILIAS  release_5-1 Revision 5.0.0-5477-g43f3e3fab5f
ilAssQuestionHintPageObjectCommandForwarder Class Reference
+ Inheritance diagram for ilAssQuestionHintPageObjectCommandForwarder:
+ Collaboration diagram for ilAssQuestionHintPageObjectCommandForwarder:

Public Member Functions

 __construct (assQuestion $questionOBJ, ilCtrl $ctrl, ilTabsGUI $tabs, ilLanguage $lng)
 Constructor. More...
 
 forward ()
 forward method More...
 
 getPresentationMode ()
 getter for presentation mode More...
 
 setPresentationMode ($presentationMode)
 setter for presentation mode More...
 
 __construct (assQuestion $questionOBJ, ilCtrl $ctrl, ilTabsGUI $tabs, ilLanguage $lng)
 Constructor. More...
 
 forward ()
 this is the actual forward method that is to be implemented by derived forwarder classes More...
 

Data Fields

const PRESENTATION_MODE_AUTHOR = 'PRESENTATION_MODE_AUTHOR'
 presentation mode for authoring More...
 
const PRESENTATION_MODE_REQUEST = 'PRESENTATION_MODE_REQUEST'
 presentation mode for requesting More...
 

Protected Member Functions

 getPageObjectGUI ($pageObjectType, $pageObjectId)
 instantiates, initialises and returns a page object gui object More...
 
 ensurePageObjectExists ($pageObjectType, $pageObjectId)
 ensures an existing page object with giben type/id More...
 
 ensurePageObjectExists ($pageObjectType, $pageObjectId)
 ensures an existing page object with giben type/id More...
 
 getPageObjectGUI ($pageObjectType, $pageObjectId)
 instantiates, initialises and returns a page object gui object More...
 

Protected Attributes

 $presentationMode = null
 
 $questionHint = null
 
- Protected Attributes inherited from ilAssQuestionAbstractPageObjectCommandForwarder
 $questionOBJ = null
 
 $ctrl = null
 
 $tabs = null
 
 $lng = null
 

Private Member Functions

 buildRequestPresentationPageObjectGUI ()
 forwards the command to page object gui for author presentation More...
 
 buildAuthorPresentationPageObjectGUI ()
 forwards the command to page object gui for author presentation More...
 

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

ilAssQuestionHintPageObjectCommandForwarder::__construct ( assQuestion  $questionOBJ,
ilCtrl  $ctrl,
ilTabsGUI  $tabs,
ilLanguage  $lng 
)

Constructor.

@access public

Parameters
assQuestion$questionOBJ
ilCtrl$ctrl
ilTabsGUI$tabs
ilLanguage$lng

Reimplemented from ilAssQuestionAbstractPageObjectCommandForwarder.

Definition at line 51 of file class.ilAssQuestionHintPageObjectCommandForwarder.php.

52 {
53 parent::__construct($questionOBJ, $ctrl, $tabs, $lng);
54
55 $this->questionHint = new ilAssQuestionHint();
56
57 if( !isset($_GET['hint_id']) || !(int)$_GET['hint_id'] || !$this->questionHint->load((int)$_GET['hint_id']) )
58 {
59 ilUtil::sendFailure('invalid hint id given: '.(int)$_GET['hint_id'], true);
60 $this->ctrl->redirectByClass('ilAssQuestionHintsGUI', ilAssQuestionHintsGUI::CMD_SHOW_LIST);
61 }
62 }
$_GET["client_id"]
const CMD_SHOW_LIST
command constants
static sendFailure($a_info="", $a_keep=false)
Send Failure Message to Screen.

References $_GET, ilAssQuestionAbstractPageObjectCommandForwarder\$ctrl, ilAssQuestionAbstractPageObjectCommandForwarder\$lng, ilAssQuestionAbstractPageObjectCommandForwarder\$questionOBJ, ilAssQuestionAbstractPageObjectCommandForwarder\$tabs, ilAssQuestionHintsGUI\CMD_SHOW_LIST, and ilUtil\sendFailure().

+ Here is the call graph for this function:

Member Function Documentation

◆ buildAuthorPresentationPageObjectGUI()

ilAssQuestionHintPageObjectCommandForwarder::buildAuthorPresentationPageObjectGUI ( )
private

forwards the command to page object gui for author presentation

@access private

Returns
page object gui object

Definition at line 121 of file class.ilAssQuestionHintPageObjectCommandForwarder.php.

122 {
123 $this->tabs->setBackTarget(
124 $this->lng->txt('tst_question_hints_back_to_hint_list'),
125 $this->ctrl->getLinkTargetByClass('ilAssQuestionHintsGUI', ilAssQuestionHintsGUI::CMD_SHOW_LIST)
126 );
127
129 $this->questionHint->getPageObjectType(), $this->questionHint->getId()
130 );
131
132 $pageObjectGUI = $this->getPageObjectGUI(
133 $this->questionHint->getPageObjectType(), $this->questionHint->getId()
134 );
135
136 $pageObjectGUI->setEnabledTabs(true);
137
138 return $pageObjectGUI;
139 }
getPageObjectGUI($pageObjectType, $pageObjectId)
instantiates, initialises and returns a page object gui object
ensurePageObjectExists($pageObjectType, $pageObjectId)
ensures an existing page object with giben type/id

References ilAssQuestionHintsGUI\CMD_SHOW_LIST, ensurePageObjectExists(), and getPageObjectGUI().

Referenced by forward().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ buildRequestPresentationPageObjectGUI()

ilAssQuestionHintPageObjectCommandForwarder::buildRequestPresentationPageObjectGUI ( )
private

forwards the command to page object gui for author presentation

@access private

Returns
page object gui object

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

96 {
97 $this->tabs->setBackTarget(
98 $this->lng->txt('tst_question_hints_back_to_hint_list'),
99 $this->ctrl->getLinkTargetByClass('ilAssQuestionHintRequestGUI', ilAssQuestionHintRequestGUI::CMD_SHOW_LIST)
100 );
101
102 $pageObjectGUI = $this->getPageObjectGUI(
103 $this->questionHint->getPageObjectType(), $this->questionHint->getId()
104 );
105
106 $pageObjectGUI->setEnabledTabs(false);
107
108 $pageObjectGUI->setPresentationTitle(
109 ilAssQuestionHint::getHintIndexLabel($this->lng, $this->questionHint->getIndex())
110 );
111
112 return $pageObjectGUI;
113 }
static getHintIndexLabel(ilLanguage $lng, $hintIndex)

References ilAssQuestionHintRequestGUI\CMD_SHOW_LIST, ilAssQuestionHint\getHintIndexLabel(), and getPageObjectGUI().

Referenced by forward().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ ensurePageObjectExists()

ilAssQuestionHintPageObjectCommandForwarder::ensurePageObjectExists (   $pageObjectType,
  $pageObjectId 
)
protected

ensures an existing page object with giben type/id

@access protected

Reimplemented from ilAssQuestionAbstractPageObjectCommandForwarder.

Definition at line 193 of file class.ilAssQuestionHintPageObjectCommandForwarder.php.

194 {
195 include_once("./Modules/TestQuestionPool/classes/class.ilAssHintPage.php");
196 if( !ilAssHintPage::_exists($pageObjectType, $pageObjectId) )
197 {
198 $pageObject = new ilAssHintPage();
199 $pageObject->setParentId($this->questionOBJ->getId());
200 $pageObject->setId($pageObjectId);
201 $pageObject->createFromXML();
202 }
203 }
Assessment hint page object.
static _exists($a_parent_type, $a_id, $a_lang="", $a_no_cache=false)
Checks whether page exists.

References ilPageObject\_exists().

Referenced by buildAuthorPresentationPageObjectGUI().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ forward()

ilAssQuestionHintPageObjectCommandForwarder::forward ( )

forward method

Exceptions
ilTestQuestionPoolException

Reimplemented from ilAssQuestionAbstractPageObjectCommandForwarder.

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

70 {
71 switch( $this->getPresentationMode() )
72 {
74
75 $pageObjectGUI = $this->buildAuthorPresentationPageObjectGUI();
76 break;
77
79
80 $pageObjectGUI = $this->buildRequestPresentationPageObjectGUI();
81 break;
82 }
83
84 $this->ctrl->setParameter($pageObjectGUI, 'hint_id', $this->questionHint->getId());
85
86 $this->ctrl->forwardCommand($pageObjectGUI);
87 }
buildRequestPresentationPageObjectGUI()
forwards the command to page object gui for author presentation
buildAuthorPresentationPageObjectGUI()
forwards the command to page object gui for author presentation

References buildAuthorPresentationPageObjectGUI(), buildRequestPresentationPageObjectGUI(), getPresentationMode(), PRESENTATION_MODE_AUTHOR, and PRESENTATION_MODE_REQUEST.

+ Here is the call graph for this function:

◆ getPageObjectGUI()

ilAssQuestionHintPageObjectCommandForwarder::getPageObjectGUI (   $pageObjectType,
  $pageObjectId 
)
protected

instantiates, initialises and returns a page object gui object

@access protected

Returns
page object gui object

Reimplemented from ilAssQuestionAbstractPageObjectCommandForwarder.

Definition at line 177 of file class.ilAssQuestionHintPageObjectCommandForwarder.php.

178 {
179 include_once("./Modules/TestQuestionPool/classes/class.ilAssHintPageGUI.php");
180 $pageObjectGUI = new ilAssHintPageGUI($pageObjectId);
181 $pageObjectGUI->obj->addUpdateListener(
182 $this->questionOBJ,
183 'updateTimestamp'
184 );
185 return $pageObjectGUI;
186 }
Assessment hint page GUI class.

Referenced by buildAuthorPresentationPageObjectGUI(), and buildRequestPresentationPageObjectGUI().

+ Here is the caller graph for this function:

◆ getPresentationMode()

ilAssQuestionHintPageObjectCommandForwarder::getPresentationMode ( )

getter for presentation mode

Returns
string

Definition at line 146 of file class.ilAssQuestionHintPageObjectCommandForwarder.php.

References $presentationMode.

Referenced by forward().

+ Here is the caller graph for this function:

◆ setPresentationMode()

ilAssQuestionHintPageObjectCommandForwarder::setPresentationMode (   $presentationMode)

setter for presentation mode

Parameters
string$presentationMode
Exceptions
ilTestQuestionPoolException

Definition at line 157 of file class.ilAssQuestionHintPageObjectCommandForwarder.php.

158 {
159 switch( $presentationMode )
160 {
163
164 $this->presentationMode = $presentationMode;
165 break;
166
167 default: throw new ilTestQuestionPoolException('invalid presentation mode given: '.$presentationMode);
168 }
169 }

References $presentationMode, PRESENTATION_MODE_AUTHOR, and PRESENTATION_MODE_REQUEST.

Field Documentation

◆ $presentationMode

ilAssQuestionHintPageObjectCommandForwarder::$presentationMode = null
protected

◆ $questionHint

ilAssQuestionHintPageObjectCommandForwarder::$questionHint = null
protected

◆ PRESENTATION_MODE_AUTHOR

const ilAssQuestionHintPageObjectCommandForwarder::PRESENTATION_MODE_AUTHOR = 'PRESENTATION_MODE_AUTHOR'

◆ PRESENTATION_MODE_REQUEST

const ilAssQuestionHintPageObjectCommandForwarder::PRESENTATION_MODE_REQUEST = 'PRESENTATION_MODE_REQUEST'

presentation mode for requesting

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

Referenced by ilAssQuestionHintRequestGUI\executeCommand(), forward(), and setPresentationMode().


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